diff --git a/docs/bigtable-instance-api.rst b/docs/bigtable-instance-api.rst index 7cf3f2e9c860..4d03fa7b1b97 100644 --- a/docs/bigtable-instance-api.rst +++ b/docs/bigtable-instance-api.rst @@ -28,16 +28,24 @@ To create a :class:`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 ` already -has been created with the API, you'll want this object to use as a -parent of a :class:`Table ` just as the -:class:`Client ` is used as the parent of -a :class:`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 --------------------- diff --git a/docs/bigtable-usage.rst b/docs/bigtable-usage.rst index 61966ac21795..14cadd084f72 100644 --- a/docs/bigtable-usage.rst +++ b/docs/bigtable-usage.rst @@ -18,8 +18,8 @@ Get started by learning about the In the hierarchy of API concepts * a :class:`Client ` owns a - :class:`Cluster ` -* a :class:`Cluster ` owns a + :class:`Cluster ` * a :class:`Table ` owns a :class:`ColumnFamily ` diff --git a/gcloud/bigtable/client.py b/gcloud/bigtable/client.py index cf25d05f2a0d..35ca65ce212a 100644 --- a/gcloud/bigtable/client.py +++ b/gcloud/bigtable/client.py @@ -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 ` * a :class:`Table ` owns a :class:`ColumnFamily <.column_family.ColumnFamily>`