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

docs(bigtable): clean up #32

Merged
merged 3 commits into from May 26, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 0 additions & 12 deletions google/cloud/bigtable/cluster.py
Expand Up @@ -286,18 +286,6 @@ def update(self):

before calling :meth:`update`.

:type location: :str:``CreationOnly``
:param location: The location where this cluster's nodes and storage
reside. For best performance, clients should be located as
close as possible to this cluster. Currently only zones are
supported, so values should be of the form
``projects/<project>/locations/<zone>``.

:type serve_nodes: :int
:param serve_nodes: The number of nodes allocated to this cluster.
More nodes enable higher throughput and more consistent
performance.

:rtype: :class:`Operation`
:returns: The long-running operation corresponding to the
update operation.
Expand Down
3 changes: 0 additions & 3 deletions google/cloud/bigtable/instance.py
Expand Up @@ -537,9 +537,6 @@ def cluster(
:type cluster_id: str
:param cluster_id: The ID of the cluster.

:type instance: :class:`~google.cloud.bigtable.instance.Instance`
:param instance: The instance where the cluster resides.

:type location_id: str
:param location_id: (Creation Only) The location where this cluster's
nodes and storage reside. For best performance,
Expand Down
9 changes: 3 additions & 6 deletions google/cloud/bigtable/table.py
Expand Up @@ -359,7 +359,7 @@ def create(self, initial_split_keys=[], column_families={}):
into several tablets.

:type column_families: dict
:param column_failies: (Optional) A map columns to create. The key is
:param column_families: (Optional) A map columns to create. The key is
the column_id str and the value is a
:class:`GarbageCollectionRule`
"""
Expand Down Expand Up @@ -734,8 +734,8 @@ def drop_by_prefix(self, row_key_prefix, timeout=None):
:start-after: [START bigtable_drop_by_prefix]
:end-before: [END bigtable_drop_by_prefix]

:type row_prefix: bytes
:param row_prefix: Delete all rows that start with this row key
:type row_key_prefix: bytes
:param row_key_prefix: Delete all rows that start with this row key
prefix. Prefix cannot be zero length.

:type timeout: float
Expand Down Expand Up @@ -768,9 +768,6 @@ def mutations_batcher(self, flush_count=FLUSH_COUNT, max_row_bytes=MAX_ROW_BYTES
:start-after: [START bigtable_mutations_batcher]
:end-before: [END bigtable_mutations_batcher]

:type table: class
:param table: class:`~google.cloud.bigtable.table.Table`.

:type flush_count: int
:param flush_count: (Optional) Maximum number of rows per batch. If it
reaches the max number of rows it calls finish_batch() to
Expand Down