ptupitsyn commented on code in PR #6201: URL: https://github.com/apache/ignite-3/pull/6201#discussion_r2189632045
########## docs/_docs/developers-guide/sql/sql-api.adoc: ########## @@ -123,4 +123,53 @@ client.sql().executeScript(script); ---- -- -NOTE: Execution of each statement is considered complete when the first page is ready to be returned. As a result, when working with large data sets, SELECT statement may be affected by later statements in the same script. \ No newline at end of file +NOTE: Execution of each statement is considered complete when the first page is ready to be returned. As a result, when working with large data sets, SELECT statement may be affected by later statements in the same script. + +=== Query Cancellation + +NOTE: Currently, query cancellation is only supported in embedded mode and Java thin client. Support for cancellation from other clients will be added in an upcoming release. Review Comment: ```suggestion ``` ########## docs/_docs/developers-guide/sql/sql-api.adoc: ########## @@ -123,4 +123,53 @@ client.sql().executeScript(script); ---- -- -NOTE: Execution of each statement is considered complete when the first page is ready to be returned. As a result, when working with large data sets, SELECT statement may be affected by later statements in the same script. \ No newline at end of file +NOTE: Execution of each statement is considered complete when the first page is ready to be returned. As a result, when working with large data sets, SELECT statement may be affected by later statements in the same script. + +=== Query Cancellation + +NOTE: Currently, query cancellation is only supported in embedded mode and Java thin client. Support for cancellation from other clients will be added in an upcoming release. + +By default, a submitted query cannot be cancelled until it succeeds or fails. For large queries, you may want an option to cancel them halfway. To perform a cancellable query, first create a `CancellationToken` object, and then pass it to the `executeAsync` method: Review Comment: > By default, a submitted query cannot be cancelled until it succeeds or fails. For large queries, you may want an option to cancel them halfway. This part seems confusing and unnecessary. It probably tries to explain that without a cancel token you can only close the cursor once the results are ready. I think it is enough to say "if you need to cancel a query, pass cancellation token". -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@ignite.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
