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

[DOCS-2618] Note that event streaming is supported in beta #172

Merged
merged 2 commits into from
Apr 1, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ of FQL. To query your databases with earlier API versions, see
the `faunadb <https://pypi.org/project/faunadb/>`_ package.

See the `Fauna Documentation <https://docs.fauna.com/fauna/current/>`_
for additional information how to configure and query your databases.
for additional information on how to configure and query your databases.


Installation
Expand Down Expand Up @@ -52,7 +52,7 @@ Supported Environment Variables:
from fauna.errors import FaunaException

client = Client()
# The client defaults to using using the value stored FAUNA_SECRET for its secret.
# The client defaults to using the value stored FAUNA_SECRET for its secret.
# Either set the FAUNA_SECRET env variable or retrieve it from a secret store.
# As a best practice, don't store your secret directly in your code.

Expand Down Expand Up @@ -96,7 +96,7 @@ Serialization / Deserialization

Serialization and deserialization with user-defined classes is not yet supported.

When building queries, adapt your classes into dicts or lists prior to using them in composition. When instantiating classes from the query result data, build them from the expected result.
When building queries, adapt your classes into dicts or lists before using them in composition. When instantiating classes from the query result data, build them from the expected result.

.. code-block:: python

Expand Down Expand Up @@ -270,10 +270,13 @@ Stats are returned on query responses and ServiceErrors.
emit_stats(e.stats)
# more error handling...

Document Streaming
Event Streaming
------------------

Not implemented
`Event Streaming <https://docs.fauna.com/fauna/current/learn/streaming>`_ is currently available in the beta version of the driver:

- `Beta Python driver <https://pypi.org/project/fauna/1.2.0b3/>`_
jrodewig marked this conversation as resolved.
Show resolved Hide resolved
- `Beta Python driver docs <https://github.com/fauna/fauna-python/tree/beta>`_

Setup
-----
Expand Down
Loading