docs(bigquery): add client thread-safety documentation (#132)

* docs(bigquery): add client thread-safety documentation * docs(bigquery): nit * docs(bigquery): nit
googleapis · Jun 15, 2020 · fce76b3 · fce76b3
1 parent 445ae08
commit fce76b3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,14 @@
 .. include:: README.rst
 
+.. note::
+
+   Because the BigQuery client uses the third-party :mod:`requests` library
+   by default and the BigQuery-Storage client uses :mod:`grpcio` library,
+   both 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`.
+
 More Examples
 ~~~~~~~~~~~~~