Skip to content

Commit

Permalink
docs: document thread-safety of client (#75)
Browse files Browse the repository at this point in the history
  • Loading branch information
HemangChothani committed Sep 16, 2020
1 parent 7df727d commit ae0339c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit ae0339c

Please sign in to comment.