Reference documentation and code samples for the BigQuery Client class Dataset.
Datasets allow you to organize and control access to your tables.
Namespace
Google \ Cloud \ BigQueryMethods
__construct
| Parameters | |
|---|---|
| Name | Description |
connection | Connection\ConnectionInterfaceRepresents a connection to BigQuery. This object is created by BigQueryClient, and should not be instantiated outside of this client. |
id | stringThe dataset's ID. |
projectId | stringThe project's ID. |
mapper | ValueMapper |
info | array[optional] The dataset's metadata. |
location | string|null[optional] A default geographic location, used when no dataset metadata exists. |
exists
Check whether or not the dataset exists.
Example:
echo $dataset->exists();
| Returns | |
|---|---|
| Type | Description |
bool | |
delete
See also:
| Parameters | |
|---|---|
| Name | Description |
options | arrayConfiguration options. |
↳ deleteContents | boolIf true, delete all the tables in the dataset. If false and the dataset contains tables, the request will fail. Defaults to |
update
| Parameters | |
|---|---|
| Name | Description |
metadata | arrayThe available options for metadata are outlined at the Dataset Resource API docs |
options | array[optional] Configuration options. |
table
Lazily instantiates a table.
There are no network requests made at this point. To see the operations that can be performed on a dataset please see Table.
Example:
$table = $dataset->table('myTableId');
| Parameter | |
|---|---|
| Name | Description |
id | stringThe id of the table to request. |
| Returns | |
|---|---|
| Type | Description |
Table | |
tables
See also:
| Parameters | |
|---|---|
| Name | Description |
options | arrayConfiguration options. |
↳ maxResults | intMaximum number of results to return per page. |
↳ resultLimit | intLimit the number of results returned in total. Defaults to |
↳ pageToken | stringA previously-returned page token used to resume the loading of results from a specific point. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Core\Iterator\ItemIterator<Table> | |
createTable
See also:
| Parameters | |
|---|---|
| Name | Description |
id | mixed |
options | arrayConfiguration options. |
↳ metadata | arrayThe available options for metadata are outlined at the Table Resource API docs |
| Returns | |
|---|---|
| Type | Description |
Table | |
model
Lazily instantiates a machine learning model in the dataset.
There are no network requests made at this point. To see the operations that can be performed on a model, please see Model.
Example:
$model = $dataset->model('my_model');
echo $model->id();
| Parameters | |
|---|---|
| Name | Description |
id | stringThe model's ID. |
info | array[optional] The model resource data. |
| Returns | |
|---|---|
| Type | Description |
Model | |
models
See also:
| Parameters | |
|---|---|
| Name | Description |
options | arrayConfiguration options. |
↳ maxResults | intMaximum number of results to return per page. |
↳ resultLimit | intLimit the number of results returned in total. Defaults to |
↳ pageToken | stringA previously-returned page token used to resume the loading of results from a specific point. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Core\Iterator\ItemIterator<Model> | |
routine
Lazily instantiates a routine.
There are no network requests made at this point. To see the operations that can be performed on a routine, please see Routine.
Example:
$routine = $dataset->routine('my_routine');
echo $routine->identity()['routineId'];
| Parameters | |
|---|---|
| Name | Description |
id | stringThe routine's ID. |
info | array[optional] The routine resource data. |
| Returns | |
|---|---|
| Type | Description |
Routine | |
routines
See also:
| Parameters | |
|---|---|
| Name | Description |
options | arrayConfiguration options. |
↳ maxResults | intMaximum number of results to return per page. |
↳ resultLimit | intLimit the number of results returned in total. Defaults to |
↳ pageToken | stringA previously-returned page token used to resume the loading of results from a specific point. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Core\Iterator\ItemIterator<Model> | |
createRoutine
See also:
| Parameters | |
|---|---|
| Name | Description |
id | stringThe routine ID. |
metadata | arrayThe available options for metadata are outlined at the Routine Resource API docs. Omit |
options | array[optional] Configuration options. |
| Returns | |
|---|---|
| Type | Description |
Routine | |
info
See also:
| Parameter | |
|---|---|
| Name | Description |
options | array[optional] Configuration options. |
| Returns | |
|---|---|
| Type | Description |
array | |
reload
See also:
| Parameter | |
|---|---|
| Name | Description |
options | array[optional] Configuration options. |
| Returns | |
|---|---|
| Type | Description |
array | |
id
Retrieves the dataset's ID.
Example:
echo $dataset->id();
| Returns | |
|---|---|
| Type | Description |
string | |
identity
Retrieves the dataset's identity.
An identity provides a description of a resource that is nested in nature.
Example:
echo $dataset->identity()['projectId'];
| Returns | |
|---|---|
| Type | Description |
array | |