reservations

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

Overview

Name	reservations
Type	Resource
Id	google.bigqueryreservation.reservations

Fields

Name	Datatype	Description
name	string	The resource name of the reservation, e.g., projects/*/locations/*/reservations/team1-prod. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
autoscale	object	Auto scaling settings.
concurrency	string	Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI.
creationTime	string	Output only. Creation time of the reservation.
edition	string	Edition of the reservation.
ignoreIdleSlots	boolean	If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
multiRegionAuxiliary	boolean	Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
originalPrimaryLocation	string	Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.
primaryLocation	string	Optional. The primary location of the reservation. The field is only meaningful for reservation used for cross region disaster recovery. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.
secondaryLocation	string	Optional. The secondary location of the reservation which is used for cross region disaster recovery purposes. Customer can set this in create/update reservation calls to create a failover reservation or convert a non-failover reservation to a failover reservation.
slotCapacity	string	Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
updateTime	string	Output only. Last update time of the reservation.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, reservationsId	Returns information about the reservation.
list	SELECT	locationsId, projectsId	Lists all the reservations for the project in the specified location.
create	INSERT	locationsId, projectsId	Creates a new reservation resource.
delete	DELETE	locationsId, projectsId, reservationsId	Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION when reservation has assignments.
patch	UPDATE	locationsId, projectsId, reservationsId	Updates an existing reservation resource.
failover_reservation	EXEC	locationsId, projectsId, reservationsId	Failover a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

SELECT examples

Lists all the reservations for the project in the specified location.

SELECT
name,
autoscale,
concurrency,
creationTime,
edition,
ignoreIdleSlots,
multiRegionAuxiliary,
originalPrimaryLocation,
primaryLocation,
secondaryLocation,
slotCapacity,
updateTime
FROM google.bigqueryreservation.reservations
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new reservations resource.

All Properties

/*+ create */
INSERT INTO google.bigqueryreservation.reservations (
locationsId,
projectsId,
name,
slotCapacity,
ignoreIdleSlots,
autoscale,
concurrency,
multiRegionAuxiliary,
edition,
primaryLocation,
secondaryLocation,
originalPrimaryLocation
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ slotCapacity }}',
{{ ignoreIdleSlots }},
'{{ autoscale }}',
'{{ concurrency }}',
{{ multiRegionAuxiliary }},
'{{ edition }}',
'{{ primaryLocation }}',
'{{ secondaryLocation }}',
'{{ originalPrimaryLocation }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: slotCapacity
      value: string
    - name: ignoreIdleSlots
      value: boolean
    - name: autoscale
      value:
        - name: currentSlots
          value: string
        - name: maxSlots
          value: string
    - name: concurrency
      value: string
    - name: creationTime
      value: string
    - name: updateTime
      value: string
    - name: multiRegionAuxiliary
      value: boolean
    - name: edition
      value: string
    - name: primaryLocation
      value: string
    - name: secondaryLocation
      value: string
    - name: originalPrimaryLocation
      value: string

UPDATE example

Updates a reservations resource.

/*+ update */
UPDATE google.bigqueryreservation.reservations
SET 
name = '{{ name }}',
slotCapacity = '{{ slotCapacity }}',
ignoreIdleSlots = true|false,
autoscale = '{{ autoscale }}',
concurrency = '{{ concurrency }}',
multiRegionAuxiliary = true|false,
edition = '{{ edition }}',
primaryLocation = '{{ primaryLocation }}',
secondaryLocation = '{{ secondaryLocation }}',
originalPrimaryLocation = '{{ originalPrimaryLocation }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND reservationsId = '{{ reservationsId }}';

DELETE example

Deletes the specified reservations resource.

/*+ delete */
DELETE FROM google.bigqueryreservation.reservations
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND reservationsId = '{{ reservationsId }}';