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 |
Google\Cloud\BigQuery\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 |
Google\Cloud\BigQuery\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 |
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 |
update
Parameters | |
---|---|
Name | Description |
metadata |
array
The 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 Google\Cloud\BigQuery\Table.
Example:
$table = $dataset->table('myTableId');
Parameter | |
---|---|
Name | Description |
id |
string
The id of the table to request. |
Returns | |
---|---|
Type | Description |
Google\Cloud\BigQuery\Table |
tables
See also:
Parameters | |
---|---|
Name | Description |
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 |
↳ pageToken |
string
A previously-returned page token used to resume the loading of results from a specific point. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Core\Iterator\ItemIterator<\google\cloud\bigquery\table> |
createTable
See also:
Parameters | |
---|---|
Name | Description |
id |
mixed
|
options |
array
Configuration options. |
↳ metadata |
array
The available options for metadata are outlined at the Table Resource API docs |
Returns | |
---|---|
Type | Description |
Google\Cloud\BigQuery\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 Google\Cloud\BigQuery\Model.
Example:
$model = $dataset->model('my_model');
echo $model->id();
Parameters | |
---|---|
Name | Description |
id |
string
The model's ID. |
info |
array
[optional] The model resource data. |
Returns | |
---|---|
Type | Description |
Google\Cloud\BigQuery\Model |
models
See also:
Parameters | |
---|---|
Name | Description |
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 |
↳ pageToken |
string
A previously-returned page token used to resume the loading of results from a specific point. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Core\Iterator\ItemIterator<\google\cloud\bigquery\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 Google\Cloud\BigQuery\Routine.
Example:
$routine = $dataset->routine('my_routine');
echo $routine->identity()['routineId'];
Parameters | |
---|---|
Name | Description |
id |
string
The routine's ID. |
info |
array
[optional] The routine resource data. |
Returns | |
---|---|
Type | Description |
Google\Cloud\BigQuery\Routine |
routines
See also:
Parameters | |
---|---|
Name | Description |
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 |
↳ pageToken |
string
A previously-returned page token used to resume the loading of results from a specific point. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Core\Iterator\ItemIterator<\google\cloud\bigquery\model> |
createRoutine
See also:
Parameters | |
---|---|
Name | Description |
id |
string
The routine ID. |
metadata |
array
The available options for metadata are outlined at the
Routine Resource API docs.
Omit |
options |
array
[optional] Configuration options. |
Returns | |
---|---|
Type | Description |
Google\Cloud\BigQuery\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 |