spanner library

Classes

AutoscalingConfig
Autoscaling config for an instance.
AutoscalingConfigResponse
Autoscaling config for an instance.
AutoscalingLimits
The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.
AutoscalingLimitsResponse
The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.
AutoscalingTargets
The autoscaling targets for an instance.
AutoscalingTargetsResponse
The autoscaling targets for an instance.
Backup
Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.
BackupArgs
The set of arguments for Backup. The set of arguments for Backup.
BackupInfoResponse
Information about a backup.
Binding
Associates members, or principals, with a role.
BindingResponse
Associates members, or principals, with a role.
Database
Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format /operations/ and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. Auto-naming is currently not supported for this resource.
DatabaseArgs
The set of arguments for Database. The set of arguments for Database.
EncryptionConfig
Encryption configuration for a Cloud Spanner database.
EncryptionConfigResponse
Encryption configuration for a Cloud Spanner database.
EncryptionInfoResponse
Encryption information for a Cloud Spanner database or backup.
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExprResponse
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
FreeInstanceMetadata
Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.
FreeInstanceMetadataResponse
Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.
GetBackupArgs
Arguments for getBackup. Arguments for getBackup.
GetBackupResult
Result data returned by getBackup.
GetDatabaseArgs
Arguments for getDatabase. Arguments for getDatabase.
GetDatabaseResult
Result data returned by getDatabase.
GetInstanceArgs
Arguments for getInstance. Arguments for getInstance.
GetInstanceBackupIamPolicyArgs
Arguments for getInstanceBackupIamPolicy. Arguments for getInstanceBackupIamPolicy.
GetInstanceBackupIamPolicyResult
Result data returned by getInstanceBackupIamPolicy.
GetInstanceConfigArgs
Arguments for getInstanceConfig. Arguments for getInstanceConfig.
GetInstanceConfigResult
Result data returned by getInstanceConfig.
GetInstanceDatabaseIamPolicyArgs
Arguments for getInstanceDatabaseIamPolicy. Arguments for getInstanceDatabaseIamPolicy.
GetInstanceDatabaseIamPolicyResult
Result data returned by getInstanceDatabaseIamPolicy.
GetInstanceIamPolicyArgs
Arguments for getInstanceIamPolicy. Arguments for getInstanceIamPolicy.
GetInstanceIamPolicyResult
Result data returned by getInstanceIamPolicy.
GetInstanceResult
Result data returned by getInstance.
GetSessionArgs
Arguments for getSession. Arguments for getSession.
GetSessionResult
Result data returned by getSession.
Instance
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 /operations/ and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.
InstanceArgs
The set of arguments for Instance. The set of arguments for Instance.
InstanceBackupIamBinding
Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires spanner.databases.setIamPolicy permission on resource. For backups, authorization requires spanner.backups.setIamPolicy permission on resource.
InstanceBackupIamBindingArgs
The set of arguments for InstanceBackupIamBinding. The set of arguments for InstanceBackupIamBinding.
InstanceBackupIamMember
Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires spanner.databases.setIamPolicy permission on resource. For backups, authorization requires spanner.backups.setIamPolicy permission on resource.
InstanceBackupIamMemberArgs
The set of arguments for InstanceBackupIamMember. The set of arguments for InstanceBackupIamMember.
InstanceBackupIamPolicy
Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires spanner.databases.setIamPolicy permission on resource. For backups, authorization requires spanner.backups.setIamPolicy permission on resource. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
InstanceBackupIamPolicyArgs
The set of arguments for InstanceBackupIamPolicy. The set of arguments for InstanceBackupIamPolicy.
InstanceConfig
Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, CreateInstanceConfig returns ALREADY_EXISTS. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is CREATING. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its 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 config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires spanner.instanceConfigs.create permission on the resource parent.
InstanceConfigArgs
The set of arguments for InstanceConfig. The set of arguments for InstanceConfig.
InstanceDatabaseIamBinding
Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires spanner.databases.setIamPolicy permission on resource. For backups, authorization requires spanner.backups.setIamPolicy permission on resource.
InstanceDatabaseIamBindingArgs
The set of arguments for InstanceDatabaseIamBinding. The set of arguments for InstanceDatabaseIamBinding.
InstanceDatabaseIamMember
Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires spanner.databases.setIamPolicy permission on resource. For backups, authorization requires spanner.backups.setIamPolicy permission on resource.
InstanceDatabaseIamMemberArgs
The set of arguments for InstanceDatabaseIamMember. The set of arguments for InstanceDatabaseIamMember.
InstanceDatabaseIamPolicy
Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires spanner.databases.setIamPolicy permission on resource. For backups, authorization requires spanner.backups.setIamPolicy permission on resource. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
InstanceDatabaseIamPolicyArgs
The set of arguments for InstanceDatabaseIamPolicy. The set of arguments for InstanceDatabaseIamPolicy.
InstanceIamBinding
Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires spanner.instances.setIamPolicy on resource.
InstanceIamBindingArgs
The set of arguments for InstanceIamBinding. The set of arguments for InstanceIamBinding.
InstanceIamMember
Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires spanner.instances.setIamPolicy on resource.
InstanceIamMemberArgs
The set of arguments for InstanceIamMember. The set of arguments for InstanceIamMember.
InstanceIamPolicy
Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires spanner.instances.setIamPolicy on resource. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
InstanceIamPolicyArgs
The set of arguments for InstanceIamPolicy. The set of arguments for InstanceIamPolicy.
ReplicaInfo
ReplicaInfoResponse
RestoreInfoResponse
Information about the database restore.
Session
Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return NOT_FOUND. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1". Auto-naming is currently not supported for this resource.
SessionArgs
The set of arguments for Session. The set of arguments for Session.
StatusResponse
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Enums

