bigquery: show base64 encode and records in insertAll snippets.

tswast · tswast · commit a6cc3f126844 · 2016-11-16T15:06:29.000-08:00
Showing a raw base64 string isn't great. Instead, show a way to encode
the bytes to a base64 string using Guava's BaseEncoding class.

Also, it wasn't clear how to insert values of type record, so show that,
too.
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java
@@ -790,7 +790,11 @@ public static QueryResultsOption maxWaitTime(long maxWaitTime) {
    * Map<String, Object> rowContent = new HashMap<>();
    * rowContent.put("booleanField", true);
    * // Bytes are passed in base64
-   * rowContent.put("bytesField", "DQ4KDQ==");
+   * rowContent.put("bytesField", BaseEncoding.base64().encode(new byte[]{0xA, 0xD, 0xD, 0xE, 0xD}));
+   * // Records are passed as a map
+   * Map<String, Object> recordsContent = new HashMap<>();
+   * recordsContent.put("stringField", "Hello, World!");
+   * rowContent.put("recordField", recordsContent);
    * InsertAllResponse response = bigquery.insertAll(InsertAllRequest.newBuilder(tableId)
    *     .addRow("rowId", rowContent)
    *     // More rows can be added in the same RPC by invoking .addRow() on the builder
@@ -1014,15 +1018,16 @@ Page<List<FieldValue>> listTableData(String datasetId, String tableId,
    *     WriteChannelConfiguration.newBuilder(tableId)
    *         .setFormatOptions(FormatOptions.csv())
    *         .build();
-   * BaseWriteChannel<BigQueryOptions, WriteChannelConfiguration> writer =
-   *     bigquery.writer(writeChannelConfiguration);
+   * TableDataWriteChannel writer = bigquery.writer(writeChannelConfiguration);
    * // Write data to writer
    * try {
    *   writer.write(ByteBuffer.wrap(csvData.getBytes(Charsets.UTF_8)));
    * } catch (IOException e) {
    *   // Unable to write data
    * }
    * writer.close();
+   * // Get load job
+   * Job job = writer.getJob();
    * }</pre>
    *
    * @throws BigQueryException upon failure
diff --git a/google-cloud-examples/src/main/java/com/google/cloud/examples/bigquery/snippets/BigQuerySnippets.java b/google-cloud-examples/src/main/java/com/google/cloud/examples/bigquery/snippets/BigQuerySnippets.java
@@ -56,6 +56,7 @@
 import com.google.cloud.bigquery.TableId;
 import com.google.cloud.bigquery.TableInfo;
 import com.google.cloud.bigquery.WriteChannelConfiguration;
+import com.google.common.io.BaseEncoding;
 
 import java.io.IOException;
 import java.nio.ByteBuffer;
@@ -366,7 +367,11 @@ public InsertAllResponse insertAll(String datasetName, String tableName) {
     Map<String, Object> rowContent = new HashMap<>();
     rowContent.put("booleanField", true);
     // Bytes are passed in base64
-    rowContent.put("bytesField", "DQ4KDQ==");
+    rowContent.put("bytesField", BaseEncoding.base64().encode(new byte[]{0xA, 0xD, 0xD, 0xE, 0xD}));
+    // Records are passed as a map
+    Map<String, Object> recordsContent = new HashMap<>();
+    recordsContent.put("stringField", "Hello, World!");
+    rowContent.put("recordField", recordsContent);
     InsertAllResponse response = bigquery.insertAll(InsertAllRequest.newBuilder(tableId)
         .addRow("rowId", rowContent)
         // More rows can be added in the same RPC by invoking .addRow() on the builder
diff --git a/google-cloud-examples/src/test/java/com/google/cloud/examples/bigquery/snippets/ITBigQuerySnippets.java b/google-cloud-examples/src/test/java/com/google/cloud/examples/bigquery/snippets/ITBigQuerySnippets.java
@@ -192,9 +192,14 @@ public void testInsertAllAndListTableData() throws IOException, InterruptedExcep
     String tableName = "test_insert_all_and_list_table_data";
     String fieldName1 = "booleanField";
     String fieldName2 = "bytesField";
+    String fieldName3 = "recordField";
+    String fieldName4 = "stringField";
     TableId tableId = TableId.of(DATASET, tableName);
     Schema schema =
-        Schema.of(Field.of(fieldName1, Type.bool()), Field.of(fieldName2, Type.bytes()));
+        Schema.of(
+            Field.of(fieldName1, Type.bool()),
+            Field.of(fieldName2, Type.bytes()),
+            Field.of(fieldName3, Type.record(Field.of(fieldName4, Type.string()))));
     TableInfo table = TableInfo.of(tableId, StandardTableDefinition.of(schema));
     assertNotNull(bigquery.create(table));
     InsertAllResponse response = bigquerySnippets.insertAll(DATASET, tableName);
@@ -207,7 +212,8 @@ public void testInsertAllAndListTableData() throws IOException, InterruptedExcep
     }
     List<FieldValue> row = listPage.getValues().iterator().next();
     assertEquals(true, row.get(0).getBooleanValue());
-    assertArrayEquals(new byte[]{0xD, 0xE, 0xA, 0xD}, row.get(1).getBytesValue());
+    assertArrayEquals(new byte[]{0xA, 0xD, 0xD, 0xE, 0xD}, row.get(1).getBytesValue());
+    assertEquals("Hello, World!", row.get(2).getRecordValue().get(0).getStringValue());
     assertTrue(bigquerySnippets.deleteTable(DATASET, tableName));
   }
 
