From a6d94913f74a6b4d29e9314a0652a9e3fa30aed9 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Tue, 14 Jul 2020 02:41:07 +0530 Subject: [PATCH] docs(samples): add get table labels (#540) --- .../com/example/bigquery/GetTableLabels.java | 52 +++++++++++++++ .../example/bigquery/GetTableLabelsIT.java | 64 +++++++++++++++++++ 2 files changed, 116 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/GetTableLabels.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/GetTableLabelsIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/GetTableLabels.java b/samples/snippets/src/main/java/com/example/bigquery/GetTableLabels.java new file mode 100644 index 000000000..e3ef02b9b --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/GetTableLabels.java @@ -0,0 +1,52 @@ +/* + * Copyright 2020 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.bigquery; + +// [START bigquery_get_table_labels] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.Table; +import com.google.cloud.bigquery.TableId; + +// Sample to get table labels +public class GetTableLabels { + + public static void runGetTableLabels() { + // TODO(developer): Replace these variables before running the sample. + String datasetName = "MY_DATASET_NAME"; + String tableName = "MY_TABLE_NAME"; + getTableLabels(datasetName, tableName); + } + + public static void getTableLabels(String datasetName, String tableName) { + try { + // Initialize client that will be used to send requests. This client only needs to be created + // once, and can be reused for multiple requests. + BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService(); + + // This example table starts with existing label { color: 'green' } + Table table = bigquery.getTable(TableId.of(datasetName, tableName)); + table + .getLabels() + .forEach((key, value) -> System.out.println("Retrieved labels successfully")); + } catch (BigQueryException e) { + System.out.println("Label was not deleted. \n" + e.toString()); + } + } +} +// [END bigquery_get_table_labels] diff --git a/samples/snippets/src/test/java/com/example/bigquery/GetTableLabelsIT.java b/samples/snippets/src/test/java/com/example/bigquery/GetTableLabelsIT.java new file mode 100644 index 000000000..11de46c39 --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/GetTableLabelsIT.java @@ -0,0 +1,64 @@ +package com.example.bigquery; + +import static com.google.common.truth.Truth.assertThat; +import static org.junit.Assert.assertNotNull; + +import com.google.cloud.bigquery.Schema; +import java.io.ByteArrayOutputStream; +import java.io.PrintStream; +import java.util.UUID; +import org.junit.After; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; + +public class GetTableLabelsIT { + + private String tableName; + private ByteArrayOutputStream bout; + private PrintStream out; + + private static final String BIGQUERY_DATASET_NAME = requireEnvVar("BIGQUERY_DATASET_NAME"); + + private static String requireEnvVar(String varName) { + String value = System.getenv(varName); + assertNotNull( + "Environment variable " + varName + " is required to perform these tests.", + System.getenv(varName)); + return value; + } + + @BeforeClass + public static void checkRequirements() { + requireEnvVar("BIGQUERY_DATASET_NAME"); + } + + @Before + public void setUp() { + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + // create a temporary table + tableName = "MY_TABLE_TEST_" + UUID.randomUUID().toString().substring(0, 8); + CreateTable.createTable(BIGQUERY_DATASET_NAME, tableName, Schema.of()); + // add label on a table + LabelTable.labelTable(BIGQUERY_DATASET_NAME, tableName); + + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + // delete a temporary table + DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, tableName); + System.setOut(null); + } + + @Test + public void testGetTableLabels() { + GetTableLabels.getTableLabels(BIGQUERY_DATASET_NAME, tableName); + assertThat(bout.toString()).contains("Retrieved labels successfully"); + } +}