From 2d80188c65f454e037b758426b8747b5992db0de Mon Sep 17 00:00:00 2001 From: Billy Jacobson Date: Thu, 13 Apr 2023 15:43:51 -0400 Subject: [PATCH] docs: make delete examples consistent with other languages (#1710) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: make delete examples consistent with other languages * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- README.md | 5 +-- .../deletes/DeleteColumnFamilyExample.java | 18 +++++----- ...mple.java => DeleteFromColumnExample.java} | 4 +-- .../DeleteFromColumnFamilyExample.java | 33 +++++++++++++++++++ ...Example.java => DeleteFromRowExample.java} | 5 +-- .../example/bigtable/deletes/DeletesTest.java | 31 ++++++++++++----- 6 files changed, 74 insertions(+), 22 deletions(-) rename samples/snippets/src/main/java/com/example/bigtable/deletes/{DeleteColumnCellsExample.java => DeleteFromColumnExample.java} (90%) create mode 100644 samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnFamilyExample.java rename samples/snippets/src/main/java/com/example/bigtable/deletes/{DeleteRowExample.java => DeleteFromRowExample.java} (88%) diff --git a/README.md b/README.md index cb5dee5bd1..17a6c823e6 100644 --- a/README.md +++ b/README.md @@ -504,9 +504,10 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-bigtable/tree | Write Simple | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/WriteSimple.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/WriteSimple.java) | | Batch Delete Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/BatchDeleteExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/BatchDeleteExample.java) | | Conditional Delete Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/ConditionalDeleteExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/ConditionalDeleteExample.java) | -| Delete Column Cells Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnCellsExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnCellsExample.java) | | Delete Column Family Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnFamilyExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnFamilyExample.java) | -| Delete Row Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteRowExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteRowExample.java) | +| Delete From Column Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnExample.java) | +| Delete From Column Family Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnFamilyExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnFamilyExample.java) | +| Delete From Row Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromRowExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromRowExample.java) | | Delete Table Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteTableExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteTableExample.java) | | Drop Row Range Example | [source code](https://github.com/googleapis/java-bigtable/blob/main/samples/snippets/src/main/java/com/example/bigtable/deletes/DropRowRangeExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigtable&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigtable/deletes/DropRowRangeExample.java) | diff --git a/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnFamilyExample.java b/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnFamilyExample.java index 556c842cf6..e3648fb0a1 100644 --- a/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnFamilyExample.java +++ b/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnFamilyExample.java @@ -1,5 +1,5 @@ /* - * Copyright 2022 Google LLC + * Copyright 2023 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,16 +17,18 @@ package com.example.bigtable.deletes; // [START bigtable_delete_column_family] -import com.google.cloud.bigtable.data.v2.BigtableDataClient; -import com.google.cloud.bigtable.data.v2.models.RowMutation; +import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClient; +import com.google.cloud.bigtable.admin.v2.models.ModifyColumnFamiliesRequest; import java.io.IOException; public class DeleteColumnFamilyExample { - public void deleteColumnFamily(String projectId, String instanceId, String tableId) - throws IOException { - try (BigtableDataClient dataClient = BigtableDataClient.create(projectId, instanceId)) { - dataClient.mutateRow( - RowMutation.create(tableId, "phone#5c10102#20190501").deleteFamily("stats_summary")); + public void deleteColumnFamily( + String projectId, String instanceId, String tableId, String columnFamily) throws IOException { + try (BigtableTableAdminClient tableAdminClient = + BigtableTableAdminClient.create(projectId, instanceId)) { + ModifyColumnFamiliesRequest modifyColumnFamiliesRequest = + ModifyColumnFamiliesRequest.of(tableId).dropFamily(columnFamily); + tableAdminClient.modifyFamilies(modifyColumnFamiliesRequest); } } } diff --git a/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnCellsExample.java b/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnExample.java similarity index 90% rename from samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnCellsExample.java rename to samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnExample.java index eefc4e1d84..7403272d19 100644 --- a/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteColumnCellsExample.java +++ b/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnExample.java @@ -22,8 +22,8 @@ import com.google.cloud.bigtable.data.v2.models.RowMutation; import java.io.IOException; -public class DeleteColumnCellsExample { - public void deleteColumnCells(String projectId, String instanceId, String tableId) +public class DeleteFromColumnExample { + public void deleteFromColumnCells(String projectId, String instanceId, String tableId) throws IOException { try (BigtableDataClient dataClient = BigtableDataClient.create(projectId, instanceId)) { Mutation mutation = Mutation.create().deleteCells("cell_plan", "data_plan_01gb"); diff --git a/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnFamilyExample.java b/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnFamilyExample.java new file mode 100644 index 0000000000..db89c04e4b --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromColumnFamilyExample.java @@ -0,0 +1,33 @@ +/* + * Copyright 2022 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. + */ + +package com.example.bigtable.deletes; + +// [START bigtable_delete_from_column_family] +import com.google.cloud.bigtable.data.v2.BigtableDataClient; +import com.google.cloud.bigtable.data.v2.models.RowMutation; +import java.io.IOException; + +public class DeleteFromColumnFamilyExample { + public void deleteFromColumnFamily(String projectId, String instanceId, String tableId) + throws IOException { + try (BigtableDataClient dataClient = BigtableDataClient.create(projectId, instanceId)) { + dataClient.mutateRow( + RowMutation.create(tableId, "phone#5c10102#20190501").deleteFamily("stats_summary")); + } + } +} +// [END bigtable_delete_from_column_family] diff --git a/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteRowExample.java b/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromRowExample.java similarity index 88% rename from samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteRowExample.java rename to samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromRowExample.java index 9607a17079..029298497f 100644 --- a/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteRowExample.java +++ b/samples/snippets/src/main/java/com/example/bigtable/deletes/DeleteFromRowExample.java @@ -22,8 +22,9 @@ import com.google.cloud.bigtable.data.v2.models.RowMutation; import java.io.IOException; -public class DeleteRowExample { - public void deleteRow(String projectId, String instanceId, String tableId) throws IOException { +public class DeleteFromRowExample { + public void deleteFromRow(String projectId, String instanceId, String tableId) + throws IOException { try (BigtableDataClient dataClient = BigtableDataClient.create(projectId, instanceId)) { Mutation mutation = Mutation.create().deleteRow(); dataClient.mutateRow(RowMutation.create(tableId, "phone#4c410523#20190501", mutation)); diff --git a/samples/snippets/src/test/java/com/example/bigtable/deletes/DeletesTest.java b/samples/snippets/src/test/java/com/example/bigtable/deletes/DeletesTest.java index 4ac12c1e47..bff3c74a1f 100644 --- a/samples/snippets/src/test/java/com/example/bigtable/deletes/DeletesTest.java +++ b/samples/snippets/src/test/java/com/example/bigtable/deletes/DeletesTest.java @@ -63,8 +63,8 @@ public void test1_testDeleteFromColumn() throws IOException { Truth.assertThat(cells).isNotEmpty(); - DeleteColumnCellsExample deleteColumnCellsExample = new DeleteColumnCellsExample(); - deleteColumnCellsExample.deleteColumnCells(projectId, instanceId, TABLE_ID); + DeleteFromColumnExample deleteFromColumnExample = new DeleteFromColumnExample(); + deleteFromColumnExample.deleteFromColumnCells(projectId, instanceId, TABLE_ID); row = bigtableDataClient.readRow(TABLE_ID, rowKey); List cellsAfterDelete = row.getCells(COLUMN_FAMILY_NAME_PLAN, qualifier); @@ -78,8 +78,8 @@ public void test2_testDeleteFromRow() throws IOException { Truth.assertThat(row).isNotNull(); - DeleteRowExample deleteRowExample = new DeleteRowExample(); - deleteRowExample.deleteRow(projectId, instanceId, TABLE_ID); + DeleteFromRowExample deleteFromRowExample = new DeleteFromRowExample(); + deleteFromRowExample.deleteFromRow(projectId, instanceId, TABLE_ID); row = bigtableDataClient.readRow(TABLE_ID, rowKey); Truth.assertThat(row).isNull(); @@ -143,15 +143,16 @@ public void test5_testDropRowRange() throws IOException { } @Test - public void test6_testDeleteColumnFamily() throws IOException { + public void test6_testDeleteFromColumnFamily() throws IOException { String rowKey = "phone#5c10102#20190501"; Row row = bigtableDataClient.readRow(TABLE_ID, rowKey); List cells = row.getCells(COLUMN_FAMILY_NAME_STATS); Truth.assertThat(cells).isNotEmpty(); - DeleteColumnFamilyExample deleteColumnFamilyExample = new DeleteColumnFamilyExample(); - deleteColumnFamilyExample.deleteColumnFamily(projectId, instanceId, TABLE_ID); + DeleteFromColumnFamilyExample deleteFromColumnFamilyExample = + new DeleteFromColumnFamilyExample(); + deleteFromColumnFamilyExample.deleteFromColumnFamily(projectId, instanceId, TABLE_ID); row = bigtableDataClient.readRow(TABLE_ID, rowKey); List cellsAfterDelete = row.getCells(COLUMN_FAMILY_NAME_STATS); @@ -159,7 +160,21 @@ public void test6_testDeleteColumnFamily() throws IOException { } @Test - public void test7_testDeleteTable() throws IOException { + public void test7_testDeleteColumnFamily() throws IOException { + try (BigtableTableAdminClient tableAdminClient = + BigtableTableAdminClient.create(projectId, instanceId)) { + Truth.assertThat(tableAdminClient.getTable(TABLE_ID).getColumnFamilies().size()).isEqualTo(2); + + DeleteColumnFamilyExample deleteColumnFamilyExample = new DeleteColumnFamilyExample(); + deleteColumnFamilyExample.deleteColumnFamily( + projectId, instanceId, TABLE_ID, COLUMN_FAMILY_NAME_STATS); + + Truth.assertThat(tableAdminClient.getTable(TABLE_ID).getColumnFamilies().size()).isEqualTo(1); + } + } + + @Test + public void test8_testDeleteTable() throws IOException { try (BigtableTableAdminClient tableAdminClient = BigtableTableAdminClient.create(projectId, instanceId)) { Truth.assertThat(tableAdminClient.exists(TABLE_ID)).isTrue();