com.google.cloud.bigquery

Interface BigQuery

All Superinterfaces:

Service<BigQueryOptions>

public interface BigQuery
extends Service<BigQueryOptions>

An interface for Google Cloud BigQuery.

See Also:

Google Cloud BigQuery

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BigQuery.DatasetDeleteOption Class for specifying dataset delete options.
static class	BigQuery.DatasetField Fields of a BigQuery Dataset resource.
static class	BigQuery.DatasetListOption Class for specifying dataset list options.
static class	BigQuery.DatasetOption Class for specifying dataset get, create and update options.
static class	BigQuery.JobField Fields of a BigQuery Job resource.
static class	BigQuery.JobListOption Class for specifying job list options.
static class	BigQuery.JobOption Class for specifying table get and create options.
static class	BigQuery.QueryResultsOption Class for specifying query results options.
static class	BigQuery.TableDataListOption Class for specifying table data list options.
static class	BigQuery.TableField Fields of a BigQuery Table resource.
static class	BigQuery.TableListOption Class for specifying table list options.
static class	BigQuery.TableOption Class for specifying table get, create and update options.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(JobId jobId) Sends a job cancel request.
boolean	cancel(String jobId) Sends a job cancel request.
Dataset	create(DatasetInfo datasetInfo, BigQuery.DatasetOption... options) Creates a new dataset.
Job	create(JobInfo jobInfo, BigQuery.JobOption... options) Creates a new job.
Table	create(TableInfo tableInfo, BigQuery.TableOption... options) Creates a new table.
boolean	delete(DatasetId datasetId, BigQuery.DatasetDeleteOption... options) Deletes the requested dataset.
boolean	delete(String datasetId, BigQuery.DatasetDeleteOption... options) Deletes the requested dataset.
boolean	delete(String datasetId, String tableId) Deletes the requested table.
boolean	delete(TableId tableId) Deletes the requested table.
Dataset	getDataset(DatasetId datasetId, BigQuery.DatasetOption... options) Returns the requested dataset or null if not found.
Dataset	getDataset(String datasetId, BigQuery.DatasetOption... options) Returns the requested dataset or null if not found.
Job	getJob(JobId jobId, BigQuery.JobOption... options) Returns the requested job or null if not found.
Job	getJob(String jobId, BigQuery.JobOption... options) Returns the requested job or null if not found.
QueryResponse	getQueryResults(JobId jobId, BigQuery.QueryResultsOption... options) Returns results of the query associated with the provided job.
Table	getTable(String datasetId, String tableId, BigQuery.TableOption... options) Returns the requested table or null if not found.
Table	getTable(TableId tableId, BigQuery.TableOption... options) Returns the requested table or null if not found.
InsertAllResponse	insertAll(InsertAllRequest request) Sends an insert all request.
Page<Dataset>	listDatasets(BigQuery.DatasetListOption... options) Lists the project's datasets.
Page<Dataset>	listDatasets(String projectId, BigQuery.DatasetListOption... options) Lists the datasets in the provided project.
Page<Job>	listJobs(BigQuery.JobListOption... options) Lists the jobs.
Page<List<FieldValue>>	listTableData(String datasetId, String tableId, BigQuery.TableDataListOption... options) Lists the table's rows.
Page<List<FieldValue>>	listTableData(TableId tableId, BigQuery.TableDataListOption... options) Lists the table's rows.
Page<Table>	listTables(DatasetId datasetId, BigQuery.TableListOption... options) Lists the tables in the dataset.
Page<Table>	listTables(String datasetId, BigQuery.TableListOption... options) Lists the tables in the dataset.
QueryResponse	query(QueryRequest request) Runs the query associated with the request.
Dataset	update(DatasetInfo datasetInfo, BigQuery.DatasetOption... options) Updates dataset information.
Table	update(TableInfo tableInfo, BigQuery.TableOption... options) Updates table information.
com.google.cloud.bigquery.TableDataWriteChannel	writer(WriteChannelConfiguration writeChannelConfiguration) Returns a channel to write data to be inserted into a BigQuery table.

