Cloud Bigtable writes samples (GoogleCloudPlatform#2201)

billyjacobson · web-flow · commit 950d97a9e783 · 2019-06-26T09:23:25.000-04:00
* Bigtable write samples

* Cleaning up test

* Fixing lint issues

* Fixing imports in test

* Cleaning up samples and showing error handling

* removing note about the row commit bug

* Add fixture to write test

* Use test fixtures to create and delete test tables.
diff --git a/bigtable/snippets/writes/__init__.py b/bigtable/snippets/writes/__init__.py
diff --git a/bigtable/snippets/writes/requirements.txt b/bigtable/snippets/writes/requirements.txt
@@ -0,0 +1 @@
+google-cloud-bigtable==0.32.1
diff --git a/bigtable/snippets/writes/write_batch.py b/bigtable/snippets/writes/write_batch.py
@@ -0,0 +1,55 @@
+#!/usr/bin/env python
+
+# Copyright 2019, Google LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# [START bigtable_writes_batch]
+import datetime
+
+from google.cloud import bigtable
+
+
+def write_batch(project_id, instance_id, table_id):
+    client = bigtable.Client(project=project_id, admin=True)
+    instance = client.instance(instance_id)
+    table = instance.table(table_id)
+
+    timestamp = datetime.datetime.utcnow()
+    column_family_id = "stats_summary"
+
+    rows = [table.row("tablet#a0b81f74#20190501"),
+            table.row("tablet#a0b81f74#20190502")]
+
+    rows[0].set_cell(column_family_id,
+                     "connected_wifi",
+                     1,
+                     timestamp)
+    rows[0].set_cell(column_family_id,
+                     "os_build",
+                     "12155.0.0-rc1",
+                     timestamp)
+    rows[1].set_cell(column_family_id,
+                     "connected_wifi",
+                     1,
+                     timestamp)
+    rows[1].set_cell(column_family_id,
+                     "os_build",
+                     "12145.0.0-rc6",
+                     timestamp)
+
+    response = table.mutate_rows(rows)
+    for i, status in enumerate(response):
+        if status.code != 0:
+            print("Error writing row: {}".format(status.message))
+
+    print('Successfully wrote 2 rows.')
+# [END bigtable_writes_batch]
diff --git a/bigtable/snippets/writes/write_conditionally.py b/bigtable/snippets/writes/write_conditionally.py
@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+
+# Copyright 2019, Google LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# [START bigtable_writes_conditional]
+import datetime
+
+from google.cloud import bigtable
+from google.cloud.bigtable import row_filters
+
+
+def write_conditional(project_id, instance_id, table_id):
+    client = bigtable.Client(project=project_id, admin=True)
+    instance = client.instance(instance_id)
+    table = instance.table(table_id)
+
+    timestamp = datetime.datetime.utcnow()
+    column_family_id = "stats_summary"
+
+    row_key = "phone#4c410523#20190501"
+
+    row_filter = row_filters.RowFilterChain(
+        filters=[row_filters.FamilyNameRegexFilter(column_family_id),
+                 row_filters.ColumnQualifierRegexFilter('os_build'),
+                 row_filters.ValueRegexFilter("PQ2A\\..*")])
+    row = table.row(row_key, filter_=row_filter)
+    row.set_cell(column_family_id,
+                 "os_name",
+                 "android",
+                 timestamp)
+    row.commit()
+
+    print('Successfully updated row\'s os_name.')
+# [END bigtable_writes_conditional]
diff --git a/bigtable/snippets/writes/write_increment.py b/bigtable/snippets/writes/write_increment.py
@@ -0,0 +1,34 @@
+#!/usr/bin/env python
+
+# Copyright 2019, Google LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# [START bigtable_writes_increment]
+from google.cloud import bigtable
+
+
+def write_increment(project_id, instance_id, table_id):
+    client = bigtable.Client(project=project_id, admin=True)
+    instance = client.instance(instance_id)
+    table = instance.table(table_id)
+
+    column_family_id = "stats_summary"
+
+    row_key = "phone#4c410523#20190501"
+    row = table.row(row_key, append=True)
+
+    # Decrement the connected_wifi value by 1.
+    row.increment_cell_value(column_family_id, "connected_wifi", -1)
+    row.commit()
+
+    print('Successfully updated row {}.'.format(row_key))
+# [END bigtable_writes_increment]
diff --git a/bigtable/snippets/writes/write_simple.py b/bigtable/snippets/writes/write_simple.py
@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+
+# Copyright 2019, Google LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# [START bigtable_writes_simple]
+import datetime
+from google.cloud import bigtable
+
+
+def write_simple(project_id, instance_id, table_id):
+    client = bigtable.Client(project=project_id, admin=True)
+    instance = client.instance(instance_id)
+    table = instance.table(table_id)
+
+    timestamp = datetime.datetime.utcnow()
+    column_family_id = "stats_summary"
+
+    row_key = "phone#4c410523#20190501"
+
+    row = table.row(row_key)
+    row.set_cell(column_family_id,
+                 "connected_cell",
+                 1,
+                 timestamp)
+    row.set_cell(column_family_id,
+                 "connected_wifi",
+                 1,
+                 timestamp)
+    row.set_cell(column_family_id,
+                 "os_build",
+                 "PQ2A.190405.003",
+                 timestamp)
+
+    row.commit()
+
+    print('Successfully wrote row {}.'.format(row_key))
+# [END bigtable_writes_simple]
diff --git a/bigtable/snippets/writes/writes_test.py b/bigtable/snippets/writes/writes_test.py
@@ -0,0 +1,76 @@
+# Copyright 2018 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import uuid
+import pytest
+
+from google.cloud import bigtable
+
+from .write_batch import write_batch
+from .write_conditionally import write_conditional
+from .write_increment import write_increment
+from .write_simple import write_simple
+
+PROJECT = os.environ['GCLOUD_PROJECT']
+BIGTABLE_INSTANCE = os.environ['BIGTABLE_CLUSTER']
+TABLE_ID_PREFIX = 'mobile-time-series-{}'
+
+
+@pytest.fixture
+def bigtable_client():
+    return bigtable.Client(project=PROJECT, admin=True)
+
+
+@pytest.fixture
+def bigtable_instance(bigtable_client):
+    return bigtable_client.instance(BIGTABLE_INSTANCE)
+
+
+@pytest.fixture
+def table_id(bigtable_instance):
+    table_id = TABLE_ID_PREFIX.format(str(uuid.uuid4())[:16])
+    table = bigtable_instance.table(table_id)
+    if table.exists():
+        table.delete()
+
+    column_family_id = 'stats_summary'
+    column_families = {column_family_id: None}
+    table.create(column_families=column_families)
+
+    yield table_id
+
+    table.delete()
+
+
+def test_writes(capsys, table_id):
+    write_simple(PROJECT, BIGTABLE_INSTANCE, table_id)
+
+    out, _ = capsys.readouterr()
+    assert 'Successfully wrote row' in out
+
+    write_increment(PROJECT, BIGTABLE_INSTANCE, table_id)
+
+    out, _ = capsys.readouterr()
+    assert 'Successfully updated row' in out
+
+    write_conditional(PROJECT, BIGTABLE_INSTANCE, table_id)
+
+    out, _ = capsys.readouterr()
+    assert 'Successfully updated row\'s os_name' in out
+
+    write_batch(PROJECT, BIGTABLE_INSTANCE, table_id)
+
+    out, _ = capsys.readouterr()
+    assert 'Successfully wrote 2 rows' in out
