docs(samples): add query materialized view (#978)

Praful Makani · web-flow · commit cf36b82ef9bc · 2020-12-01T12:05:21.000-05:00
* docs(samples): add query materialized view

* docs(samples): address feedback
diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryMaterializedView.java b/samples/snippets/src/main/java/com/example/bigquery/QueryMaterializedView.java
@@ -0,0 +1,51 @@
+/*
+ * 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 com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQueryException;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.QueryJobConfiguration;
+import com.google.cloud.bigquery.TableResult;
+
+public class QueryMaterializedView {
+
+  public static void main(String[] args) throws InterruptedException {
+    // TODO(developer): Replace these variables before running the sample.
+    String datasetName = "MY_DATASET_NAME";
+    String materializedViewName = "MY_MATERIALIZED_VIEW_NAME";
+    String query = String.format("SELECT * FROM %s.%s", datasetName, materializedViewName);
+    queryMaterializedView(query);
+  }
+
+  public static void queryMaterializedView(String query) throws InterruptedException {
+    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();
+
+      TableResult results = bigquery.query(QueryJobConfiguration.of(query));
+      results
+          .iterateAll()
+          .forEach(row -> row.forEach(val -> System.out.printf("%s\n", val.toString())));
+
+      System.out.println("Query performed successfully.");
+    } catch (BigQueryException e) {
+      System.out.println("Query was not performed. \n" + e.toString());
+    }
+  }
+}
diff --git a/samples/snippets/src/test/java/com/example/bigquery/QueryMaterializedViewIT.java b/samples/snippets/src/test/java/com/example/bigquery/QueryMaterializedViewIT.java
@@ -0,0 +1,104 @@
+/*
+ * 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 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 QueryMaterializedViewIT {
+
+  private static final String ID = UUID.randomUUID().toString().substring(0, 8);
+  private final Logger log = Logger.getLogger(this.getClass().getName());
+  private String tableName;
+  private String materializedViewName;
+  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() {
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    originalPrintStream = System.out;
+    System.setOut(out);
+
+    tableName = "MY_TABLE_NAME_TEST_" + ID;
+    materializedViewName = "MY_QUERY_MATERIALIZED_VIEW_NAME_TEST_" + ID;
+
+    Schema schema =
+        Schema.of(
+            Field.of("timestampField", StandardSQLTypeName.TIMESTAMP),
+            Field.of("stringField", StandardSQLTypeName.STRING),
+            Field.of("booleanField", StandardSQLTypeName.BOOL));
+    CreateTable.createTable(BIGQUERY_DATASET_NAME, tableName, schema);
+    String query =
+        String.format(
+            "SELECT MAX(TimestampField) AS TimestampField, StringField, "
+                + "MAX(BooleanField) AS BooleanField "
+                + "FROM %s.%s GROUP BY StringField",
+            BIGQUERY_DATASET_NAME, tableName);
+    CreateMaterializedView.createMaterializedView(
+        BIGQUERY_DATASET_NAME, materializedViewName, query);
+  }
+
+  @After
+  public void tearDown() {
+    // Clean up
+    DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, materializedViewName);
+    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 testQueryMaterializedView() throws InterruptedException {
+    String query =
+        String.format("SELECT * FROM %s.%s", BIGQUERY_DATASET_NAME, materializedViewName);
+    QueryMaterializedView.queryMaterializedView(query);
+    assertThat(bout.toString()).contains("Query performed successfully.");
+  }
+}
