-
Notifications
You must be signed in to change notification settings - Fork 7
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
Move streaming to GA #262
Move streaming to GA #262
Conversation
c469cdc
to
ab5355f
Compare
@jrodewig Adding the |
Great tip — Thanks @ptpaterson! |
to a set from a [supported | ||
source](https://docs.fauna.com/fauna/current/reference/streaming_reference/#supported-sources). | ||
|
||
To start and subscribe to the stream, pass the stream token to `Client.stream()`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it a Client
class or its instance client
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's an instance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll work on getting this fixed. Thanks for raising @w01fgang!
client.stream(streamToken) | ||
``` | ||
|
||
You can also pass a query that produces a stream token directly to `Client.stream()`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same here, should it be client.stream()
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes — It's an instance here as well.
- Documents the `flatten()` method for pagination - Removes class names from method references in text. This aligns with Google's [style recommendations](https://developers.google.com/style/code-in-text#method-names). A user was recently confused by it. ([ref](#262 (comment)))
IMPORTANT: DO NOT MERGE UNTIL STREAMING LAUNCH.
Ticket(s):
Merge all beta changes into main. Further documents streaming. Examples are borrowed from the docs.fauna.com driver docs, but I re-tested them.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.