Docs updates in preparation for the Sync Streams beta release#349
Docs updates in preparation for the Sync Streams beta release#349
Conversation
…docs into sync-stream-beta
|
When I reviewed the Sync Streams "Quickstart" page, and it explained user-scoped data and parameterized data, I felt we could simplify that because we want to reduce the overall number of new concepts that the user feels they need to go through. When talking about parameterized data, we referred exclusively to using subscription parameters, but:
I ended up editing that section a bit and collapsing the Using Parameters section into it. |
|
@benitav Suggestions for improvements to the Supported SQL page: Operators and Functions
I think we should be as specific as possible. Remove "typically" and "special limits apply" and rather say exactly what is and what is not supported (and distinguish Sync Rules vs Sync Streams respectively, if they differ) Operators"Arrays:" says the following:
This seems to be specific to Sync Rules (and uses Sync Rules terminology). Can we update that section to specify what is supported in Sync Streams vs. Sync Rules w.r.t. arrays and the |
simolus3
left a comment
There was a problem hiding this comment.
I've mostly looked at the examples for sync streams, comparing them with the diff of original sync rules.
One thing that stands out is the use of a global with block that isn't supported (see the original PR for details). Apologies for that, I don't think we've communicated that limitation clearly and I know the original doc says something else :/
Co-authored-by: Simon Binder <oss@simonbinder.eu>
Co-authored-by: Simon Binder <oss@simonbinder.eu>
…docs into sync-stream-beta
Details are in this internal doc https://docs.google.com/document/d/1oP0UNOjpsfSrQ1a2WIhG0A0DYeWU1tTIGZqMMKuqzdE/edit
At a high level, this prioritizes Sync Streams over Sync Rules throughout the documentation and labels Sync Rules as legacy, updates alpha references to beta, fleshed out Sync Streams docs, and also documents new features (e.g. nested subqueries, JOIN syntax, CTEs) that have been added since the alpha release (though not yet released).
Also includes some general polish: