Skip to content

Commit 4fc9ae8

Browse files
HemangChothanicrwilcox
authored andcommitted
docs(firestore): clarify client threadsafety (#9254)
* add doc for thread safety * changes in document as recommended * change in document description.
1 parent 5e9f2e0 commit 4fc9ae8

File tree

1 file changed

+7
-0
lines changed
  • packages/google-cloud-firestore/docs

1 file changed

+7
-0
lines changed

packages/google-cloud-firestore/docs/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
.. include:: README.rst
22

3+
.. note::
4+
5+
Because the firestore client uses :mod:`grpcio` library, it is safe to
6+
share instances across threads. In multiprocessing scenarios, the best
7+
practice is to create client instances *after* the invocation of
8+
:func:`os.fork` by :class:`multiprocessing.Pool` or
9+
:class:`multiprocessing.Process`.
310

411
API Reference
512
-------------

0 commit comments

Comments
 (0)