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.

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

Correctly iterate over list_databases. #4047

Merged
Merged
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions docs/spanner/database-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@ interact with individual databases for that instance.
List Databases
--------------

To list of all existing databases for an instance, use its
To iterate over all existing databases for an instance, use its
:meth:`~google.cloud.spanner.instance.Instance.list_databases` method:

.. code:: python

databases, token = instance.list_databases()
for database in instance.list_databases():
# `database` is a `Database` object.

This method yields :class:`~.spanner_admin_database_v1.types.Database`
objects.


Database Factory
Expand Down