From 29b8a7f179bf1fcd125f211353ef95021c0142d8 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Tue, 21 Jul 2020 21:37:37 +0530 Subject: [PATCH] docs(samples): add query destination table with encryption key (#576) --- .../bigquery/QueryDestinationTableCMEK.java | 65 +++++++++++++ .../bigquery/QueryDestinationTableCMEKIT.java | 93 +++++++++++++++++++ 2 files changed, 158 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/QueryDestinationTableCMEK.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/QueryDestinationTableCMEKIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryDestinationTableCMEK.java b/samples/snippets/src/main/java/com/example/bigquery/QueryDestinationTableCMEK.java new file mode 100644 index 000000000..82b37433a --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/QueryDestinationTableCMEK.java @@ -0,0 +1,65 @@ +/* + * 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_query_destination_table_cmek] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.EncryptionConfiguration; +import com.google.cloud.bigquery.QueryJobConfiguration; +import com.google.cloud.bigquery.TableResult; + +// Sample to query on destination table with encryption key +public class QueryDestinationTableCMEK { + + public static void runQueryDestinationTableCMEK() { + // TODO(developer): Replace these variables before running the sample. + String datasetName = "MY_DATASET_NAME"; + String tableName = "MY_TABLE_NAME"; + String kmsKeyName = "MY_KMS_KEY_NAME"; + String query = + String.format("SELECT stringField, booleanField FROM %s.%s", datasetName, tableName); + EncryptionConfiguration encryption = + EncryptionConfiguration.newBuilder().setKmsKeyName(kmsKeyName).build(); + queryDestinationTableCMEK(query, encryption); + } + + public static void queryDestinationTableCMEK(String query, EncryptionConfiguration encryption) { + 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(); + + QueryJobConfiguration config = + QueryJobConfiguration.newBuilder(query) + // Set the encryption key to use for the destination. + .setDestinationEncryptionConfiguration(encryption) + .build(); + + TableResult results = bigquery.query(config); + + results + .iterateAll() + .forEach(row -> row.forEach(val -> System.out.printf("%s,", val.toString()))); + System.out.println("Query performed successfully with encryption key."); + } catch (BigQueryException | InterruptedException e) { + System.out.println("Query not performed \n" + e.toString()); + } + } +} +// [END bigquery_query_destination_table_cmek] diff --git a/samples/snippets/src/test/java/com/example/bigquery/QueryDestinationTableCMEKIT.java b/samples/snippets/src/test/java/com/example/bigquery/QueryDestinationTableCMEKIT.java new file mode 100644 index 000000000..f4e0669d3 --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/QueryDestinationTableCMEKIT.java @@ -0,0 +1,93 @@ +/* + * 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; + +import static com.google.common.truth.Truth.assertThat; +import static junit.framework.TestCase.assertNotNull; + +import com.google.cloud.bigquery.EncryptionConfiguration; +import com.google.cloud.bigquery.Field; +import com.google.cloud.bigquery.Schema; +import com.google.cloud.bigquery.StandardSQLTypeName; +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 QueryDestinationTableCMEKIT { + + private String tableName; + private EncryptionConfiguration encryption; + private ByteArrayOutputStream bout; + private PrintStream out; + + private static final String BIGQUERY_DATASET_NAME = requireEnvVar("BIGQUERY_DATASET_NAME"); + private static final String BIGQUERY_KMS_KEY_NAME = requireEnvVar("BIGQUERY_KMS_KEY_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"); + requireEnvVar("BIGQUERY_KMS_KEY_NAME"); + } + + @Before + public void setUp() { + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + + // create a test table with encryption key + tableName = "MY_TABLE_CMEK_TEST" + UUID.randomUUID().toString().substring(0, 8); + Schema schema = + Schema.of( + Field.of("stringField", StandardSQLTypeName.STRING), + Field.of("booleanField", StandardSQLTypeName.BOOL)); + encryption = EncryptionConfiguration.newBuilder().setKmsKeyName(BIGQUERY_KMS_KEY_NAME).build(); + CreateTableCMEK.createTableCMEK(BIGQUERY_DATASET_NAME, tableName, schema, encryption); + + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + // Clean up + DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, tableName); + System.setOut(null); + } + + @Test + public void testQueryDestinationTableCMEK() { + String query = + String.format( + "SELECT stringField, booleanField FROM %s.%s", BIGQUERY_DATASET_NAME, tableName); + QueryDestinationTableCMEK.queryDestinationTableCMEK(query, encryption); + assertThat(bout.toString()).contains("Query performed successfully with encryption key."); + } +}