Methods inherited from interface com.google.cloud.Service

getOptions, options

Method Detail

create

Dataset create(DatasetInfo datasetInfo,
             BigQuery.DatasetOption... options)

Creates a new dataset.

Example of creating a dataset.

 String datasetName = "my_dataset_name";
 Dataset dataset = null;
 DatasetInfo datasetInfo = DatasetInfo.newBuilder(datasetName).build();
 try {
   // the dataset was created
   dataset = bigquery.create(datasetInfo);
 } catch (BigQueryException e) {
   // the dataset was not created
 }
 

Throws:

BigQueryException - upon failure

create

Table create(TableInfo tableInfo,
           BigQuery.TableOption... options)

Creates a new table.

Example of creating a table.

 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 String fieldName = "string_field";
 TableId tableId = TableId.of(datasetName, tableName);
 // Table field definition
 Field field = Field.of(fieldName, Field.Type.string());
 // Table schema definition
 Schema schema = Schema.of(field);
 TableDefinition tableDefinition = StandardTableDefinition.of(schema);
 TableInfo tableInfo = TableInfo.newBuilder(tableId, tableDefinition).build();
 Table table = bigquery.create(tableInfo);
 

Throws:

BigQueryException - upon failure

create

Job create(JobInfo jobInfo,
         BigQuery.JobOption... options)

Creates a new job.

Example of creating a query job.

 String query = "SELECT field FROM my_dataset_name.my_table_name";
 Job job = null;
 JobConfiguration jobConfiguration = QueryJobConfiguration.of(query);
 JobInfo jobInfo = JobInfo.of(jobConfiguration);
 try {
   job = bigquery.create(jobInfo);
 } catch (BigQueryException e) {
   // the job was not created
 }
 

Throws:

BigQueryException - upon failure

getDataset

Dataset getDataset(String datasetId,
                 BigQuery.DatasetOption... options)

Returns the requested dataset or null if not found.

Example of getting a dataset.

 String datasetName = "my_dataset";
 Dataset dataset = bigquery.getDataset(datasetName);
 

Throws:

BigQueryException - upon failure

getDataset

Dataset getDataset(DatasetId datasetId,
                 BigQuery.DatasetOption... options)

Returns the requested dataset or null if not found.

Example of getting a dataset.

 String projectId = "my_project_id";
 String datasetName = "my_dataset_name";
 DatasetId datasetId = DatasetId.of(projectId, datasetName);
 Dataset dataset = bigquery.getDataset(datasetId);
 

Throws:

BigQueryException - upon failure

listDatasets

Page<Dataset> listDatasets(BigQuery.DatasetListOption... options)

Lists the project's datasets. This method returns partial information on each dataset: (DatasetInfo.datasetId(), DatasetInfo.friendlyName() and DatasetInfo.generatedId()). To get complete information use either getDataset(String, DatasetOption...) or getDataset(DatasetId, DatasetOption...).

Example of listing datasets, specifying the page size.

 Page<Dataset> datasets = bigquery.listDatasets(DatasetListOption.pageSize(100));
 Iterator<Dataset> datasetIterator = datasets.iterateAll();
 while (datasetIterator.hasNext()) {
   Dataset dataset = datasetIterator.next();
   // do something with the dataset
 }
 

Throws:

BigQueryException - upon failure

listDatasets

Page<Dataset> listDatasets(String projectId,
                         BigQuery.DatasetListOption... options)

Lists the datasets in the provided project. This method returns partial information on each dataset: (DatasetInfo.datasetId(), DatasetInfo.friendlyName() and DatasetInfo.generatedId()). To get complete information use either getDataset(String, DatasetOption...) or getDataset(DatasetId, DatasetOption...).

Example of listing datasets in a project, specifying the page size.

 String projectId = "my_project_id";
 Page<Dataset> datasets = bigquery.listDatasets(projectId, DatasetListOption.pageSize(100));
 Iterator<Dataset> datasetIterator = datasets.iterateAll();
 while (datasetIterator.hasNext()) {
   Dataset dataset = datasetIterator.next();
   // do something with the dataset
 }
 

