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: add documentation of thread-safe client #75

Merged
merged 3 commits into from Sep 16, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/index.rst
@@ -1,5 +1,13 @@
.. include:: README.rst

.. note::

Because the Datastore client uses the :mod:`grpcio` library by default
and uses third-party :mod:`requests` library if the GRPC is disabled,
clients are safe to share instances across threads. In multiprocessing
scenarios, the best practice is to create client instances *after*
:class:`multiprocessing.Pool` or :class:`multiprocessing.Process` invokes
:func:`os.fork`.

API Reference
-------------
Expand Down