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
connection
Connection\ConnectionInterface
Represents a connection to BigQuery. This object is created by BigQueryClient, and should not be instantiated outside of this client.
id
string
The dataset's ID.
projectId
string
The project's ID.
mapper
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();
bool
delete
See also:
options
array
Configuration options.
↳ deleteContents
bool
If true, delete all the tables in the dataset. If false and the dataset contains tables, the request will fail. Defaults to false
.
update
metadata
options
array
Configuration options.
↳ accessPolicyVersion
int
Optional. Access policy schema version. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to IAM Policy version and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { "access": [ { "role": "roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda", "userByEmail": "user@example.com", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.
↳ updateMode
string
Optional. Specifies the fields of dataset that update/patch operation is targeting. Acceptable values include "UPDATE_MODE_UNSPECIFIED", "UPDATE_METADATA", "UPDATE_ACL", "UPDATE_FULL". By default, both metadata and ACL fields are updated.
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');
id
string
The id of the table to request.
tables
See also:
options
array
Configuration options.
↳ maxResults
int
Maximum number of results to return per page.
↳ resultLimit
int
Limit the number of results returned in total. Defaults to 0
(return all results).
↳ pageToken
string
A previously-returned page token used to resume the loading of results from a specific point.
createTable
See also:
id
mixed
options
array
Configuration options.
↳ metadata
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();
id
string
The model's ID.
info
array
[optional] The model resource data.
models
See also:
options
array
Configuration options.
↳ maxResults
int
Maximum number of results to return per page.
↳ resultLimit
int
Limit the number of results returned in total. Defaults to 0
(return all results).
↳ pageToken
string
A previously-returned page token used to resume the loading of results from a specific point.
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'];
id
string
The routine's ID.
info
array
[optional] The routine resource data.
routines
See also:
options
array
Configuration options.
↳ maxResults
int
Maximum number of results to return per page.
↳ resultLimit
int
Limit the number of results returned in total. Defaults to 0
(return all results).
↳ pageToken
string
A previously-returned page token used to resume the loading of results from a specific point.
createRoutine
See also:
id
string
The routine ID.
metadata
array
The available options for metadata are outlined at the Routine Resource API docs
.
Omit routineReference
as it is computed and appended by the
client.
options
array
[optional] Configuration options.
info
See also:
options
array
Configuration options.
↳ accessPolicyVersion
int
Optional. Access policy schema version. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to IAM Policy version and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { "access": [ { "role": "roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda", "userByEmail": "user@example.com", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.
↳ datasetView
string
Optional. Specifies the view that determines which dataset information is returned. Acceptable values include "DATASET_VIEW_UNSPECIFIED", "METADATA", "ACL", "FULL". By default, metadata and ACL information are returned.
reload
See also:
options
array
Configuration options.
↳ accessPolicyVersion
int
Optional. Access policy schema version. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to IAM Policy version and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { "access": [ { "role": "roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda", "userByEmail": "user@example.com", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.
↳ datasetView
string
Optional. Specifies the view that determines which dataset information is returned. Acceptable values include "DATASET_VIEW_UNSPECIFIED", "METADATA", "ACL", "FULL". By default, metadata and ACL information are returned.
array
id
Retrieves the dataset's ID.
Example:
echo $dataset->id();
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'];
array