Throws:

BigQueryException - upon failure

delete

boolean delete(String datasetId,
             BigQuery.DatasetDeleteOption... options)

Deletes the requested dataset.

Example of deleting a dataset from its id, even if non-empty.

 String datasetName = "my_dataset_name";
 Boolean deleted = bigquery.delete(datasetName, DatasetDeleteOption.deleteContents());
 if (deleted) {
   // the dataset was deleted
 } else {
   // the dataset was not found
 }
 

Returns:

true if dataset was deleted, false if it was not found

Throws:

BigQueryException - upon failure

delete

boolean delete(DatasetId datasetId,
             BigQuery.DatasetDeleteOption... options)

Deletes the requested dataset.

Example of deleting a dataset, even if non-empty.

 String projectId = "my_project_id";
 String datasetName = "my_dataset_name";
 DatasetId datasetId = DatasetId.of(projectId, datasetName);
 Boolean deleted = bigquery.delete(datasetId, DatasetDeleteOption.deleteContents());
 if (deleted) {
   // the dataset was deleted
 } else {
   // the dataset was not found
 }
 

Returns:

true if dataset was deleted, false if it was not found

Throws:

BigQueryException - upon failure

delete

boolean delete(String datasetId,
             String tableId)

Deletes the requested table.

Example of deleting a table.

 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 Boolean deleted = bigquery.delete(datasetName, tableName);
 if (deleted) {
   // the table was deleted
 } else {
   // the table was not found
 }
 

Returns:

true if table was deleted, false if it was not found

Throws:

BigQueryException - upon failure

delete

boolean delete(TableId tableId)

Deletes the requested table.

Example of deleting a table.

 String projectId = "my_project_id";
 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 TableId tableId = TableId.of(projectId, datasetName, tableName);
 Boolean deleted = bigquery.delete(tableId);
 if (deleted) {
   // the table was deleted
 } else {
   // the table was not found
 }
 

Returns:

true if table was deleted, false if it was not found

Throws:

BigQueryException - upon failure

update

Dataset update(DatasetInfo datasetInfo,
             BigQuery.DatasetOption... options)

Updates dataset information.

Example of updating a dataset by changing its friendly name.

 String datasetName = "my_dataset_name";
 String newFriendlyName = "some_new_friendly_name";
 Dataset oldDataset = bigquery.getDataset(datasetName);
 DatasetInfo datasetInfo = oldDataset.toBuilder().setFriendlyName(newFriendlyName).build();
 Dataset newDataset = bigquery.update(datasetInfo);
 

Throws:

BigQueryException - upon failure

update

Table update(TableInfo tableInfo,
           BigQuery.TableOption... options)

Updates table information.

Example of updating a table by changing its friendly name.

 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 String newFriendlyName = "new_friendly_name";
 Table oldTable = bigquery.getTable(datasetName, tableName);
 TableInfo tableInfo = oldTable.toBuilder().setFriendlyName(newFriendlyName).build();
 Table newTable = bigquery.update(tableInfo);
 

Throws:

BigQueryException - upon failure

getTable

Table getTable(String datasetId,
             String tableId,
             BigQuery.TableOption... options)

Returns the requested table or null if not found.

Example of getting a table.

 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 Table table = bigquery.getTable(datasetName, tableName);
 

Throws:

BigQueryException - upon failure

getTable

Table getTable(TableId tableId,
             BigQuery.TableOption... options)

Returns the requested table or null if not found.

Example of getting a table.

 String projectId = "my_project_id";
 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 TableId tableId = TableId.of(projectId, datasetName, tableName);
 Table table = bigquery.getTable(tableId);
 

Throws:

BigQueryException - upon failure

listTables

Page<Table> listTables(String datasetId,
                     BigQuery.TableListOption... options)

Lists the tables in the dataset. This method returns partial information on each table: (TableInfo.tableId(), TableInfo.friendlyName(), TableInfo.generatedId() and type, which is part of TableInfo.definition()). To get complete information use either getTable(TableId, TableOption...) or getTable(String, String, TableOption...).

