docs(samples): add query with positional type parameters (#634)

googleapis · Aug 3, 2020 · 208883c · 208883c
1 parent 082f1a2
commit 208883c
Show file tree

Hide file tree

Showing 2 changed files with 138 additions and 0 deletions.
diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryWithPositionalTypesParameters.java b/samples/snippets/src/main/java/com/example/bigquery/QueryWithPositionalTypesParameters.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_query_params_positional_types]
+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.QueryParameterValue;
+import com.google.cloud.bigquery.StandardSQLTypeName;
+import com.google.cloud.bigquery.TableResult;
+
+// Sample to run query with positional types parameters.
+public class QueryWithPositionalTypesParameters {
+
+  public static void runQueryWithPositionalTypesParameters() {
+    String[] words = {"and", "is", "the", "moon"};
+    String corpus = "romeoandjuliet";
+    Integer wordsCount = 250;
+    String query =
+        "SELECT word, word_count"
+            + " FROM `bigquery-public-data.samples.shakespeare`"
+            + " WHERE word IN UNNEST(?)"
+            + " AND corpus = ?"
+            + " AND word_count >= ?"
+            + " ORDER BY word_count DESC";
+    queryWithPositionalTypesParameters(query, words, corpus, wordsCount);
+  }
+
+  public static void queryWithPositionalTypesParameters(
+      String query, String[] words, String corpus, Integer wordsCount) {
+    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();
+
+      QueryParameterValue wordList = QueryParameterValue.array(words, StandardSQLTypeName.STRING);
+      QueryParameterValue corpusParam = QueryParameterValue.of(corpus, StandardSQLTypeName.STRING);
+      QueryParameterValue minWordCount =
+          QueryParameterValue.of(wordsCount, StandardSQLTypeName.INT64);
+
+      // Note: Standard SQL is required to use query parameters.
+      QueryJobConfiguration queryConfig =
+          QueryJobConfiguration.newBuilder(query)
+              .addPositionalParameter(wordList)
+              .addPositionalParameter(corpusParam)
+              .addPositionalParameter(minWordCount)
+              .build();
+
+      TableResult results = bigquery.query(queryConfig);
+
+      results
+          .iterateAll()
+          .forEach(row -> row.forEach(val -> System.out.printf("%s,", val.toString())));
+
+      System.out.println("Query with positional types parameters performed successfully.");
+    } catch (BigQueryException | InterruptedException e) {
+      System.out.println("Query not performed \n" + e.toString());
+    }
+  }
+}
+// [END bigquery_query_params_positional_types]
diff --git a/...les/snippets/src/test/java/com/example/bigquery/QueryWithPositionalTypesParametersIT.java b/...les/snippets/src/test/java/com/example/bigquery/QueryWithPositionalTypesParametersIT.java
@@ -0,0 +1,61 @@
+/*
+ * 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 java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+public class QueryWithPositionalTypesParametersIT {
+
+  private ByteArrayOutputStream bout;
+  private PrintStream out;
+
+  @Before
+  public void setUp() {
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    System.setOut(out);
+  }
+
+  @After
+  public void tearDown() {
+    System.setOut(null);
+  }
+
+  @Test
+  public void testQueryWithPositionalTypesParameters() {
+    String[] words = {"and", "is", "the", "moon"};
+    String corpus = "romeoandjuliet";
+    Integer wordsCount = 250;
+    String query =
+        "SELECT word, word_count"
+            + " FROM `bigquery-public-data.samples.shakespeare`"
+            + " WHERE word IN UNNEST(?)"
+            + " AND corpus = ?"
+            + " AND word_count >= ?"
+            + " ORDER BY word_count DESC";
+    QueryWithPositionalTypesParameters.queryWithPositionalTypesParameters(
+        query, words, corpus, wordsCount);
+    assertThat(bout.toString())
+        .contains("Query with positional types parameters performed successfully");
+  }
+}