bi_reservation

Creates, updates, deletes, gets or lists a bi_reservation resource.

Overview

Name	bi_reservation
Type	Resource
Id	google.bigqueryreservation.bi_reservation

Fields

The following fields are returned by SELECT queries:

get_bi_reservation

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the singleton BI reservation. Reservation names have the form projects/{project_id}/locations/{location_id}/biReservation.
preferredTables	array	Optional. Preferred tables to use BI capacity for.
size	string (int64)	Optional. Size of a reservation, in bytes.
updateTime	string (google-datetime)	Output only. The last update timestamp of a reservation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bi_reservation	select	projectsId, locationsId		Retrieves a BI reservation.
update_bi_reservation	update	projectsId, locationsId	updateMask	Updates a BI reservation. Only fields specified in the field_mask are updated. A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
updateMask	string (google-fieldmask)

SELECT examples

get_bi_reservation

Retrieves a BI reservation.

SELECT
name,
preferredTables,
size,
updateTime
FROM google.bigqueryreservation.bi_reservation
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

UPDATE examples

update_bi_reservation

Updates a BI reservation. Only fields specified in the field_mask are updated. A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.

UPDATE google.bigqueryreservation.bi_reservation
SET 
data__name = '{{ name }}',
data__size = '{{ size }}',
data__preferredTables = '{{ preferredTables }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
preferredTables,
size,
updateTime;