DatabaseDatabaseDialect
Optional. The dialect of the Cloud Spanner Database.
FreeInstanceMetadataExpireBehavior
Specifies the expiration behavior of a free instance. The default of ExpireBehavior is REMOVE_AFTER_GRACE_PERIOD. This can be modified during or after creation, and before expiration.
InstanceInstanceType
The InstanceType of the current instance.
ReplicaInfoType
The type of replica.

Functions

getBackup(GetBackupArgs args, {InvokeOptions? options}) → Future<GetBackupResult>
Gets metadata on a pending or completed Backup. args Arguments passed to this invoke. Arguments for getBackup. options Invoke options controlling this call.
getDatabase(GetDatabaseArgs args, {InvokeOptions? options}) → Future<GetDatabaseResult>
Gets the state of a Cloud Spanner database. args Arguments passed to this invoke. Arguments for getDatabase. options Invoke options controlling this call.
getInstance(GetInstanceArgs args, {InvokeOptions? options}) → Future<GetInstanceResult>
Gets information about a particular instance. args Arguments passed to this invoke. Arguments for getInstance. options Invoke options controlling this call.
getInstanceBackupIamPolicy(GetInstanceBackupIamPolicyArgs args, {InvokeOptions? options}) → Future<GetInstanceBackupIamPolicyResult>
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires spanner.databases.getIamPolicy permission on resource. For backups, authorization requires spanner.backups.getIamPolicy permission on resource. args Arguments passed to this invoke. Arguments for getInstanceBackupIamPolicy. options Invoke options controlling this call.
getInstanceConfig(GetInstanceConfigArgs args, {InvokeOptions? options}) → Future<GetInstanceConfigResult>
Gets information about a particular instance configuration. args Arguments passed to this invoke. Arguments for getInstanceConfig. options Invoke options controlling this call.
getInstanceDatabaseIamPolicy(GetInstanceDatabaseIamPolicyArgs args, {InvokeOptions? options}) → Future<GetInstanceDatabaseIamPolicyResult>
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires spanner.databases.getIamPolicy permission on resource. For backups, authorization requires spanner.backups.getIamPolicy permission on resource. args Arguments passed to this invoke. Arguments for getInstanceDatabaseIamPolicy. options Invoke options controlling this call.
getInstanceIamPolicy(GetInstanceIamPolicyArgs args, {InvokeOptions? options}) → Future<GetInstanceIamPolicyResult>
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. args Arguments passed to this invoke. Arguments for getInstanceIamPolicy. options Invoke options controlling this call.
getSession(GetSessionArgs args, {InvokeOptions? options}) → Future<GetSessionResult>
Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive. args Arguments passed to this invoke. Arguments for getSession. options Invoke options controlling this call.