Example of listing the tables in a dataset, specifying the page size.

 String datasetName = "my_dataset_name";
 Page<Table> tables = bigquery.listTables(datasetName, TableListOption.pageSize(100));
 Iterator<Table> tableIterator = tables.iterateAll();
 while (tableIterator.hasNext()) {
   Table table = tableIterator.next();
   // do something with the table
 }
 

Throws:

BigQueryException - upon failure

listTables

Page<Table> listTables(DatasetId datasetId,
                     BigQuery.TableListOption... options)

Lists the tables in the dataset. This method returns partial information on each table: (TableInfo.tableId(), TableInfo.friendlyName(), TableInfo.generatedId() and type, which is part of TableInfo.definition()). To get complete information use either getTable(TableId, TableOption...) or getTable(String, String, TableOption...).

Example of listing the tables in a dataset.

 String projectId = "my_project_id";
 String datasetName = "my_dataset_name";
 DatasetId datasetId = DatasetId.of(projectId, datasetName);
 Page<Table> tables = bigquery.listTables(datasetId, TableListOption.pageSize(100));
 Iterator<Table> tableIterator = tables.iterateAll();
 while (tableIterator.hasNext()) {
   Table table = tableIterator.next();
   // do something with the table
 }
 

Throws:

BigQueryException - upon failure

insertAll

InsertAllResponse insertAll(InsertAllRequest request)

Sends an insert all request.

Example of inserting rows into a table without running a load job.

 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 TableId tableId = TableId.of(datasetName, tableName);
 // Values of the row to insert
 Map<String, Object> rowContent = new HashMap<>();
 rowContent.put("booleanField", true);
 // Bytes are passed in base64
 rowContent.put("bytesField", "DQ4KDQ==");
 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
     .build());
 if (response.hasErrors()) {
   // If any of the insertions failed, this lets you inspect the errors
   for (Entry<Long, List<BigQueryError>> entry : response.getInsertErrors().entrySet()) {
     // inspect row error
   }
 }
 

Throws:

BigQueryException - upon failure

listTableData

Page<List<FieldValue>> listTableData(String datasetId,
                                   String tableId,
                                   BigQuery.TableDataListOption... options)

Lists the table's rows.

Example of listing table rows, specifying the page size.

 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 Page<List<FieldValue>> tableData =
     bigquery.listTableData(datasetName, tableName, TableDataListOption.pageSize(100));
 Iterator<List<FieldValue>> rowIterator = tableData.iterateAll();
 while (rowIterator.hasNext()) {
   List<FieldValue> row = rowIterator.next();
   // do something with the row
 }
 

Throws:

BigQueryException - upon failure

listTableData

Page<List<FieldValue>> listTableData(TableId tableId,
                                   BigQuery.TableDataListOption... options)

Lists the table's rows.

Example of listing table rows, specifying the page size.

 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 TableId tableIdObject = TableId.of(datasetName, tableName);
 Page<List<FieldValue>> tableData =
     bigquery.listTableData(tableIdObject, TableDataListOption.pageSize(100));
 Iterator<List<FieldValue>> rowIterator = tableData.iterateAll();
 while (rowIterator.hasNext()) {
   List<FieldValue> row = rowIterator.next();
   // do something with the row
 }
 

Throws:

BigQueryException - upon failure

getJob

Job getJob(String jobId,
         BigQuery.JobOption... options)

Returns the requested job or null if not found.

Example of getting a job.

 String jobName = "my_job_name";
 Job job = bigquery.getJob(jobName);
 if (job == null) {
   // job was not found
 }
 

Throws:

BigQueryException - upon failure

getJob

Job getJob(JobId jobId,
         BigQuery.JobOption... options)

Returns the requested job or null if not found.

Example of getting a job.

 String jobName = "my_job_name";
 JobId jobIdObject = JobId.of(jobName);
 Job job = bigquery.getJob(jobIdObject);
 if (job == null) {
   // job was not found
 }
 

Throws:

