Skip to content

Commit 7d29482

Browse files
authored
Merge pull request #1948 from tseaver/bigtable-v2-lost-docs-fixes
Bigtable V2 docs fixes lost in merge
2 parents f00b050 + 3dd188f commit 7d29482

File tree

3 files changed

+19
-11
lines changed

3 files changed

+19
-11
lines changed

docs/bigtable-instance-api.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,24 @@ To create a :class:`Instance <gcloud.bigtable.instance.Instance>` object:
2828

2929
.. code:: python
3030
31-
instance = client.instance(instance_id, display_name=display_name)
31+
instance = client.instance(instance_id, location_id,
32+
display_name=display_name)
3233
33-
``display_name`` is optional. When not provided,
34-
``display_name`` defaults to the ``instance_id`` value.
34+
- ``location_id`` is the ID of the location in which the instance's cluster
35+
will be hosted, e.g. ``'us-central1-c'``. ``location_id`` is required for
36+
instances which do not already exist.
3537

36-
Even if this :class:`Instance <gcloud.bigtable.instance.Instance>` already
37-
has been created with the API, you'll want this object to use as a
38-
parent of a :class:`Table <gcloud.bigtable.table.Table>` just as the
39-
:class:`Client <gcloud.bigtable.client.Client>` is used as the parent of
40-
a :class:`Instance <gcloud.bigtable.instance.Instance>`.
38+
- ``display_name`` is optional. When not provided, ``display_name`` defaults
39+
to the ``instance_id`` value.
40+
41+
You can also use :meth:`Client.instance` to create a local wrapper for
42+
instances that have already been created with the API, or through the web
43+
conole:
44+
45+
.. code:: python
46+
47+
instance = client.instance(existing_instance_id)
48+
instance.reload()
4149
4250
Create a new Instance
4351
---------------------

docs/bigtable-usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Get started by learning about the
1818
In the hierarchy of API concepts
1919

2020
* a :class:`Client <gcloud.bigtable.client.Client>` owns a
21-
:class:`Cluster <gcloud.bigtable.cluster.Cluster>`
22-
* a :class:`Cluster <gcloud.bigtable.cluster.Cluster>` owns a
21+
:class:`Cluster <gcloud.bigtable.instance.Instance`
22+
* a :class:`Cluster <gcloud.bigtable.instance.Instance` owns a
2323
:class:`Table <gcloud.bigtable.table.Table>`
2424
* a :class:`Table <gcloud.bigtable.table.Table>` owns a
2525
:class:`ColumnFamily <gcloud.bigtable.column_family.ColumnFamily>`

gcloud/bigtable/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
1919
In the hierarchy of API concepts
2020
21-
* a :class:`Client` owns a :class:`.Instance`
21+
* a :class:`Client` owns an :class:`.Instance`
2222
* a :class:`.Instance` owns a :class:`Table <gcloud.bigtable.table.Table>`
2323
* a :class:`Table <gcloud.bigtable.table.Table>` owns a
2424
:class:`ColumnFamily <.column_family.ColumnFamily>`

0 commit comments

Comments
 (0)