docs(samples): add update table require partition filter (#624)

Author: Praful Makani

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

@@ -0,0 +1,50 @@
+/*
+ * 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_update_table_require_partition_filter]
+import com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQueryException;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.Table;
+
+// Sample to update require partition filter on a table.
+public class UpdateTableRequirePartitionFilter {
+
+ public static void runUpdateTableRequirePartitionFilter() {
+ // TODO(developer): Replace these variables before running the sample.
+ String datasetName = "MY_DATASET_NAME";
+ String tableName = "MY_TABLE_NAME";
+ updateTableRequirePartitionFilter(datasetName, tableName);
+ }
+
+ public static void updateTableRequirePartitionFilter(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();
+
+ Table table = bigquery.getTable(datasetName, tableName);
+ table.toBuilder().setRequirePartitionFilter(true).build().update();
+
+ System.out.println("Table require partition filter updated successfully");
+ } catch (BigQueryException e) {
+ System.out.println("Table require partition filter was not updated \n" + e.toString());
+ }
+ }
+}
+// [END bigquery_update_table_require_partition_filter]

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

@@ -0,0 +1,89 @@
+/*
+ * 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.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 UpdateTableRequirePartitionFilterIT {
+
+ 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);
+
+ tableName =
+ "UPDATE_TABLE_REQUIRE_PARTITION_FILTER_TEST_"
+ + UUID.randomUUID().toString().substring(0, 8);
+ // Create a table in order to modify its partition filter.
+ Schema schema =
+ Schema.of(
+ Field.of("name", StandardSQLTypeName.STRING),
+ Field.of("post_abbr", StandardSQLTypeName.STRING),
+ Field.of("date", StandardSQLTypeName.DATE));
+ CreatePartitionedTable.createPartitionedTable(BIGQUERY_DATASET_NAME, tableName, schema);
+
+ 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 testUpdateTableRequirePartitionFilter() {
+ UpdateTableRequirePartitionFilter.updateTableRequirePartitionFilter(
+ BIGQUERY_DATASET_NAME, tableName);
+ assertThat(bout.toString()).contains("Table require partition filter updated successfully");
+ }
+}