BigQueryException - upon failure

listJobs

Page<Job> listJobs(BigQuery.JobListOption... options)

Lists the jobs.

Example of listing jobs, specifying the page size.

 Page<Job> jobs = bigquery.listJobs(JobListOption.pageSize(100));
 Iterator<Job> jobIterator = jobs.iterateAll();
 while (jobIterator.hasNext()) {
   Job job = jobIterator.next();
   // do something with the job
 }
 

Throws:

BigQueryException - upon failure

cancel

boolean cancel(String jobId)

Sends a job cancel request. This call will return immediately. The job status can then be checked using either getJob(JobId, JobOption...) or getJob(String, JobOption...)).

Example of cancelling a job.

 String jobName = "my_job_name";
 boolean success = bigquery.cancel(jobName);
 if (success) {
   // job was cancelled
 } else {
   // job was not found
 }
 

Returns:

true if cancel was requested successfully, false if the job was not found

Throws:

BigQueryException - upon failure

cancel

boolean cancel(JobId jobId)

Sends a job cancel request. This call will return immediately. The job status can then be checked using either getJob(JobId, JobOption...) or getJob(String, JobOption...)).

Example of cancelling a job.

 String jobName = "my_job_name";
 JobId jobId = JobId.of(jobName);
 boolean success = bigquery.cancel(jobId);
 if (success) {
   // job was cancelled
 } else {
   // job was not found
 }
 

Returns:

true if cancel was requested successfully, false if the job was not found

Throws:

BigQueryException - upon failure

query

QueryResponse query(QueryRequest request)

Runs the query associated with the request.

Example of running a query.

 String query = "SELECT unique(corpus) FROM [bigquery-public-data:samples.shakespeare]";
 QueryRequest request = QueryRequest.of(query);
 QueryResponse response = bigquery.query(request);
 // Wait for things to finish
 while (!response.jobCompleted()) {
   Thread.sleep(1000);
   response = bigquery.getQueryResults(response.getJobId());
 }
 if (response.hasErrors()) {
   // handle errors
 }
 QueryResult result = response.getResult();
 Iterator<List<FieldValue>> rowIterator = result.iterateAll();
 while (rowIterator.hasNext()) {
   List<FieldValue> row = rowIterator.next();
   // do something with the data
 }
 

Throws:

BigQueryException - upon failure

getQueryResults

QueryResponse getQueryResults(JobId jobId,
                            BigQuery.QueryResultsOption... options)

Returns results of the query associated with the provided job.

Example of getting the results of query.

 String query = "SELECT unique(corpus) FROM [bigquery-public-data:samples.shakespeare]";
 QueryRequest request = QueryRequest.of(query);
 QueryResponse response = bigquery.query(request);
 // Wait for things to finish
 while (!response.jobCompleted()) {
   Thread.sleep(1000);
   response = bigquery.getQueryResults(response.getJobId());
 }
 if (response.hasErrors()) {
   // handle errors
 }
 QueryResult result = response.getResult();
 Iterator<List<FieldValue>> rowIterator = result.iterateAll();
 while (rowIterator.hasNext()) {
   List<FieldValue> row = rowIterator.next();
   // do something with the data
 }
 

Throws:

BigQueryException - upon failure

writer

com.google.cloud.bigquery.TableDataWriteChannel writer(WriteChannelConfiguration writeChannelConfiguration)

Returns a channel to write data to be inserted into a BigQuery table. Data format and other options can be configured using the WriteChannelConfiguration parameter.

Example of creating a channel with which to write to a table.

 String datasetName = "my_dataset_name";
 String tableName = "my_table_name";
 String csvData = "StringValue1\nStringValue2\n";
 TableId tableId = TableId.of(datasetName, tableName);
 WriteChannelConfiguration writeChannelConfiguration =
     WriteChannelConfiguration.newBuilder(tableId)
         .setFormatOptions(FormatOptions.csv())
         .build();
 BaseWriteChannel<BigQueryOptions, WriteChannelConfiguration> 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();
 

Throws:

BigQueryException - upon failure