BigQuery Client - Class Dataset (1.23.10)

Reference documentation and code samples for the BigQuery Client class Dataset.

Datasets allow you to organize and control access to your tables.

Check whether or not the dataset exists.

Example:

 echo $dataset->exists(); 

Delete the dataset.

Please note that by default the library will not attempt to retry this call on your behalf.

Example:

 $dataset->delete(); 

Update the dataset.

Providing an etag key as part of $metadata will enable simultaneous update protection. This is useful in preventing override of modifications made by another user. The resource's current etag can be obtained via a GET request on the resource.

Please note that by default this call will not automatically retry on your behalf unless an etag is set.

Example:

 $dataset->update([
    'friendlyName' => 'A fanciful dataset.'
]); 

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'); 

Fetches tables in the dataset.

Example:

 $tables = $dataset->tables();

foreach ($tables as $table) {
    echo $table->id() . PHP_EOL;
} 

Creates a table.

Please note that by default the library will not attempt to retry this call on your behalf.

Example:

 $table = $dataset->createTable('aTable'); 

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(); 

Fetches all of the models in the dataset.

Please note that Model instances obtained from this method contain only a subset of the resource representation. Fields returned include modelReference , modelType , creationTime , lastModifiedTime and labels . To obtain a full representation, call {@see}.

Example:

 $models = $dataset->models();

foreach ($models as $model) {
    echo $model->id() . PHP_EOL;
} 

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 {@see}.

Example:

 $routine = $dataset->routine('my_routine');
echo $routine->identity()['routineId']; 

Fetches all of the routines in the dataset.

Please note that Routine instances obtained from this method contain only a subset of the resource representation. Fields returned include etag , projectId , datasetId , routineId , routineType , creationTime , lastModifiedTime and language . To obtain a full representation, call {@see}.

Example:

 $routines = $dataset->routines();

foreach ($routines as $routine) {
    echo $routine->identity()['routineId'] . PHP_EOL;
} 

Creates a routine.

Please note that by default the library will not attempt to retry this call on your behalf.

Example:

 $routine = $dataset->createRoutine('my_routine', [
    'routineType' => 'SCALAR_FUNCTION',
    'definitionBody' => 'concat(x, "\n", y)',
    'arguments' => [
        [
            'name' => 'x',
            'dataType' => [
                'typeKind' => 'STRING'
            ]
        ], [
            'name' => 'y',
            'dataType' => [
                'typeKind' => 'STRING'
            ]
        ]
    ]
]); 

Retrieves the dataset's details. If no dataset data is cached a network request will be made to retrieve it.

Example:

 $info = $dataset->info();
echo $info['selfLink']; 

Triggers a network request to reload the dataset's details.

Example:

 $dataset->reload();
$info = $dataset->info();
echo $info['selfLink']; 

Retrieves the dataset's ID.

Example:

 echo $dataset->id(); 

Retrieves the dataset's identity.

An identity provides a description of a resource that is nested in nature.

Example:

 echo $dataset->identity()['projectId'];