Cloud Spanner Instance Admin API

The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.

Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.

Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

Constructor.

Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, CreateInstance returns ALREADY_EXISTS.

Immediately upon completion of this request:

• The instance 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 immediately unreadable via the API.
• The instance can be deleted.
• All other attempts to modify the instance 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 be created in the instance.
• The instance's allocated resource levels are readable via the API.
• The instance's state becomes READY.

The returned long-running operation will have a name of the format <instance_name>/operations/<operation_id> and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

parent = client.project_path('[PROJECT]')

TODO: Initialize instance_id:

instance_id = ''

TODO: Initialize instance:

instance = {}

response = client.create_instance(parent, instance_id, instance)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()

Deletes an instance.

Immediately upon completion of the request:

• Billing ceases for all of the instance's reserved resources.

Soon afterward:

• The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

name = client.instance_path('[PROJECT]', '[INSTANCE]')

client.delete_instance(name)

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials file.

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

Authorization requires spanner.instances.getIamPolicy on resource.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

TODO: Initialize resource:

resource = ''

response = client.get_iam_policy(resource)

Gets information about a particular instance.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

name = client.instance_path('[PROJECT]', '[INSTANCE]')

response = client.get_instance(name)

Gets information about a particular instance configuration.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

name = client.instance_config_path('[PROJECT]', '[INSTANCE_CONFIG]')

response = client.get_instance_config(name)

Return a fully-qualified instance_config string.

Return a fully-qualified instance string.

Lists the supported instance configurations for a given project.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

parent = client.project_path('[PROJECT]')

Iterate over all results

for element in client.list_instance_configs(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_instance_configs(parent).pages: ... for element in page: ... # process element ... pass

Lists all instances in the given project.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

parent = client.project_path('[PROJECT]')

Iterate over all results

for element in client.list_instances(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_instances(parent).pages: ... for element in page: ... # process element ... pass

Return a fully-qualified project string.

Sets the access control policy on an instance resource. Replaces any existing policy.

Authorization requires spanner.instances.setIamPolicy on resource.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

TODO: Initialize resource:

resource = ''

TODO: Initialize policy:

policy = {}

response = client.set_iam_policy(resource, policy)

Returns permissions that the caller has on the specified instance resource.

Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has spanner.instances.list permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

TODO: Initialize resource:

resource = ''

TODO: Initialize permissions:

permissions = []

response = client.test_iam_permissions(resource, permissions)

Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns NOT_FOUND.

Immediately upon completion of this request:

• For resource types for which a decrease in the instance'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 are rejected.
• Reading the instance 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's tables.
• The instance's new resource levels are readable via the API.

The returned long-running operation will have a name of the format <instance_name>/operations/<operation_id> and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful.

Authorization requires spanner.instances.update permission on resource name.

.. rubric:: Example

from google.cloud import spanner_admin_instance_v1

client = spanner_admin_instance_v1.InstanceAdminClient()

TODO: Initialize instance:

instance = {}

TODO: Initialize field_mask:

field_mask = {}

response = client.update_instance(instance, field_mask)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()