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

Interface BigQueryServices.DatasetService

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BigQueryServicesImpl.DatasetServiceImpl, FakeDatasetService

Enclosing interface:

BigQueryServices

public static interface BigQueryServices.DatasetService
extends AutoCloseable

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BigQueryServices.DatasetService.TableMetadataView

Method Summary

Modifier and Type	Method	Description
void	createDataset(String projectId, String datasetId, @Nullable String location, @Nullable String description, @Nullable 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(com.google.api.services.bigquery.model.Table table)	Creates the specified table if it does not exist.
void	deleteDataset(String projectId, String datasetId)	Deletes the dataset specified by the datasetId value.
void	deleteTable(com.google.api.services.bigquery.model.TableReference tableRef)	Deletes the table specified by tableId from the dataset.
com.google.api.services.bigquery.model.Dataset	getDataset(String projectId, String datasetId)	Gets the specified Dataset resource by dataset ID.
@Nullable com.google.api.services.bigquery.model.Table	getTable(com.google.api.services.bigquery.model.TableReference tableRef)	Gets the specified Table resource by table ID.
@Nullable com.google.api.services.bigquery.model.Table	getTable(com.google.api.services.bigquery.model.TableReference tableRef, List<String> selectedFields)
@Nullable com.google.api.services.bigquery.model.Table	getTable(com.google.api.services.bigquery.model.TableReference tableRef, List<String> selectedFields, BigQueryServices.DatasetService.TableMetadataView view)
<T> long	insertAll(com.google.api.services.bigquery.model.TableReference ref, List<FailsafeValueInSingleWindow<com.google.api.services.bigquery.model.TableRow,com.google.api.services.bigquery.model.TableRow>> rowList, @Nullable List<String> insertIdList, InsertRetryPolicy retryPolicy, List<ValueInSingleWindow<T>> failedInserts, ErrorContainer<T> errorContainer, boolean skipInvalidRows, boolean ignoreUnknownValues, boolean ignoreInsertIds, List<ValueInSingleWindow<com.google.api.services.bigquery.model.TableRow>> successfulRows)	Inserts TableRows with the specified insertIds if not null.
boolean	isTableEmpty(com.google.api.services.bigquery.model.TableReference tableRef)	Returns true if the table is empty.
com.google.api.services.bigquery.model.Table	patchTableDescription(com.google.api.services.bigquery.model.TableReference tableReference, @Nullable String tableDescription)	Patch BigQuery Table description.
com.google.api.services.bigquery.model.Table	patchTableSchema(com.google.api.services.bigquery.model.TableReference tableReference, com.google.api.services.bigquery.model.TableSchema newSchema)

Methods inherited from interface java.lang.AutoCloseable

close

Method Details

getTable

@Nullable com.google.api.services.bigquery.model.Table getTable(com.google.api.services.bigquery.model.TableReference tableRef)
                                                         throws InterruptedException,
IOException

Gets the specified Table resource by table ID.

Returns null if the table is not found.

Throws:

InterruptedException

IOException

getTable

@Nullable com.google.api.services.bigquery.model.Table getTable(com.google.api.services.bigquery.model.TableReference tableRef,
 List<String> selectedFields)
                                                         throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

getTable

@Nullable com.google.api.services.bigquery.model.Table getTable(com.google.api.services.bigquery.model.TableReference tableRef,
 List<String> selectedFields,
 BigQueryServices.DatasetService.TableMetadataView view)
                                                         throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

createTable

void createTable(com.google.api.services.bigquery.model.Table table)
          throws InterruptedException,
IOException

Creates the specified table if it does not exist.

Throws:

InterruptedException

IOException

deleteTable

void deleteTable(com.google.api.services.bigquery.model.TableReference tableRef)
          throws IOException,
InterruptedException

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

Throws:

IOException

InterruptedException

isTableEmpty

boolean isTableEmpty(com.google.api.services.bigquery.model.TableReference tableRef)
              throws IOException,
InterruptedException

Returns true if the table is empty.

Throws:

IOException - if the table is not found.

InterruptedException

getDataset

com.google.api.services.bigquery.model.Dataset getDataset(String projectId,
 String datasetId)
                                                   throws IOException,
InterruptedException

Gets the specified Dataset resource by dataset ID.

Throws:

IOException

InterruptedException

createDataset

void createDataset(String projectId,
 String datasetId,
 @Nullable String location,
 @Nullable String description,
 @Nullable Long defaultTableExpirationMs)
            throws IOException,
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:

IOException

InterruptedException

deleteDataset

void deleteDataset(String projectId,
 String datasetId)
            throws IOException,
InterruptedException

Deletes the dataset specified by the datasetId value.

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

Throws:

IOException

InterruptedException

insertAll

<T> long insertAll(com.google.api.services.bigquery.model.TableReference ref,
 List<FailsafeValueInSingleWindow<com.google.api.services.bigquery.model.TableRow,com.google.api.services.bigquery.model.TableRow>> rowList,
 @Nullable List<String> insertIdList,
 InsertRetryPolicy retryPolicy,
 List<ValueInSingleWindow<T>> failedInserts,
 ErrorContainer<T> errorContainer,
 boolean skipInvalidRows,
 boolean ignoreUnknownValues,
 boolean ignoreInsertIds,
 List<ValueInSingleWindow<com.google.api.services.bigquery.model.TableRow>> successfulRows)
            throws IOException,
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:

IOException

InterruptedException

patchTableDescription

com.google.api.services.bigquery.model.Table patchTableDescription(com.google.api.services.bigquery.model.TableReference tableReference,
 @Nullable String tableDescription)
                                                            throws IOException,
InterruptedException

Patch BigQuery Table description.

Throws:

IOException

InterruptedException

patchTableSchema

com.google.api.services.bigquery.model.Table patchTableSchema(com.google.api.services.bigquery.model.TableReference tableReference,
 com.google.api.services.bigquery.model.TableSchema newSchema)
                                                       throws IOException,
InterruptedException

Throws:

IOException

InterruptedException