Package @google-cloud/spanner (7.5.0)

The Backup class represents a Cloud Spanner backup.

Create a Backup object to interact with or create a Cloud Spanner backup or copy a backup.

Create a Database object to interact with a Cloud Spanner database.

Float

The Instance class represents a [Cloud Spanner instance](https://cloud.google.com/spanner/docs/instances).

Create an Instance object to interact with a Cloud Spanner instance.

The InstanceConfig class represents a possible configuration for a Cloud Spanner instance.

Create an InstanceConfig object to interact with a Cloud Spanner instance config.

Int

Numeric

This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently.

Chances are, you'll never need to create a partitioned DML transaction directly, instead you'll want to use .

Snapshot

PGNumeric

Represents a ClientLibrarySettings.

Represents a CommonLanguageSettings.

Represents a CppSettings.

Represents a CustomHttpPattern.

Represents a DotnetSettings.

Represents a GoSettings.

Represents a Http.

Represents a HttpRule.

Represents a JavaSettings.

Represents a MethodSettings.

Represents a LongRunning.

Represents a NodeSettings.

Represents a PhpSettings.

Represents a Publishing.

Represents a PythonSettings.

Represents a ResourceDescriptor.

Represents a ResourceReference.

Represents a RubySettings.

Represents an AuditConfig.

Represents an AuditConfigDelta.

Represents an AuditLogConfig.

Represents a Binding.

Represents a BindingDelta.

Represents a GetIamPolicyRequest.

Represents a GetPolicyOptions.

Represents a IAMPolicy

Represents a Policy.

Represents a PolicyDelta.

Represents a SetIamPolicyRequest.

Represents a TestIamPermissionsRequest.

Represents a TestIamPermissionsResponse.

Represents a CancelOperationRequest.

Represents a DeleteOperationRequest.

Represents a GetOperationRequest.

Represents a ListOperationsRequest.

Represents a ListOperationsResponse.

Represents an Operation.

Represents an OperationInfo.

Represents an Operations

Represents a WaitOperationRequest.

Represents an Any.

Represents a DescriptorProto.

Represents an ExtensionRange.

Represents a ReservedRange.

Represents a Duration.

Represents an Empty.

Represents an EnumDescriptorProto.

Represents an EnumReservedRange.

Represents an EnumOptions.

Represents an EnumValueDescriptorProto.

Represents an EnumValueOptions.

Represents an ExtensionRangeOptions.

Represents a Declaration.

Represents a FeatureSet.

Represents a FeatureSetDefaults.

Represents a FeatureSetEditionDefault.

Represents a FieldDescriptorProto.

Represents a FieldMask.

Represents a FieldOptions.

Represents an EditionDefault.

Represents a FileDescriptorProto.

Represents a FileDescriptorSet.

Represents a FileOptions.

Represents a GeneratedCodeInfo.

Represents an Annotation.

Represents a ListValue.

Represents a MessageOptions.

Represents a MethodDescriptorProto.

Represents a MethodOptions.

Represents an OneofDescriptorProto.

Represents an OneofOptions.

Represents a ServiceDescriptorProto.

Represents a ServiceOptions.

Represents a SourceCodeInfo.

Represents a Location.

Represents a Struct.

Represents a Timestamp.

Represents an UninterpretedOption.

Represents a NamePart.

Represents a Value.

Represents a BadRequest.

Represents a FieldViolation.

Represents a DebugInfo.

Represents an ErrorInfo.

Represents a Help.

Represents a Link.

Represents a LocalizedMessage.

Represents a PreconditionFailure.

Represents a Violation.

Represents a QuotaFailure.

Represents a Violation.

Represents a RequestInfo.

Represents a ResourceInfo.

Represents a RetryInfo.

Represents a Status.

Represents a Backup.

Represents a BackupInfo.

Represents a CopyBackupEncryptionConfig.

Represents a CopyBackupMetadata.

Represents a CopyBackupRequest.

Represents a CreateBackupEncryptionConfig.

Represents a CreateBackupMetadata.

Represents a CreateBackupRequest.

Represents a CreateDatabaseMetadata.

Represents a CreateDatabaseRequest.

Represents a Database.

Represents a DatabaseAdmin

Represents a DatabaseRole.

Represents a DdlStatementActionInfo.

Represents a DeleteBackupRequest.

Represents a DropDatabaseRequest.

Represents an EncryptionConfig.

Represents an EncryptionInfo.

Represents a GetBackupRequest.

Represents a GetDatabaseDdlRequest.

Represents a GetDatabaseDdlResponse.

Represents a GetDatabaseRequest.

Represents a ListBackupOperationsRequest.

Represents a ListBackupOperationsResponse.

Represents a ListBackupsRequest.

Represents a ListBackupsResponse.

Represents a ListDatabaseOperationsRequest.

Represents a ListDatabaseOperationsResponse.

Represents a ListDatabaseRolesRequest.

Represents a ListDatabaseRolesResponse.

Represents a ListDatabasesRequest.

Represents a ListDatabasesResponse.

Represents an OperationProgress.

Represents an OptimizeRestoredDatabaseMetadata.

Represents a RestoreDatabaseEncryptionConfig.

Represents a RestoreDatabaseMetadata.

Represents a RestoreDatabaseRequest.

Represents a RestoreInfo.

Represents an UpdateBackupRequest.

Represents an UpdateDatabaseDdlMetadata.

Represents an UpdateDatabaseDdlRequest.

Represents an UpdateDatabaseMetadata.

Represents an UpdateDatabaseRequest.

Represents an AutoscalingConfig.

Represents an AutoscalingLimits.

Represents an AutoscalingTargets.

Represents a CreateInstanceConfigMetadata.

Represents a CreateInstanceConfigRequest.

Represents a CreateInstanceMetadata.

Represents a CreateInstanceRequest.

Represents a DeleteInstanceConfigRequest.

Represents a DeleteInstanceRequest.

Represents a GetInstanceConfigRequest.

Represents a GetInstanceRequest.

Represents an Instance.

Represents an InstanceAdmin

Represents an InstanceConfig.

Represents a ListInstanceConfigOperationsRequest.

Represents a ListInstanceConfigOperationsResponse.

Represents a ListInstanceConfigsRequest.

Represents a ListInstanceConfigsResponse.

Represents a ListInstancesRequest.

Represents a ListInstancesResponse.

Represents an OperationProgress.

Represents a ReplicaInfo.

Represents an UpdateInstanceConfigMetadata.

Represents an UpdateInstanceConfigRequest.

Represents an UpdateInstanceMetadata.

Represents an UpdateInstanceRequest.

Represents a BatchCreateSessionsRequest.

Represents a BatchCreateSessionsResponse.

Represents a BatchWriteRequest.

Represents a MutationGroup.

Represents a BatchWriteResponse.

Represents a BeginTransactionRequest.

Represents a CommitRequest.

Represents a CommitResponse.

Represents a CommitStats.

Represents a CreateSessionRequest.

Represents a DeleteSessionRequest.

Represents a DirectedReadOptions.

Represents an ExcludeReplicas.

Represents an IncludeReplicas.

Represents a ReplicaSelection.

Represents an ExecuteBatchDmlRequest.

Represents a Statement.

Represents an ExecuteBatchDmlResponse.

Represents an ExecuteSqlRequest.

Represents a QueryOptions.

Represents a GetSessionRequest.

Represents a KeyRange.

Represents a KeySet.

Represents a ListSessionsRequest.

Represents a ListSessionsResponse.

Represents a Mutation.

Represents a Delete.

Represents a Write.

Represents a PartialResultSet.

Represents a Partition.

Represents a PartitionOptions.

Represents a PartitionQueryRequest.

Represents a PartitionReadRequest.

Represents a PartitionResponse.

Represents a PlanNode.

Represents a ChildLink.

Represents a ShortRepresentation.

Represents a QueryPlan.

Represents a ReadRequest.

Represents a RequestOptions.

Represents a ResultSet.

Represents a ResultSetMetadata.

Represents a ResultSetStats.

Represents a RollbackRequest.

Represents a Session.

Represents a Spanner

Represents a StructType.

Represents a Field.

Represents a Transaction.

Represents a TransactionOptions.

Represents a PartitionedDml.

Represents a ReadOnly.

Represents a ReadWrite.

Represents a TransactionSelector.

Represents a Type.

Represents an Expr.

Create a Session object to interact with a Cloud Spanner session.

**It is unlikely you will need to interact with sessions directly. By default, sessions are created and utilized for maximum performance automatically.**

Class used to manage connections to Spanner.

**You don't need to use this class directly, connections will be handled for you.**

{EventEmitter}

This transaction type provides guaranteed consistency across several reads, but does not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past.

When finished with the Snapshot, call to release the underlying Session. Failure to do so can result in a Session leak.

**This object is created and returned from .**

[Cloud Spanner](https://cloud.google.com/spanner) is a highly scalable, transactional, managed, NewSQL database service. Cloud Spanner solves the need for a horizontally-scaling database with consistent global transaction and SQL semantics. With Cloud Spanner you don't need to choose between consistency and horizontal scaling — you get both.

Date-like object used to represent Cloud Spanner Dates. DATE types represent a logical calendar date, independent of time zone. DATE values do not represent a specific 24-hour period. Rather, a given DATE value represents a different 24-hour period when interpreted in a different time zone. Because of this, all values passed to will be interpreted as local time.

To represent an absolute point in time, use Spanner.timestamp().

Struct

Create a Table object to interact with a table in a Cloud Spanner database.

This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry.

Calling either or signals that the transaction is finished and no further requests will be made. If for some reason you decide not to call one of the aformentioned methods, call to release the underlying Session.

Running a transaction via or automatically re-runs the transaction on ABORTED errors.

returns a plain Transaction object, requiring the user to retry manually.

Snapshot

Cloud Spanner Database Admin API

The Cloud Spanner Database Admin API can be used to: * create, drop, and list databases * update the schema of pre-existing databases * create, delete and list backups for a database * restore a database from an existing backup v1

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. v1

Cloud Spanner API

The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases. v1

Properties of a ClientLibrarySettings.

Properties of a CommonLanguageSettings.

Properties of a CppSettings.

Properties of a CustomHttpPattern.

Properties of a DotnetSettings.

Properties of a GoSettings.

Properties of a Http.

Properties of a HttpRule.

Properties of a JavaSettings.

Properties of a MethodSettings.

Properties of a NodeSettings.

Properties of a PhpSettings.

Properties of a Publishing.

Properties of a PythonSettings.

Properties of a ResourceDescriptor.

Properties of a ResourceReference.

Properties of a RubySettings.

Properties of a LongRunning.

Properties of an AuditConfig.

Properties of an AuditConfigDelta.

Properties of an AuditLogConfig.

Properties of a Binding.

Properties of a BindingDelta.

Properties of a GetIamPolicyRequest.

Properties of a GetPolicyOptions.

Properties of a Policy.

Properties of a PolicyDelta.

Properties of a SetIamPolicyRequest.

Properties of a TestIamPermissionsRequest.

Properties of a TestIamPermissionsResponse.

Properties of a CancelOperationRequest.

Properties of a DeleteOperationRequest.

Properties of a GetOperationRequest.

Properties of a ListOperationsRequest.

Properties of a ListOperationsResponse.

Properties of an Operation.

Properties of an OperationInfo.

Properties of a WaitOperationRequest.

Properties of an ExtensionRange.

Properties of a ReservedRange.

Properties of an EnumReservedRange.

Properties of a Declaration.

Properties of a FeatureSetEditionDefault.

Properties of an EditionDefault.

Properties of an Annotation.

Properties of an Any.

Properties of a DescriptorProto.

Properties of a Duration.

Properties of an Empty.

Properties of an EnumDescriptorProto.

Properties of an EnumOptions.

Properties of an EnumValueDescriptorProto.

Properties of an EnumValueOptions.

Properties of an ExtensionRangeOptions.

Properties of a FeatureSet.

Properties of a FeatureSetDefaults.

Properties of a FieldDescriptorProto.

Properties of a FieldMask.

Properties of a FieldOptions.

Properties of a FileDescriptorProto.

Properties of a FileDescriptorSet.

Properties of a FileOptions.

Properties of a GeneratedCodeInfo.

Properties of a ListValue.

Properties of a MessageOptions.

Properties of a MethodDescriptorProto.

Properties of a MethodOptions.

Properties of an OneofDescriptorProto.

Properties of an OneofOptions.

Properties of a ServiceDescriptorProto.

Properties of a ServiceOptions.

Properties of a SourceCodeInfo.

Properties of a Struct.

Properties of a Timestamp.

Properties of an UninterpretedOption.

Properties of a Value.

Properties of a Location.

Properties of a NamePart.

Properties of a FieldViolation.

Properties of a Link.

Properties of a BadRequest.

Properties of a DebugInfo.

Properties of an ErrorInfo.

Properties of a Help.

Properties of a LocalizedMessage.

Properties of a PreconditionFailure.

Properties of a QuotaFailure.

Properties of a RequestInfo.

Properties of a ResourceInfo.

Properties of a RetryInfo.

Properties of a Status.

Properties of a Violation.

Properties of a Violation.

Properties of a Backup.

Properties of a BackupInfo.

Properties of a CopyBackupEncryptionConfig.

Properties of a CopyBackupMetadata.

Properties of a CopyBackupRequest.

Properties of a CreateBackupEncryptionConfig.

Properties of a CreateBackupMetadata.

Properties of a CreateBackupRequest.

Properties of a CreateDatabaseMetadata.

Properties of a CreateDatabaseRequest.

Properties of a Database.

Properties of a DatabaseRole.

Properties of a DdlStatementActionInfo.

Properties of a DeleteBackupRequest.

Properties of a DropDatabaseRequest.

Properties of an EncryptionConfig.

Properties of an EncryptionInfo.

Properties of a GetBackupRequest.

Properties of a GetDatabaseDdlRequest.

Properties of a GetDatabaseDdlResponse.

Properties of a GetDatabaseRequest.

Properties of a ListBackupOperationsRequest.

Properties of a ListBackupOperationsResponse.

Properties of a ListBackupsRequest.

Properties of a ListBackupsResponse.

Properties of a ListDatabaseOperationsRequest.

Properties of a ListDatabaseOperationsResponse.

Properties of a ListDatabaseRolesRequest.

Properties of a ListDatabaseRolesResponse.

Properties of a ListDatabasesRequest.

Properties of a ListDatabasesResponse.

Properties of an OperationProgress.

Properties of an OptimizeRestoredDatabaseMetadata.

Properties of a RestoreDatabaseEncryptionConfig.

Properties of a RestoreDatabaseMetadata.

Properties of a RestoreDatabaseRequest.

Properties of a RestoreInfo.

Properties of an UpdateBackupRequest.

Properties of an UpdateDatabaseDdlMetadata.

Properties of an UpdateDatabaseDdlRequest.

Properties of an UpdateDatabaseMetadata.

Properties of an UpdateDatabaseRequest.

Properties of an AutoscalingLimits.

Properties of an AutoscalingTargets.

Properties of an AutoscalingConfig.

Properties of a CreateInstanceConfigMetadata.

Properties of a CreateInstanceConfigRequest.

Properties of a CreateInstanceMetadata.

Properties of a CreateInstanceRequest.

Properties of a DeleteInstanceConfigRequest.

Properties of a DeleteInstanceRequest.

Properties of a GetInstanceConfigRequest.

Properties of a GetInstanceRequest.

Properties of an Instance.

Properties of an InstanceConfig.

Properties of a ListInstanceConfigOperationsRequest.

Properties of a ListInstanceConfigOperationsResponse.

Properties of a ListInstanceConfigsRequest.

Properties of a ListInstanceConfigsResponse.

Properties of a ListInstancesRequest.

Properties of a ListInstancesResponse.

Properties of an OperationProgress.

Properties of a ReplicaInfo.

Properties of an UpdateInstanceConfigMetadata.

Properties of an UpdateInstanceConfigRequest.

Properties of an UpdateInstanceMetadata.

Properties of an UpdateInstanceRequest.

Properties of a MutationGroup.

Properties of a CommitStats.

Properties of an ExcludeReplicas.

Properties of an IncludeReplicas.

Properties of a ReplicaSelection.

Properties of a Statement.

Properties of a QueryOptions.

Properties of a BatchCreateSessionsRequest.

Properties of a BatchCreateSessionsResponse.

Properties of a BatchWriteRequest.

Properties of a BatchWriteResponse.

Properties of a BeginTransactionRequest.

Properties of a CommitRequest.

Properties of a CommitResponse.

Properties of a CreateSessionRequest.

Properties of a DeleteSessionRequest.

Properties of a DirectedReadOptions.

Properties of an ExecuteBatchDmlRequest.

Properties of an ExecuteBatchDmlResponse.

Properties of an ExecuteSqlRequest.

Properties of a GetSessionRequest.

Properties of a KeyRange.

Properties of a KeySet.

Properties of a ListSessionsRequest.

Properties of a ListSessionsResponse.

Properties of a Mutation.

Properties of a PartialResultSet.

Properties of a Partition.

Properties of a PartitionOptions.

Properties of a PartitionQueryRequest.

Properties of a PartitionReadRequest.

Properties of a PartitionResponse.

Properties of a PlanNode.

Properties of a QueryPlan.

Properties of a ReadRequest.

Properties of a RequestOptions.

Properties of a ResultSet.

Properties of a ResultSetMetadata.

Properties of a ResultSetStats.

Properties of a RollbackRequest.

Properties of a Session.

Properties of a StructType.

Properties of a Transaction.

Properties of a TransactionOptions.

Properties of a TransactionSelector.

Properties of a Type.

Properties of a Delete.

Properties of a Write.

Properties of a ChildLink.

Properties of a ShortRepresentation.

Properties of a Field.

Properties of a PartitionedDml.

Properties of a ReadOnly.

Properties of a ReadWrite.

Properties of an Expr.

Session pool configuration options. {boolean} [routeToLeaderEnabled=True] If set to false leader aware routing will be disabled. Disabling leader aware routing would route all requests in RW/PDML transactions to any region. {google.spanner.v1.IDirectedReadOptions} [directedReadOptions] Sets the DirectedReadOptions for all ReadRequests and ExecuteSqlRequests for the Client. Indicates which replicas or regions should be used for non-transactional reads or queries. DirectedReadOptions won't be set for readWrite transactions"

ClientLibraryDestination enum.

ClientLibraryOrganization enum.

FieldBehavior enum.

LaunchStage enum.

History enum.

Style enum.

Action enum.

LogType enum.

Action enum.

Edition enum.

VerificationState enum.

EnumType enum.

FieldPresence enum.

JsonFormat enum.

MessageEncoding enum.

RepeatedFieldEncoding enum.

Utf8Validation enum.

Label enum.

Type enum.

CType enum.

JSType enum.

OptionRetention enum.

OptionTargetType enum.

OptimizeMode enum.

Semantic enum.

IdempotencyLevel enum.

NullValue enum.

State enum.

EncryptionType enum.

EncryptionType enum.

State enum.

DatabaseDialect enum.

Type enum.

EncryptionType enum.

RestoreSourceType enum.

State enum.

State enum.

Type enum.

ReplicaType enum.

Type enum.

QueryMode enum.

Kind enum.

Priority enum.

ReadLockMode enum.

TypeAnnotationCode enum.

TypeCode enum.