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-723 | Query plan caching #641

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

DOC-723 | Query plan caching #641

wants to merge 10 commits into from

Conversation

Simran-B
Copy link
Contributor

@Simran-B Simran-B commented Nov 19, 2024

Description

Upstream PRs

  • 3.10:
  • 3.11: arangodb/enterprise:3.11.12
  • 3.12: arangodb/enterprise-preview:devel-nightly
  • 3.13: arangodb/enterprise-preview:devel-nightly

Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-641--docs-hugo.netlify.app

@Simran-B Simran-B self-assigned this Nov 19, 2024
@cla-bot cla-bot bot added the cla-signed label Nov 19, 2024
Comment on lines 64 to 66
- `explainRegisters` (internal)
- `inaccessibleCollections` (internal)
- `shardIds` (internal)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Internal, correct?

Comment on lines 114 to 115
- An existing collection gets dropped or renamed, or the properties of an
existing collection are modified
Copy link
Contributor Author

@Simran-B Simran-B Nov 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But only if the affected collection is in the list of data sources for the cached query plan? At least that's what I saw. On the other hand, dropping a named graph with no collections in common, the cache did get cleared.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a named graph is changed or dropped, the complete cache for that database is eradicated. If a data source is changed, only those entries which are affected are deleted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: Check again whether the entire cache is now cleared on any of these events, including e.g. changing the schema, computed values, or cacheEnabled of a collection in single server.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In single server, the cache isn't necessarily cleared entirely but it depends on the operation. I suggest we add a vague remark to the docs that operations may only remove affected entries in single server.

@Simran-B Simran-B requested a review from neunhoef November 20, 2024 17:40
@Simran-B Simran-B added this to the 3.12.4 milestone Nov 20, 2024
@Simran-B Simran-B marked this pull request as ready for review November 20, 2024 17:41
Copy link
Member

@neunhoef neunhoef left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally LGTM, I have added a few suggestions.

Comment on lines 114 to 115
- An existing collection gets dropped or renamed, or the properties of an
existing collection are modified
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a named graph is changed or dropped, the complete cache for that database is eradicated. If a data source is changed, only those entries which are affected are deleted.

* Add query options to HTTP and JS API reference
* Review, examples, adjust to changed behavior
* Move (results) cache option to query sub options
* Apply to 3.13
@Simran-B
Copy link
Contributor Author

/generate-commit

@Simran-B
Copy link
Contributor Author

/generate-commit

@Simran-B
Copy link
Contributor Author

/generate-commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants