docs(samples): add create external table using hivepartitioningoptions (#969)

Praful Makani · web-flow · commit 3994be62b63b · 2020-11-24T17:38:42.000-05:00
diff --git a/samples/snippets/src/main/java/com/example/bigquery/SetHivePartitioningOptions.java b/samples/snippets/src/main/java/com/example/bigquery/SetHivePartitioningOptions.java
@@ -0,0 +1,70 @@
+/*
+ * 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_set_hivepartitioningoptions]
+import com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQueryException;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.ExternalTableDefinition;
+import com.google.cloud.bigquery.FormatOptions;
+import com.google.cloud.bigquery.HivePartitioningOptions;
+import com.google.cloud.bigquery.TableId;
+import com.google.cloud.bigquery.TableInfo;
+
+// Sample to create external table using hive partitioning
+public class SetHivePartitioningOptions {
+
+  public static void main(String[] args) {
+    // TODO(developer): Replace these variables before running the sample.
+    String datasetName = "MY_DATASET_NAME";
+    String tableName = "MY_TABLE_NAME";
+    String sourceUri = "gs://cloud-samples-data/bigquery/hive-partitioning-samples/customlayout/*";
+    String sourceUriPrefix =
+        "gs://cloud-samples-data/bigquery/hive-partitioning-samples/customlayout/{pkey:STRING}/";
+    setHivePartitioningOptions(datasetName, tableName, sourceUriPrefix, sourceUri);
+  }
+
+  public static void setHivePartitioningOptions(
+      String datasetName, String tableName, String sourceUriPrefix, String sourceUri) {
+    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();
+
+      // Configuring partitioning options
+      HivePartitioningOptions hivePartitioningOptions =
+          HivePartitioningOptions.newBuilder()
+              .setMode("CUSTOM")
+              .setRequirePartitionFilter(true)
+              .setSourceUriPrefix(sourceUriPrefix)
+              .build();
+
+      TableId tableId = TableId.of(datasetName, tableName);
+      ExternalTableDefinition customTable =
+          ExternalTableDefinition.newBuilder(sourceUri, FormatOptions.parquet())
+              .setAutodetect(true)
+              .setHivePartitioningOptions(hivePartitioningOptions)
+              .build();
+      bigquery.create(TableInfo.of(tableId, customTable));
+      System.out.println("External table created using hivepartitioningoptions");
+    } catch (BigQueryException e) {
+      System.out.println("External table was not created" + e.toString());
+    }
+  }
+}
+// [END bigquery_set_hivepartitioningoptions]
diff --git a/samples/snippets/src/test/java/com/example/bigquery/SetHivePartitioningOptionsIT.java b/samples/snippets/src/test/java/com/example/bigquery/SetHivePartitioningOptionsIT.java
@@ -0,0 +1,85 @@
+/*
+ * 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 java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.util.UUID;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class SetHivePartitioningOptionsIT {
+
+  private static final String ID = UUID.randomUUID().toString().substring(0, 8);
+  private final Logger log = Logger.getLogger(this.getClass().getName());
+  private String tableName;
+  private ByteArrayOutputStream bout;
+  private PrintStream out;
+  private PrintStream originalPrintStream;
+
+  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() {
+    // Create a test table
+    tableName = "SET_HIVEPARTITIONINGOPTIONS_FROM_GCS_TEST_" + ID;
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    originalPrintStream = System.out;
+    System.setOut(out);
+  }
+
+  @After
+  public void tearDown() {
+    // Clean up
+    DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, tableName);
+    // restores print statements in the original method
+    System.out.flush();
+    System.setOut(originalPrintStream);
+    log.log(Level.INFO, bout.toString());
+  }
+
+  @Test
+  public void testSetHivePartitioningOptions() {
+    String sourceUri = "gs://cloud-samples-data/bigquery/hive-partitioning-samples/customlayout/*";
+    String sourceUriPrefix =
+        "gs://cloud-samples-data/bigquery/hive-partitioning-samples/customlayout/{pkey:STRING}/";
+    SetHivePartitioningOptions.setHivePartitioningOptions(
+        BIGQUERY_DATASET_NAME, tableName, sourceUriPrefix, sourceUri);
+    assertThat(bout.toString()).contains("External table created using hivepartitioningoptions");
+  }
+}
