Skip to content
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

Merged
merged 16 commits into from
May 20, 2024
Merged

Move streaming to GA #262

merged 16 commits into from
May 20, 2024

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented May 9, 2024

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.

@jrodewig jrodewig force-pushed the streaming-ga branch 2 times, most recently from c469cdc to ab5355f Compare May 9, 2024 13:46
@jrodewig jrodewig marked this pull request as ready for review May 9, 2024 16:26
@jrodewig jrodewig requested a review from pnwpedro May 9, 2024 16:27
@ptpaterson ptpaterson added the pr/do-not-merge If this label exist the PR is blocked from merging into main label May 10, 2024
@ptpaterson
Copy link
Contributor

@jrodewig Adding the pr/do-not-merge label will cause checks to fail and disallow merging! I've gone ahead and done that. The label can be removed when ready!

@jrodewig
Copy link
Contributor Author

@jrodewig Adding the pr/do-not-merge label will cause checks to fail and disallow merging! I've gone ahead and done that. The label can be removed when ready!

Great tip — Thanks @ptpaterson!

pnwpedro
pnwpedro previously approved these changes May 17, 2024
@ptpaterson ptpaterson changed the title [DOCS-2750] Move streaming to GA Move streaming to GA May 17, 2024
@ptpaterson ptpaterson requested a review from pnwpedro May 17, 2024 19:19
@ptpaterson ptpaterson removed the pr/do-not-merge If this label exist the PR is blocked from merging into main label May 20, 2024
@ptpaterson ptpaterson merged commit b534d62 into main May 20, 2024
5 of 6 checks passed
@ptpaterson ptpaterson deleted the streaming-ga branch May 20, 2024 17:13
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()`:

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's an instance.

Copy link
Contributor Author

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()`:

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()?

Copy link
Contributor Author

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.

jrodewig added a commit that referenced this pull request May 24, 2024
- 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)))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants