BigQuery Client - Class Routine (1.29.0)

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

Routines are used-defined functions or stored procedures.

Example:

use Google\Cloud\BigQuery\BigQueryClient;

$bigquery = new BigQueryClient();
$dataset = $bigquery->dataset('my_dataset');
$routine = $dataset->routine('my_routine');

Namespace

Google \ Cloud \ BigQuery

Methods

__construct

Parameters
Name	Description
`connection`	`Google\Cloud\BigQuery\Connection\ConnectionInterface` A connection to the BigQuery API. This object is created by BigQueryClient, and should not be instantiated outside of this client.
`id`	`string` The routine ID.
`datasetId`	`string` The dataset ID.
`projectId`	`string` The project ID.
`info`	`array` [optional] An optional representation of the routine resource.

identity

Get the routine identity.

An identity provides a description of a nested resource.

Example:

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

Returns
Type	Description
`array`

info

See also:

Get Routines API documentation.

Parameter
Name	Description
`options`	`array` [optional] Configuration options

Returns
Type	Description
`array`

reload

See also:

Get Routines API documentation.

Parameter
Name	Description
`options`	`array` [optional] Configuration options

Returns
Type	Description
`array`

exists

See also:

Get Routines API documentation.

Parameter
Name	Description
`options`	`array` [optional] Configuration options.

Returns
Type	Description
`bool`

update

See also:

Update Routines API documentation.

Parameters
Name	Description
`metadata`	`array` The full routine resource with desired modifications.
`options`	`array` Configuration options
`↳ updateMask`	`array` A list of field paths to be modified. Nested key names should be dot-separated, e.g. `returnType.typeKind`. Google Cloud PHP will attempt to infer this value on your behalf. You may use this field to limit which parts of the resource are updated, should you choose to provide the full resource as the `$metadata` argument.

Returns
Type	Description
`array`

delete

See also:

Delete Routines API documentation.

Parameter
Name	Description
`options`	`array` [optional] Configuration options.