instance_partitions

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

Overview

Name	instance_partitions
Type	Resource
Id	google.spanner.instance_partitions

Fields

Name	Datatype	Description
name	string	Required. A unique identifier for the instance partition. Values are of the form projects//instances//instancePartitions/a-z*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.
config	string	Required. The name of the instance partition's configuration. Values are of the form projects//instanceConfigs/. See also InstanceConfig and ListInstanceConfigs.
createTime	string	Output only. The time at which the instance partition was created.
displayName	string	Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
etag	string	Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly.
nodeCount	integer	The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state READY.
processingUnits	integer	The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the READY state.
referencingBackups	array	Output only. Deprecated: This field is not populated. Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.
referencingDatabases	array	Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted.
state	string	Output only. The current instance partition state.
updateTime	string	Output only. The time at which the instance partition was most recently updated.

Methods

Name	Accessible by	Required Params	Description
projects_instances_instance_partitions_get	SELECT	instancePartitionsId, instancesId, projectsId	Gets information about a particular instance partition.
projects_instances_instance_partitions_list	SELECT	instancesId, projectsId	Lists all instance partitions for the given instance.
projects_instances_instance_partitions_create	INSERT	instancesId, projectsId	Creates an instance partition and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance partition. The instance partition name is assigned by the caller. If the named instance partition already exists, CreateInstancePartition returns ALREADY_EXISTS. Immediately upon completion of this request: The instance partition is readable via the API, with all requested attributes but no allocated resources. Its state is CREATING. Until completion of the returned operation: Cancelling the operation renders the instance partition immediately unreadable via the API. The instance partition can be deleted. All other attempts to modify the instance partition are rejected. Upon completion of the returned operation: Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). Databases can start using this instance partition. The instance partition's allocated resource levels are readable via the API. The instance partition's state becomes READY. The returned long-running operation will have a name of the format /operations/ and can be used to track creation of the instance partition. The metadata field type is CreateInstancePartitionMetadata. The response field type is InstancePartition, if successful.
projects_instances_instance_partitions_delete	DELETE	instancePartitionsId, instancesId, projectsId	Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance. Authorization requires spanner.instancePartitions.delete permission on the resource name.
projects_instances_instance_partitions_patch	UPDATE	instancePartitionsId, instancesId, projectsId	Updates an instance partition, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance partition. If the named instance partition does not exist, returns NOT_FOUND. Immediately upon completion of this request: For resource types for which a decrease in the instance partition's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a CANCELLED status. All other attempts to modify the instance partition are rejected. Reading the instance partition via the API continues to give the pre-request resource levels. Upon completion of the returned operation: Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). All newly-reserved resources are available for serving the instance partition's tables. * The instance partition's new resource levels are readable via the API. The returned long-running operation will have a name of the format /operations/ and can be used to track the instance partition modification. The metadata field type is UpdateInstancePartitionMetadata. The response field type is InstancePartition, if successful. Authorization requires spanner.instancePartitions.update permission on the resource name.

SELECT examples

Lists all instance partitions for the given instance.

SELECT
name,
config,
createTime,
displayName,
etag,
nodeCount,
processingUnits,
referencingBackups,
referencingDatabases,
state,
updateTime
FROM google.spanner.instance_partitions
WHERE instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.spanner.instance_partitions (
instancesId,
projectsId,
instancePartitionId,
instancePartition
)
SELECT 
'{{ instancesId }}',
'{{ projectsId }}',
'{{ instancePartitionId }}',
'{{ instancePartition }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: instancePartitionId
      value: string
    - name: instancePartition
      value:
        - name: name
          value: string
        - name: config
          value: string
        - name: displayName
          value: string
        - name: nodeCount
          value: integer
        - name: processingUnits
          value: integer
        - name: state
          value: string
        - name: createTime
          value: string
        - name: updateTime
          value: string
        - name: referencingDatabases
          value:
            - string
        - name: referencingBackups
          value:
            - string
        - name: etag
          value: string

UPDATE example

Updates a instance_partitions resource.

/*+ update */
UPDATE google.spanner.instance_partitions
SET 
instancePartition = '{{ instancePartition }}',
fieldMask = '{{ fieldMask }}'
WHERE 
instancePartitionsId = '{{ instancePartitionsId }}'
AND instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified instance_partitions resource.

/*+ delete */
DELETE FROM google.spanner.instance_partitions
WHERE instancePartitionsId = '{{ instancePartitionsId }}'
AND instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';