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

Expand blocking query docs beyond instructions for usage #12115

Open
freddygv opened this issue Jan 19, 2022 · 0 comments
Open

Expand blocking query docs beyond instructions for usage #12115

freddygv opened this issue Jan 19, 2022 · 0 comments
Labels
type/docs Documentation needs to be created/updated/clarified

Comments

@freddygv
Copy link
Contributor

The current blocking query docs primarily state how to use blocking queries, and could be expanded to include additional details about their behavior. Here are a couple ideas on behavior that could be documented about them:

Index returned for various queries

Depending on the query, the index returned can vary. At times it is the max index for the table, at times it is the max index of the result set, at times it is the index of a given resource.

Behavior of blocking on resources that don't exist

When a blocking query is set up for a resource that doesn't exist, such as a KV key, unrelated key updates can lead to the blocking query firing. This is due to how memdb will watch for changes, and the fact that when the resource doesn't exist the index considered by the query is the max for the table/partition/namespace.

This issue is being addressed in #12110, but the existing behavior should be documented since it has been a cause for confusion/concern in several deployments.

@freddygv freddygv added the type/docs Documentation needs to be created/updated/clarified label Jan 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

No branches or pull requests

1 participant