Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc page about query semantics and visible time range #6129

Open
teh-cmc opened this issue Apr 26, 2024 · 1 comment
Open

Doc page about query semantics and visible time range #6129

teh-cmc opened this issue Apr 26, 2024 · 1 comment
Labels
📖 documentation Improvements or additions to documentation 🔍 re_query affects re_query itself user-request This is a pressing issue for one of our users

Comments

@teh-cmc
Copy link
Member

teh-cmc commented Apr 26, 2024

We need a page in the docs that explain query semantics and their relationship to the visible time range feature.

@teh-cmc teh-cmc added 📖 documentation Improvements or additions to documentation 🔍 re_query affects re_query itself user-request This is a pressing issue for one of our users labels Apr 26, 2024
@teh-cmc
Copy link
Member Author

teh-cmc commented Apr 26, 2024

See also my last answer on the matter:

Is there documentation on how the “Visible Time Range” feature is supposed to work?
I'm seeing the surprising behavior that setting it to a nonempty range causes fewer objects to be visible than if the range is a point (current + 0 to current + 0), and I'd assume that's a bug, but I don't see any description of its actual semantics.

That doesn't necessarily sound incorrect (although it might still sound surprising :D).

The default query (called "latest-at") will wall backwards in time until it finds data. I.e. LatestAt("my/entity", Point3D, Time(10)) might return data a Time(7) if there was no Point3D logged between 8 and 10.
A range query on the other hand (which is what you get when you enable visible time range) just walks forwards in time without any kind of backtracking. I.e. if you log a Point3D at 7 and then do a Range("my/entity", Point3D TimeRange(8, 10)), you will not find anything (a Range("my/entity", Point3D TimeRange(7, 10)) would, though).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation 🔍 re_query affects re_query itself user-request This is a pressing issue for one of our users
Projects
None yet
Development

No branches or pull requests

1 participant