-
Notifications
You must be signed in to change notification settings - Fork 148
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
Introduce AbortSignal
to Driver.executeQuery
#1199
Merged
bigmontz
merged 6 commits into
neo4j:5.0
from
bigmontz:5.x/feature/execute-query-signal
Jun 18, 2024
Merged
Introduce AbortSignal
to Driver.executeQuery
#1199
bigmontz
merged 6 commits into
neo4j:5.0
from
bigmontz:5.x/feature/execute-query-signal
Jun 18, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
**⚠️ This API is released as preview.** This configuration property enables the cancellation of ongoing queries which was previous not possible when using `Driver.executeQuery`. The cancellation is done by closing the session used internally by the driver when execute the query. This means the cancellation is not safe and transaction might be commit apart of the execution be aborted. The cancellation might also triggers errors on the `Driver.executeQuery` execution. Example: ```javascript const abortController = new AbortController() // Some event which cancels the query process.on('SIGINT', () => abortController.abort() ) const result = await driver.executeQuery(query, params, { database: 'neo4j', signal: abortController.signal }) ``` **⚠️ This API is released as preview.**
gjmwoods
approved these changes
Jun 17, 2024
Co-authored-by: gjmwoods <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This configuration property enables the cancellation of ongoing queries which was previous not possible when using
Driver.executeQuery
.The cancellation is done by closing the session used internally by the driver when execute the query. This means the cancellation is not safe and transaction might be commit apart of the execution being aborted. The cancellation might also triggers errors on the
Driver.executeQuery
execution.Example: