feat: Doc fetch from cursor to be non-blocking and blocking
#23
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
hzxa21
approved these changes
Nov 11, 2024
delivery/subscription.mdx
Outdated
| @@ -83,33 +83,39 @@ If you specify `FULL` instead of the `since_clause`, the subscription cursor sta | |||
| FETCH from cursor function is currently only supported in the PSQL simple query mode. If you are using components like JDBC that default to the extended query mode, please manually set the mode to simple query mode. | |||
There was a problem hiding this comment.
Extended mode is also supported in risingwavelabs/risingwave#17821 starting from v2.0
delivery/subscription.mdx
Outdated
| (1 row) | ||
| ``` | ||
|
|
||
| The `op` column in the result stands for the change operations. It has four options: `insert`, `update_insert`, `delete`, and `update_delete`. For a single UPDATE statement, the subscription log will contain two separate rows: one with `update_insert` and another with `update_delete`. This is because RisingWave treats an UPDATE as a delete of the old value followed by an insert of the new value. As for `rw_timestamp`, it corresponds to the Unix timestamp in milliseconds when the data was written. | ||
| In the example above, the `op` column in the result indicates the type of change operations. There are four options: `insert`, `update_insert`, `delete`, and `update_delete`. For a single UPDATE statement, the subscription log will contain two separate rows: one with `update_insert` and another with `update_delete`. This is because RisingWave treats an UPDATE as a delete of the old value followed by an insert of the new value. As for `rw_timestamp`, it corresponds to the Unix timestamp in milliseconds when the data was written. |
There was a problem hiding this comment.
The four options are in camelCase instead of snake_case: Insert, Delete, UpdateInsert, UpdateDelete.
delivery/subscription.mdx
Outdated
|
|
||
| Note that each time `FETCH NEXT FROM cursor_name` is called, it will return one row of incremental data from the subscribed table. It does not return all the incremental data at once, but requires the user to repeatedly call this statement to fetch the data. | ||
| ```sql | ||
| FETCH NEXT/n FROM cursor_name WITH (timeout = 'xx'); |
There was a problem hiding this comment.
Let's give a concrete example for timeout: replace timeout = 'xx' to timeout = '1s'
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.
Description
Doc
fetch from cursorto be non-blocking and blockingRelated code PR
risingwavelabs/risingwave#18675
Related doc issue
Resolve https://github.com/risingwavelabs/risingwave-docs/issues/2672