Class Dataset (2.16.1)

Stay organized with collections Save and categorize content based on your preferences.
public class Dataset extends DatasetInfo

A Google BigQuery Dataset.

Objects of this class are immutable. Operations that modify the dataset like #update return a new object. To get a Dataset object with the most recent information use #reload. Dataset adds a layer of service-related functionality over DatasetInfo.

Inheritance

Object > DatasetInfo > Dataset

Methods

create(String tableId, TableDefinition definition, BigQuery.TableOption[] options)

public Table create(String tableId, TableDefinition definition, BigQuery.TableOption[] options)

Creates a new table in this dataset.

Example of creating a table in the dataset with schema and time partitioning.


 String tableName = \u201cmy_table\u201d;
 String fieldName = \u201cmy_field\u201d;
 Schema schema = Schema.of(Field.of(fieldName, LegacySQLTypeName.STRING));
 StandardTableDefinition definition = StandardTableDefinition.newBuilder()
     .setSchema(schema)
     .setTimePartitioning(TimePartitioning.of(TimePartitioning.Type.DAY))
     .build();
 Table table = dataset.create(tableName, definition);
 
Parameters
NameDescription
tableIdString

the table's user-defined id

definitionTableDefinition

the table's definition

optionsTableOption[]

options for table creation

Returns
TypeDescription
Table

a Table object for the created table

delete(BigQuery.DatasetDeleteOption[] options)

public boolean delete(BigQuery.DatasetDeleteOption[] options)

Deletes this dataset.

Example of deleting a dataset.


 boolean deleted = dataset.delete();
 if (deleted) {
   // The dataset was deleted
 } else {
   // The dataset was not found
 }
 
Parameter
NameDescription
optionsDatasetDeleteOption[]
Returns
TypeDescription
boolean

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

equals(Object obj)

public final boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

exists()

public boolean exists()

Checks if this dataset exists.

Example of checking whether a dataset exists.


 boolean exists = dataset.exists();
 if (exists) {
   // the dataset exists
 } else {
   // the dataset was not found
 }
 
Returns
TypeDescription
boolean

true if this dataset exists, false otherwise

get(String tableId, BigQuery.TableOption[] options)

public Table get(String tableId, BigQuery.TableOption[] options)

Returns the requested table in this dataset or null if not found.

Example of getting a table in the dataset.


 String tableName = \u201cmy_table\u201d;
 Table table = dataset.get(tableName);
 
Parameters
NameDescription
tableIdString

user-defined id of the requested table

optionsTableOption[]

table options

Returns
TypeDescription
Table

getBigQuery()

public BigQuery getBigQuery()

Returns the dataset's BigQuery object used to issue requests.

Returns
TypeDescription
BigQuery

hashCode()

public final int hashCode()
Returns
TypeDescription
int
Overrides

list(BigQuery.TableListOption[] options)

public Page<Table> list(BigQuery.TableListOption[] options)

Returns the paginated list of tables in this dataset.

Example of listing tables in the dataset.


 Page<Table> tables = dataset.list();
 for (Table table : tables.iterateAll()) {
   // do something with the table
 }
 
Parameter
NameDescription
optionsTableListOption[]

options for listing tables

Returns
TypeDescription
Page<Table>

reload(BigQuery.DatasetOption[] options)

public Dataset reload(BigQuery.DatasetOption[] options)

Fetches current dataset's latest information. Returns null if the dataset does not exist.

Example of reloading a dataset.


 Dataset latestDataset = dataset.reload();
 if (latestDataset == null) {
   // The dataset was not found
 }
 
Parameter
NameDescription
optionsDatasetOption[]

dataset options

Returns
TypeDescription
Dataset

a Dataset object with latest information or null if not found

toBuilder()

public Dataset.Builder toBuilder()

Returns a builder for the dataset object.

Returns
TypeDescription
Dataset.Builder
Overrides

update(BigQuery.DatasetOption[] options)

public Dataset update(BigQuery.DatasetOption[] options)

Updates the dataset's information with this dataset's information. Dataset's user-defined id cannot be changed. A new Dataset object is returned.

Example of updating a dataset.


 String friendlyName = "my_friendly_name";
 Builder builder = dataset.toBuilder();
 builder.setFriendlyName(friendlyName);
 Dataset updatedDataset = builder.build().update();
 
Parameter
NameDescription
optionsDatasetOption[]

dataset options

Returns
TypeDescription
Dataset

a Dataset object with updated information