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.

Sign up for GitHub

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

Jump to bottom

docs: remove client-usage sections that no longer apply #95

Merged
merged 2 commits into from Jun 5, 2020
Merged

docs: remove client-usage sections that no longer apply #95

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdaa22f
docs: remove client-usage sections that no longer apply
larkee Jun 4, 2020
bd63332
Merge branch 'master' into update-client-usage
larkee Jun 5, 2020
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
23 changes: 0 additions & 23 deletions docs/client-usage.rst
View file
Open in desktop
Expand Up @@ -16,17 +16,6 @@ and creating other objects:
from google.cloud import spanner
client = spanner.Client()

Long-lived Defaults
-------------------

When creating a :class:`~google.cloud.spanner_v1.client.Client`, the
``user_agent`` and ``timeout_seconds`` arguments have sensible
defaults
(:data:`~google.cloud.spanner_v1.client.DEFAULT_USER_AGENT` and
:data:`~google.cloud.spanner_v1.client.DEFAULT_TIMEOUT_SECONDS`).
However, you may over-ride them and these will be used throughout all API
requests made with the ``client`` you create.

Configuration
-------------

Expand Down Expand Up @@ -62,18 +51,6 @@ Configuration
Be sure to use the **Project ID**, not the **Project Number**.


Warnings about Multiprocessing
------------------------------

.. warning::
When using multiprocessing, the application may hang if a
:class:`Client <google.cloud.spanner_v1.client.Client>` instance is created
before :class:`multiprocessing.Pool` or :class:`multiprocessing.Process`
invokes :func:`os.fork`. The issue is under investigation, but may be only
happening on Macintosh and not Linux. See `GRPC/GRPC#12455
<https://github.com/grpc/grpc/issues/12455#issuecomment-348578950>`_ for
more information.

Next Step
---------

Expand Down