Example of checking if the table exists. + *
{@code
+ * boolean exists = table.exists();
+ * if (exists) {
+ * // the table exists
+ * } else {
+ * // the table was not found
+ * }
+ * }
+ *
* @return {@code true} if this table exists, {@code false} otherwise
* @throws BigQueryException upon failure
*/
@@ -149,6 +159,17 @@ public boolean exists() {
/**
* Fetches current table's latest information. Returns {@code null} if the table does not exist.
*
+ * Example of fetching the table's latest information, specifying particular table fields to + * get. + *
{@code
+ * TableField field1 = TableField.LAST_MODIFIED_TIME;
+ * TableField field2 = TableField.NUM_ROWS;
+ * Table latestTable = table.reload(TableOption.fields(field1, field2));
+ * if (latestTable == null) {
+ * // the table was not found
+ * }
+ * }
+ *
* @param options table options
* @return a {@code Table} object with latest information or {@code null} if not found
* @throws BigQueryException upon failure
@@ -161,6 +182,11 @@ public Table reload(TableOption... options) {
* Updates the table's information with this table's information. Dataset's and table's
* user-defined ids cannot be changed. A new {@code Table} object is returned.
*
+ * Example of updating the table's information. + *
{@code
+ * Table updatedTable = table.toBuilder().description("new description").build().update();
+ * }
+ *
* @param options dataset options
* @return a {@code Table} object with updated information
* @throws BigQueryException upon failure
@@ -172,6 +198,16 @@ public Table update(TableOption... options) {
/**
* Deletes this table.
*
+ * Example of deleting the table. + *
{@code
+ * boolean deleted = table.delete();
+ * if (deleted) {
+ * // the table was deleted
+ * } else {
+ * // the table was not found
+ * }
+ * }
+ *
* @return {@code true} if table was deleted, {@code false} if it was not found
* @throws BigQueryException upon failure
*/
@@ -182,6 +218,23 @@ public boolean delete() {
/**
* Insert rows into the table.
*
+ * Example of inserting rows into the table. + *
{@code
+ * String rowId1 = "rowId1";
+ * String rowId2 = "rowId2";
+ * List rows = new ArrayList<>();
+ * Map row1 = new HashMap<>();
+ * row1.put("stringField", "value1");
+ * row1.put("booleanField", true);
+ * Map row2 = new HashMap<>();
+ * row2.put("stringField", "value2");
+ * row2.put("booleanField", false);
+ * rows.add(RowToInsert.of(rowId1, row1));
+ * rows.add(RowToInsert.of(rowId2, row2));
+ * InsertAllResponse response = table.insert(rows);
+ * // do something with response
+ * }
+ *
* @param rows rows to be inserted
* @throws BigQueryException upon failure
*/
@@ -193,6 +246,23 @@ public InsertAllResponse insert(IterableExample of inserting rows into the table, ignoring invalid rows. + *
{@code
+ * String rowId1 = "rowId1";
+ * String rowId2 = "rowId2";
+ * List rows = new ArrayList<>();
+ * Map row1 = new HashMap<>();
+ * row1.put("stringField", 1);
+ * row1.put("booleanField", true);
+ * Map row2 = new HashMap<>();
+ * row2.put("stringField", "value2");
+ * row2.put("booleanField", false);
+ * rows.add(RowToInsert.of(rowId1, row1));
+ * rows.add(RowToInsert.of(rowId2, row2));
+ * InsertAllResponse response = table.insert(rows, true, true);
+ * // do something with response
+ * }
+ *
* @param rows rows to be inserted
* @param skipInvalidRows whether to insert all valid rows, even if invalid rows exist. If not set
* the entire insert operation will fail if rows to be inserted contain an invalid row
@@ -202,7 +272,7 @@ public InsertAllResponse insert(IterableExample of listing rows in the table. + *
{@code
+ * Page> page = table.list(TableDataListOption.pageSize(100));
+ * Iterator> rowIterator = page.iterateAll();
+ * while (rowIterator.hasNext()) {
+ * List row = rowIterator.next();
+ * // do something with the row
+ * }
+ * }
+ *
* @param options table data list options
* @throws BigQueryException upon failure
*/
@@ -225,6 +305,25 @@ public PageExample of copying the table to a destination table. + *
{@code
+ * String datasetName = "my_dataset";
+ * String tableName = "my_destination_table";
+ * Job job = table.copy(datasetName, tableName);
+ * // Wait for the job to complete.
+ * try {
+ * Job completedJob = job.waitFor(WaitForOption.checkEvery(1, TimeUnit.SECONDS),
+ * WaitForOption.timeout(3, TimeUnit.MINUTES));
+ * if (completedJob != null && completedJob.status().error() == null) {
+ * // Job completed successfully
+ * } else {
+ * // Handle error case
+ * }
+ * } catch (InterruptedException | TimeoutException e) {
+ * // Handle interrupted wait
+ * }
+ * }
+ *
* @param destinationDataset the user-defined id of the destination dataset
* @param destinationTable the user-defined id of the destination table
* @param options job options
@@ -239,6 +338,27 @@ public Job copy(String destinationDataset, String destinationTable, JobOption...
* Starts a BigQuery Job to copy the current table to the provided destination table. Returns the
* started {@link Job} object.
*
+ * Example copying the table to a destination table. + *
{@code
+ * String dataset = "my_dataset";
+ * String tableName = "my_destination_table";
+ * TableId destinationId = TableId.of(dataset, tableName);
+ * JobOption options = JobOption.fields(JobField.STATUS, JobField.USER_EMAIL);
+ * Job job = table.copy(destinationId, options);
+ * // Wait for the job to complete.
+ * try {
+ * Job completedJob = job.waitFor(WaitForOption.checkEvery(1, TimeUnit.SECONDS),
+ * WaitForOption.timeout(3, TimeUnit.MINUTES));
+ * if (completedJob != null && completedJob.status().error() == null) {
+ * // Job completed successfully.
+ * } else {
+ * // Handle error case.
+ * }
+ * } catch (InterruptedException | TimeoutException e) {
+ * // Handle interrupted wait
+ * }
+ * }
+ *
* @param destinationTable the destination table of the copy job
* @param options job options
* @throws BigQueryException upon failure
@@ -253,6 +373,25 @@ public Job copy(TableId destinationTable, JobOption... options)
* Starts a BigQuery Job to extract the current table to the provided destination URI. Returns the
* started {@link Job} object.
*
+ * Example extracting data to single Google Cloud Storage file. + *
{@code
+ * String format = "CSV";
+ * String gcsUrl = "gs://my_bucket/filename.csv";
+ * Job job = table.extract(format, gcsUrl);
+ * // Wait for the job to complete
+ * try {
+ * Job completedJob = job.waitFor(WaitForOption.checkEvery(1, TimeUnit.SECONDS),
+ * WaitForOption.timeout(3, TimeUnit.MINUTES));
+ * if (completedJob != null && completedJob.status().error() == null) {
+ * // Job completed successfully
+ * } else {
+ * // Handle error case
+ * }
+ * } catch (InterruptedException | TimeoutException e) {
+ * // Handle interrupted wait
+ * }
+ * }
+ *
* @param format the format of the extracted data
* @param destinationUri the fully-qualified Google Cloud Storage URI (e.g. gs://bucket/path)
* where the extracted table should be written
@@ -268,6 +407,29 @@ public Job extract(String format, String destinationUri, JobOption... options)
* Starts a BigQuery Job to extract the current table to the provided destination URIs. Returns
* the started {@link Job} object.
*
+ * Example of partitioning data to a list of Google Cloud Storage files. + *
{@code
+ * String format = "CSV";
+ * String gcsUrl1 = "gs://my_bucket/PartitionA_*.csv";
+ * String gcsUrl2 = "gs://my_bucket/PartitionB_*.csv";
+ * List destinationUris = new ArrayList<>();
+ * destinationUris.add(gcsUrl1);
+ * destinationUris.add(gcsUrl2);
+ * Job job = table.extract(format, destinationUris);
+ * // Wait for the job to complete
+ * try {
+ * Job completedJob = job.waitFor(WaitForOption.checkEvery(1, TimeUnit.SECONDS),
+ * WaitForOption.timeout(3, TimeUnit.MINUTES));
+ * if (completedJob != null && completedJob.status().error() == null) {
+ * // Job completed successfully
+ * } else {
+ * // Handle error case
+ * }
+ * } catch (InterruptedException | TimeoutException e) {
+ * // Handle interrupted wait
+ * }
+ * }
+ *
* @param format the format of the exported data
* @param destinationUris the fully-qualified Google Cloud Storage URIs (e.g. gs://bucket/path)
* where the extracted table should be written
@@ -285,6 +447,24 @@ public Job extract(String format, ListExample loading data from a single Google Cloud Storage file. + *
{@code
+ * String sourceUri = "gs://my_bucket/filename.csv";
+ * Job job = table.load(FormatOptions.csv(), sourceUri);
+ * // Wait for the job to complete
+ * try {
+ * Job completedJob = job.waitFor(WaitForOption.checkEvery(1, TimeUnit.SECONDS),
+ * WaitForOption.timeout(3, TimeUnit.MINUTES));
+ * if (completedJob != null && completedJob.status().error() == null) {
+ * // Job completed successfully
+ * } else {
+ * // Handle error case
+ * }
+ * } catch (InterruptedException | TimeoutException e) {
+ * // Handle interrupted wait
+ * }
+ * }
+ *
* @param format the format of the data to load
* @param sourceUri the fully-qualified Google Cloud Storage URI (e.g. gs://bucket/path) from
* which to load the data
@@ -300,6 +480,28 @@ public Job load(FormatOptions format, String sourceUri, JobOption... options)
* Starts a BigQuery Job to load data into the current table from the provided source URIs.
* Returns the started {@link Job} object.
*
+ * Example loading data from a list of Google Cloud Storage files. + *
{@code
+ * String gcsUrl1 = "gs://my_bucket/filename1.csv";
+ * String gcsUrl2 = "gs://my_bucket/filename2.csv";
+ * List sourceUris = new ArrayList<>();
+ * sourceUris.add(gcsUrl1);
+ * sourceUris.add(gcsUrl2);
+ * Job job = table.load(FormatOptions.csv(), sourceUris);
+ * // Wait for the job to complete
+ * try {
+ * Job completedJob = job.waitFor(WaitForOption.checkEvery(1, TimeUnit.SECONDS),
+ * WaitForOption.timeout(3, TimeUnit.MINUTES));
+ * if (completedJob != null && completedJob.status().error() == null) {
+ * // Job completed successfully
+ * } else {
+ * // Handle error case
+ * }
+ * } catch (InterruptedException | TimeoutException e) {
+ * // Handle interrupted wait
+ * }
+ * }
+ *
* @param format the format of the exported data
* @param sourceUris the fully-qualified Google Cloud Storage URIs (e.g. gs://bucket/path) from
* which to load the data
diff --git a/google-cloud-examples/src/main/java/com/google/cloud/examples/bigquery/snippets/TableSnippets.java b/google-cloud-examples/src/main/java/com/google/cloud/examples/bigquery/snippets/TableSnippets.java
new file mode 100644
index 000000000000..c169f6badf58
--- /dev/null
+++ b/google-cloud-examples/src/main/java/com/google/cloud/examples/bigquery/snippets/TableSnippets.java
@@ -0,0 +1,340 @@
+/*
+ * Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * 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.
+ */
+
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in Table’s javadoc. Any change to this file should be reflected in
+ * Table’s javadoc.
+ */
+
+package com.google.cloud.examples.bigquery.snippets;
+
+import com.google.cloud.Page;
+import com.google.cloud.WaitForOption;
+import com.google.cloud.bigquery.BigQuery.JobField;
+import com.google.cloud.bigquery.BigQuery.JobOption;
+import com.google.cloud.bigquery.BigQuery.TableDataListOption;
+import com.google.cloud.bigquery.BigQuery.TableField;
+import com.google.cloud.bigquery.BigQuery.TableOption;
+import com.google.cloud.bigquery.BigQueryException;
+import com.google.cloud.bigquery.FieldValue;
+import com.google.cloud.bigquery.FormatOptions;
+import com.google.cloud.bigquery.InsertAllRequest.RowToInsert;
+import com.google.cloud.bigquery.InsertAllResponse;
+import com.google.cloud.bigquery.Job;
+import com.google.cloud.bigquery.Table;
+import com.google.cloud.bigquery.TableId;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+
+/**
+ * This class contains a number of snippets for the {@link Table} class.
+ */
+public class TableSnippets {
+
+ private final Table table;
+
+ public TableSnippets(Table table) {
+ this.table = table;
+ }
+
+ /**
+ * Example of checking if the table exists.
+ */
+ // [TARGET exists()]
+ public boolean exists() {
+ // [START exists]
+ boolean exists = table.exists();
+ if (exists) {
+ // the table exists
+ } else {
+ // the table was not found
+ }
+ // [END exists]
+ return exists;
+ }
+
+ /**
+ * Example of fetching the table's latest information, specifying particular table fields to
+ * get.
+ */
+ // [TARGET reload(TableOption...)]
+ // [VARIABLE TableField.LAST_MODIFIED_TIME]
+ // [VARIABLE TableField.NUM_ROWS]
+ public Table reloadTableWithFields(TableField field1, TableField field2) {
+ // [START reloadTableWithFields]
+ Table latestTable = table.reload(TableOption.fields(field1, field2));
+ if (latestTable == null) {
+ // the table was not found
+ }
+ // [END reloadTableWithFields]
+ return latestTable;
+ }
+
+ /**
+ * Example of updating the table's information.
+ */
+ // [TARGET update(TableOption...)]
+ public Table update() {
+ // [START update]
+ Table updatedTable = table.toBuilder().description("new description").build().update();
+ // [END update]
+ return updatedTable;
+ }
+
+ /**
+ * Example of deleting the table.
+ */
+ // [TARGET delete()]
+ public boolean delete() {
+ // [START delete]
+ boolean deleted = table.delete();
+ if (deleted) {
+ // the table was deleted
+ } else {
+ // the table was not found
+ }
+ // [END delete]
+ return deleted;
+ }
+
+ /**
+ * Example of inserting rows into the table.
+ */
+ // [TARGET insert(Iterable)]
+ // [VARIABLE "rowId1"]
+ // [VARIABLE "rowId2"]
+ public InsertAllResponse insert(String rowId1, String rowId2) {
+ // [START insert]
+ List