Skip to content

Bigtable V2 docs fixes lost in merge #1948

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

Merged
tseaver merged 5 commits into from
Jun 30, 2016
Merged

Bigtable V2 docs fixes lost in merge #1948

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3e9928c
Document required-for-new-instances 'location_id' parameter.
tseaver Jun 29, 2016
5ad2861
Replace somewhat convoluted paragraph.
tseaver Jun 29, 2016
0c52116
Typo fix.
tseaver Jun 29, 2016
081603c
Rephrase again.
tseaver Jun 30, 2016
3dd188f
Overlooked 'cluster' -> 'instance' rename in docs.
tseaver Jun 30, 2016
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
24 changes: 16 additions & 8 deletions docs/bigtable-instance-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,24 @@ To create a :class:`Instance <gcloud.bigtable.instance.Instance>` object:

.. code:: python

instance = client.instance(instance_id, display_name=display_name)
instance = client.instance(instance_id, location_id,
display_name=display_name)

``display_name`` is optional. When not provided,
``display_name`` defaults to the ``instance_id`` value.
- ``location_id`` is the ID of the location in which the instance's cluster
will be hosted, e.g. ``'us-central1-c'``. ``location_id`` is required for
instances which do not already exist.

Even if this :class:`Instance <gcloud.bigtable.instance.Instance>` already
has been created with the API, you'll want this object to use as a
parent of a :class:`Table <gcloud.bigtable.table.Table>` just as the
:class:`Client <gcloud.bigtable.client.Client>` is used as the parent of
a :class:`Instance <gcloud.bigtable.instance.Instance>`.
- ``display_name`` is optional. When not provided, ``display_name`` defaults
to the ``instance_id`` value.

You can also use :meth:`Client.instance` to create a local wrapper for
instances that have already been created with the API, or through the web
conole:

.. code:: python

instance = client.instance(existing_instance_id)
instance.reload()

Create a new Instance
---------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/bigtable-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Get started by learning about the
In the hierarchy of API concepts

* a :class:`Client <gcloud.bigtable.client.Client>` owns a
:class:`Cluster <gcloud.bigtable.cluster.Cluster>`
* a :class:`Cluster <gcloud.bigtable.cluster.Cluster>` owns a
:class:`Cluster <gcloud.bigtable.instance.Instance`
* a :class:`Cluster <gcloud.bigtable.instance.Instance` owns a
:class:`Table <gcloud.bigtable.table.Table>`
* a :class:`Table <gcloud.bigtable.table.Table>` owns a
:class:`ColumnFamily <gcloud.bigtable.column_family.ColumnFamily>`
Expand Down
2 changes: 1 addition & 1 deletion gcloud/bigtable/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

In the hierarchy of API concepts

* a :class:`Client` owns a :class:`.Instance`
* a :class:`Client` owns an :class:`.Instance`
* a :class:`.Instance` owns a :class:`Table <gcloud.bigtable.table.Table>`
* a :class:`Table <gcloud.bigtable.table.Table>` owns a
:class:`ColumnFamily <.column_family.ColumnFamily>`
Expand Down