docs: update sql syntax and options table (part 3) #30689
Merged
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
kay-kim
commented
Dec 4, 2024
| @@ -29,21 +29,36 @@ You can use `SUBSCRIBE` to: | |||
|
|
|||
| ## Syntax | |||
|
|
|||
| {{< diagram "subscribe-stmt.svg" >}} | |||
| ```mzsql | |||
There was a problem hiding this comment.
As I finish up with the SHOW pages, I thought I'd include the SUBSCRIBE as a POC.
There was a problem hiding this comment.
kay-kim
commented
Dec 4, 2024
| | **WITHIN TIMESTAMP ORDER BY** \<column1\>, ... | If specified, use an `ORDER BY` clause to sort the subscription output within a timestamp. For each `ORDER BY` column, you can optionally specify: <ul><li> `ASC` or `DESC`</li><li> `NULLS FIRST` or `NULLS LAST`</li></ul> For more information, see [Modifying the output format](#modifying-the-output-format). | | ||
| | **AS OF** \<timestamp_expression\> | If specified, no rows whose timestamp is earlier than the specified timestamp will be returned. For more information, see [`AS OF`](#as-of). | | ||
| | **UP TO** \<timestamp_expression\> | If specified, no rows whose timestamp is greater than or equal to the specified timestamp will be returned. For more information, see [`UP TO`](#up-to). | | ||
| | **WITH** \<option_name\> [= \<option_value\>] | If specified, use the specified option. For more information, see [`WITH` options](#with-options). | |
There was a problem hiding this comment.
The WITH options on our pages have been treated a bit differently with its own sections, so, in keeping with that, I just listed in the table with all options and then, kept the WITH options section.
Alternatively, I could also go with:
### Options
#### With options
Or, even put the WITH options table from below into the Description here.
JLDLaughlin
approved these changes
Jan 9, 2025
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.
No description provided.