org.apache.beam.sdk.io.gcp.bigquery

Interface BigQueryServices.DatasetService

Enclosing interface:

BigQueryServices

public static interface BigQueryServices.DatasetService

An interface to get, create and delete Cloud BigQuery datasets and tables.

Method Summary

Modifier and Type	Method and Description
void	createDataset(java.lang.String projectId, java.lang.String datasetId, java.lang.String location, java.lang.String description, java.lang.Long defaultTableExpirationMs) Create a Dataset with the given location, description and default expiration time for tables in the dataset (if null, tables don't expire).
void	createTable(Table table) Creates the specified table if it does not exist.
void	deleteDataset(java.lang.String projectId, java.lang.String datasetId) Deletes the dataset specified by the datasetId value.
void	deleteTable(TableReference tableRef) Deletes the table specified by tableId from the dataset.
Dataset	getDataset(java.lang.String projectId, java.lang.String datasetId) Gets the specified Dataset resource by dataset ID.
Table	getTable(TableReference tableRef) Gets the specified Table resource by table ID.
long	insertAll(TableReference ref, java.util.List<ValueInSingleWindow<TableRow>> rowList, java.util.List<java.lang.String> insertIdList, InsertRetryPolicy retryPolicy, java.util.List<ValueInSingleWindow<TableRow>> failedInserts) Inserts TableRows with the specified insertIds if not null.
boolean	isTableEmpty(TableReference tableRef) Returns true if the table is empty.
Table	patchTableDescription(TableReference tableReference, java.lang.String tableDescription) Patch BigQuery Table description.

Method Detail

getTable

@Nullable
Table getTable(TableReference tableRef)
                  throws java.lang.InterruptedException,
                         java.io.IOException

Gets the specified Table resource by table ID.

Returns null if the table is not found.

Throws:

java.lang.InterruptedException

java.io.IOException

createTable

void createTable(Table table)
          throws java.lang.InterruptedException,
                 java.io.IOException

Creates the specified table if it does not exist.

Throws:

java.lang.InterruptedException

java.io.IOException

deleteTable

void deleteTable(TableReference tableRef)
          throws java.io.IOException,
                 java.lang.InterruptedException

Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

Throws:

java.io.IOException

java.lang.InterruptedException

isTableEmpty

boolean isTableEmpty(TableReference tableRef)
              throws java.io.IOException,
                     java.lang.InterruptedException

Returns true if the table is empty.

Throws:

java.io.IOException - if the table is not found.

java.lang.InterruptedException

getDataset

Dataset getDataset(java.lang.String projectId,
                   java.lang.String datasetId)
            throws java.io.IOException,
                   java.lang.InterruptedException

Gets the specified Dataset resource by dataset ID.

Throws:

java.io.IOException

java.lang.InterruptedException

createDataset

void createDataset(java.lang.String projectId,
                   java.lang.String datasetId,
                   @Nullable
                   java.lang.String location,
                   @Nullable
                   java.lang.String description,
                   @Nullable
                   java.lang.Long defaultTableExpirationMs)
            throws java.io.IOException,
                   java.lang.InterruptedException

Create a Dataset with the given location, description and default expiration time for tables in the dataset (if null, tables don't expire).

Throws:

java.io.IOException

java.lang.InterruptedException

deleteDataset

void deleteDataset(java.lang.String projectId,
                   java.lang.String datasetId)
            throws java.io.IOException,
                   java.lang.InterruptedException

Deletes the dataset specified by the datasetId value.

Before you can delete a dataset, you must delete all its tables.

Throws:

java.io.IOException

java.lang.InterruptedException

insertAll

long insertAll(TableReference ref,
               java.util.List<ValueInSingleWindow<TableRow>> rowList,
               @Nullable
               java.util.List<java.lang.String> insertIdList,
               InsertRetryPolicy retryPolicy,
               java.util.List<ValueInSingleWindow<TableRow>> failedInserts)
        throws java.io.IOException,
               java.lang.InterruptedException

Inserts TableRows with the specified insertIds if not null.

If any insert fail permanently according to the retry policy, those rows are added to failedInserts.

Returns the total bytes count of TableRows.

Throws:

java.io.IOException

java.lang.InterruptedException

patchTableDescription

Table patchTableDescription(TableReference tableReference,
                            @Nullable
                            java.lang.String tableDescription)
                     throws java.io.IOException,
                            java.lang.InterruptedException

Patch BigQuery Table description.

Throws:

java.io.IOException

java.lang.InterruptedException