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

Correct documentation about instance iterators. #4044

Merged
merged 1 commit into from
Sep 25, 2017
Merged

Correct documentation about instance iterators. #4044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/spanner/instance-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@ Each instance within a project maps to a named "instance configuration",
specifying the location and other parameters for a set of instances. These
configurations are defined by the server, and cannot be changed.

To list of all instance configurations available to your project, use the
To iterate over all instance configurations available to your project, use the
:meth:`~google.cloud.spanner.client.Client.list_instance_configs`
method of the client:

.. code:: python

configs, token = client.list_instance_configs()
for config in client.list_instance_configs():
# `config` is an instance of `InstanceConfig`


To fetch a single instance configuration, use the
Expand All @@ -28,17 +29,24 @@ method of the client:

config = client.get_instance_configuration('config-name')

Each of these methods provide
:class:`~.spanner_admin_instance_v1.types.InstanceConfig` objects.


List Instances
--------------

If you want a comprehensive list of all existing instances, use the
If you want a comprehensive list of all existing instances, iterate over the
:meth:`~google.cloud.spanner.client.Client.list_instances` method of
the client:

.. code:: python

instances, token = client.list_instances()
for instance in client.list_instances():
# `instance` is an instance of `Instance`

This iterator yields :class:`~.spanner_admin_instance_v1.types.Instance`
objects.


Instance Factory
Expand All @@ -57,7 +65,7 @@ To create a :class:`~google.cloud.spanner.instance.Instance` object:
- ``configuration_name`` is the name of the instance configuration to which the
instance will be bound. It must be one of the names configured for your
project, discoverable via
:meth:`google.cloud.spanner.client.Client.list_instance_configs`.
:meth:`~google.cloud.spanner.client.Client.list_instance_configs`.

- ``node_count`` is a postitive integral count of the number of nodes used
by the instance. More nodes allows for higher performance, but at a higher
Expand Down