docs(samples): add load json table with encryption key from gcs (#575)

Author: Praful Makani

samples/snippets/src/main/java/com/example/bigquery/LoadJsonFromGCSCMEK.java

@@ -0,0 +1,77 @@
+/*
+ * 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_load_table_gcs_json_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.FormatOptions;
+import com.google.cloud.bigquery.Job;
+import com.google.cloud.bigquery.JobInfo;
+import com.google.cloud.bigquery.LoadJobConfiguration;
+import com.google.cloud.bigquery.TableId;
+
+// Sample to load JSON data with configuration key from Cloud Storage into a new BigQuery table
+public class LoadJsonFromGCSCMEK {
+
+ public static void runLoadJsonFromGCSCMEK() {
+ // 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 sourceUri = "gs://cloud-samples-data/bigquery/us-states/us-states.json";
+ // i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}
+ EncryptionConfiguration encryption =
+ EncryptionConfiguration.newBuilder().setKmsKeyName(kmsKeyName).build();
+ loadJsonFromGCSCMEK(datasetName, tableName, sourceUri, encryption);
+ }
+
+ public static void loadJsonFromGCSCMEK(
+ String datasetName, String tableName, String sourceUri, 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();
+
+ TableId tableId = TableId.of(datasetName, tableName);
+ LoadJobConfiguration loadConfig =
+ LoadJobConfiguration.newBuilder(tableId, sourceUri)
+ // Set the encryption key to use for the destination.
+ .setDestinationEncryptionConfiguration(encryption)
+ .setFormatOptions(FormatOptions.json())
+ .setAutodetect(true)
+ .build();
+
+ // Load data from a GCS JSON file into the table
+ Job job = bigquery.create(JobInfo.of(loadConfig));
+ // Blocks until this load table job completes its execution, either failing or succeeding.
+ job = job.waitFor();
+ if (job.isDone()) {
+ System.out.println("Table loaded succesfully from GCS with configuration key");
+ } else {
+ System.out.println(
+ "BigQuery was unable to load into the table due to an error:"
+ + job.getStatus().getError());
+ }
+ } catch (BigQueryException | InterruptedException e) {
+ System.out.println("Column not added during load append \n" + e.toString());
+ }
+ }
+}
+// [END bigquery_load_table_gcs_json_cmek]

samples/snippets/src/test/java/com/example/bigquery/LoadJsonFromGCSCMEKIT.java

@@ -0,0 +1,80 @@
+/*
+ * 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 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 LoadJsonFromGCSCMEKIT {
+
+ private String tableName;
+ 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() {
+ tableName =
+ "MY_LOAD_JSON_TABLE_CMEK_FROM_GCS_TEST_" + UUID.randomUUID().toString().substring(0, 8);
+ 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 testLoadJsonFromGCSCMEK() {
+ String sourceUri = "gs://cloud-samples-data/bigquery/us-states/us-states.json";
+ EncryptionConfiguration configuration =
+ EncryptionConfiguration.newBuilder().setKmsKeyName(BIGQUERY_KMS_KEY_NAME).build();
+ LoadJsonFromGCSCMEK.loadJsonFromGCSCMEK(
+ BIGQUERY_DATASET_NAME, tableName, sourceUri, configuration);
+ assertThat(bout.toString())
+ .contains("Table loaded succesfully from GCS with configuration key");
+ }
+}