Package @google-cloud/spanner (5.15.2)

Classes

Backup

The Backup class represents a Cloud Spanner backup.

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

Database

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

Instance

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.

PartitionedDml

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

protos.google.api.CustomHttpPattern

Represents a CustomHttpPattern.

protos.google.api.Http

Represents a Http.

protos.google.api.HttpRule

Represents a HttpRule.

protos.google.api.ResourceDescriptor

Represents a ResourceDescriptor.

protos.google.api.ResourceReference

Represents a ResourceReference.

protos.google.iam.v1.AuditConfigDelta

Represents an AuditConfigDelta.

protos.google.iam.v1.Binding

Represents a Binding.

protos.google.iam.v1.BindingDelta

Represents a BindingDelta.

protos.google.iam.v1.GetIamPolicyRequest

Represents a GetIamPolicyRequest.

protos.google.iam.v1.GetPolicyOptions

Represents a GetPolicyOptions.

protos.google.iam.v1.IAMPolicy

Represents a IAMPolicy

protos.google.iam.v1.Policy

Represents a Policy.

protos.google.iam.v1.PolicyDelta

Represents a PolicyDelta.

protos.google.iam.v1.SetIamPolicyRequest

Represents a SetIamPolicyRequest.

protos.google.iam.v1.TestIamPermissionsRequest

Represents a TestIamPermissionsRequest.

protos.google.iam.v1.TestIamPermissionsResponse

Represents a TestIamPermissionsResponse.

protos.google.longrunning.CancelOperationRequest

Represents a CancelOperationRequest.

protos.google.longrunning.DeleteOperationRequest

Represents a DeleteOperationRequest.

protos.google.longrunning.GetOperationRequest

Represents a GetOperationRequest.

protos.google.longrunning.ListOperationsRequest

Represents a ListOperationsRequest.

protos.google.longrunning.ListOperationsResponse

Represents a ListOperationsResponse.

protos.google.longrunning.Operation

Represents an Operation.

protos.google.longrunning.OperationInfo

Represents an OperationInfo.

protos.google.longrunning.Operations

Represents an Operations

protos.google.longrunning.WaitOperationRequest

Represents a WaitOperationRequest.

protos.google.protobuf.Any

Represents an Any.

protos.google.protobuf.DescriptorProto

Represents a DescriptorProto.

protos.google.protobuf.DescriptorProto.ExtensionRange

Represents an ExtensionRange.

protos.google.protobuf.DescriptorProto.ReservedRange

Represents a ReservedRange.

protos.google.protobuf.Duration

Represents a Duration.

protos.google.protobuf.Empty

Represents an Empty.

protos.google.protobuf.EnumDescriptorProto

Represents an EnumDescriptorProto.

protos.google.protobuf.EnumDescriptorProto.EnumReservedRange

Represents an EnumReservedRange.

protos.google.protobuf.EnumOptions

Represents an EnumOptions.

protos.google.protobuf.EnumValueDescriptorProto

Represents an EnumValueDescriptorProto.

protos.google.protobuf.EnumValueOptions

Represents an EnumValueOptions.

protos.google.protobuf.ExtensionRangeOptions

Represents an ExtensionRangeOptions.

protos.google.protobuf.FieldDescriptorProto

Represents a FieldDescriptorProto.

protos.google.protobuf.FieldMask

Represents a FieldMask.

protos.google.protobuf.FieldOptions

Represents a FieldOptions.

protos.google.protobuf.FileDescriptorProto

Represents a FileDescriptorProto.

protos.google.protobuf.FileDescriptorSet

Represents a FileDescriptorSet.

protos.google.protobuf.FileOptions

Represents a FileOptions.

protos.google.protobuf.GeneratedCodeInfo

Represents a GeneratedCodeInfo.

protos.google.protobuf.GeneratedCodeInfo.Annotation

Represents an Annotation.

protos.google.protobuf.ListValue

Represents a ListValue.

protos.google.protobuf.MessageOptions

Represents a MessageOptions.

protos.google.protobuf.MethodDescriptorProto

Represents a MethodDescriptorProto.

protos.google.protobuf.MethodOptions

Represents a MethodOptions.

protos.google.protobuf.OneofDescriptorProto

Represents an OneofDescriptorProto.

protos.google.protobuf.OneofOptions

Represents an OneofOptions.

protos.google.protobuf.ServiceDescriptorProto

Represents a ServiceDescriptorProto.

protos.google.protobuf.ServiceOptions

Represents a ServiceOptions.

protos.google.protobuf.SourceCodeInfo

Represents a SourceCodeInfo.

protos.google.protobuf.SourceCodeInfo.Location

Represents a Location.

protos.google.protobuf.Struct

Represents a Struct.

protos.google.protobuf.Timestamp

Represents a Timestamp.

protos.google.protobuf.UninterpretedOption

Represents an UninterpretedOption.

protos.google.protobuf.UninterpretedOption.NamePart

Represents a NamePart.

protos.google.protobuf.Value

Represents a Value.

protos.google.rpc.BadRequest

Represents a BadRequest.

protos.google.rpc.BadRequest.FieldViolation

Represents a FieldViolation.

protos.google.rpc.DebugInfo

Represents a DebugInfo.

protos.google.rpc.ErrorInfo

Represents an ErrorInfo.

protos.google.rpc.Help

Represents a Help.

Represents a Link.

protos.google.rpc.LocalizedMessage

Represents a LocalizedMessage.

protos.google.rpc.PreconditionFailure

Represents a PreconditionFailure.

protos.google.rpc.PreconditionFailure.Violation

Represents a Violation.

protos.google.rpc.QuotaFailure

Represents a QuotaFailure.

protos.google.rpc.QuotaFailure.Violation

Represents a Violation.

protos.google.rpc.RequestInfo

Represents a RequestInfo.

protos.google.rpc.ResourceInfo

Represents a ResourceInfo.

protos.google.rpc.RetryInfo

Represents a RetryInfo.

protos.google.rpc.Status

Represents a Status.

protos.google.spanner.admin.database.v1.Backup

Represents a Backup.

protos.google.spanner.admin.database.v1.BackupInfo

Represents a BackupInfo.

protos.google.spanner.admin.database.v1.CreateBackupEncryptionConfig

Represents a CreateBackupEncryptionConfig.

protos.google.spanner.admin.database.v1.CreateBackupMetadata

Represents a CreateBackupMetadata.

protos.google.spanner.admin.database.v1.CreateBackupRequest

Represents a CreateBackupRequest.

protos.google.spanner.admin.database.v1.CreateDatabaseMetadata

Represents a CreateDatabaseMetadata.

protos.google.spanner.admin.database.v1.CreateDatabaseRequest

Represents a CreateDatabaseRequest.

protos.google.spanner.admin.database.v1.Database

Represents a Database.

protos.google.spanner.admin.database.v1.DatabaseAdmin

Represents a DatabaseAdmin

protos.google.spanner.admin.database.v1.DeleteBackupRequest

Represents a DeleteBackupRequest.

protos.google.spanner.admin.database.v1.DropDatabaseRequest

Represents a DropDatabaseRequest.

protos.google.spanner.admin.database.v1.EncryptionConfig

Represents an EncryptionConfig.

protos.google.spanner.admin.database.v1.EncryptionInfo

Represents an EncryptionInfo.

protos.google.spanner.admin.database.v1.GetBackupRequest

Represents a GetBackupRequest.

protos.google.spanner.admin.database.v1.GetDatabaseDdlRequest

Represents a GetDatabaseDdlRequest.

protos.google.spanner.admin.database.v1.GetDatabaseDdlResponse

Represents a GetDatabaseDdlResponse.

protos.google.spanner.admin.database.v1.GetDatabaseRequest

Represents a GetDatabaseRequest.

protos.google.spanner.admin.database.v1.ListBackupOperationsRequest

Represents a ListBackupOperationsRequest.

protos.google.spanner.admin.database.v1.ListBackupOperationsResponse

Represents a ListBackupOperationsResponse.

protos.google.spanner.admin.database.v1.ListBackupsRequest

Represents a ListBackupsRequest.

protos.google.spanner.admin.database.v1.ListBackupsResponse

Represents a ListBackupsResponse.

protos.google.spanner.admin.database.v1.ListDatabaseOperationsRequest

Represents a ListDatabaseOperationsRequest.

protos.google.spanner.admin.database.v1.ListDatabaseOperationsResponse

Represents a ListDatabaseOperationsResponse.

protos.google.spanner.admin.database.v1.ListDatabasesRequest

Represents a ListDatabasesRequest.

protos.google.spanner.admin.database.v1.ListDatabasesResponse

Represents a ListDatabasesResponse.

protos.google.spanner.admin.database.v1.OperationProgress

Represents an OperationProgress.

protos.google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata

Represents an OptimizeRestoredDatabaseMetadata.

protos.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig

Represents a RestoreDatabaseEncryptionConfig.

protos.google.spanner.admin.database.v1.RestoreDatabaseMetadata

Represents a RestoreDatabaseMetadata.

protos.google.spanner.admin.database.v1.RestoreDatabaseRequest

Represents a RestoreDatabaseRequest.

protos.google.spanner.admin.database.v1.RestoreInfo

Represents a RestoreInfo.

protos.google.spanner.admin.database.v1.UpdateBackupRequest

Represents an UpdateBackupRequest.

protos.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata

Represents an UpdateDatabaseDdlMetadata.

protos.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest

Represents an UpdateDatabaseDdlRequest.

protos.google.spanner.admin.instance.v1.CreateInstanceMetadata

Represents a CreateInstanceMetadata.

protos.google.spanner.admin.instance.v1.CreateInstanceRequest

Represents a CreateInstanceRequest.

protos.google.spanner.admin.instance.v1.DeleteInstanceRequest

Represents a DeleteInstanceRequest.

protos.google.spanner.admin.instance.v1.GetInstanceConfigRequest

Represents a GetInstanceConfigRequest.

protos.google.spanner.admin.instance.v1.GetInstanceRequest

Represents a GetInstanceRequest.

protos.google.spanner.admin.instance.v1.Instance

Represents an Instance.

protos.google.spanner.admin.instance.v1.InstanceAdmin

Represents an InstanceAdmin

protos.google.spanner.admin.instance.v1.InstanceConfig

Represents an InstanceConfig.

protos.google.spanner.admin.instance.v1.ListInstanceConfigsRequest

Represents a ListInstanceConfigsRequest.

protos.google.spanner.admin.instance.v1.ListInstanceConfigsResponse

Represents a ListInstanceConfigsResponse.

protos.google.spanner.admin.instance.v1.ListInstancesRequest

Represents a ListInstancesRequest.

protos.google.spanner.admin.instance.v1.ListInstancesResponse

Represents a ListInstancesResponse.

protos.google.spanner.admin.instance.v1.ReplicaInfo

Represents a ReplicaInfo.

protos.google.spanner.admin.instance.v1.UpdateInstanceMetadata

Represents an UpdateInstanceMetadata.

protos.google.spanner.admin.instance.v1.UpdateInstanceRequest

Represents an UpdateInstanceRequest.

protos.google.spanner.v1.BatchCreateSessionsRequest

Represents a BatchCreateSessionsRequest.

protos.google.spanner.v1.BatchCreateSessionsResponse

Represents a BatchCreateSessionsResponse.

protos.google.spanner.v1.BeginTransactionRequest

Represents a BeginTransactionRequest.

protos.google.spanner.v1.CommitRequest

Represents a CommitRequest.

protos.google.spanner.v1.CommitResponse

Represents a CommitResponse.

protos.google.spanner.v1.CommitResponse.CommitStats

Represents a CommitStats.

protos.google.spanner.v1.CreateSessionRequest

Represents a CreateSessionRequest.

protos.google.spanner.v1.DeleteSessionRequest

Represents a DeleteSessionRequest.

protos.google.spanner.v1.ExecuteBatchDmlRequest

Represents an ExecuteBatchDmlRequest.

protos.google.spanner.v1.ExecuteBatchDmlRequest.Statement

Represents a Statement.

protos.google.spanner.v1.ExecuteBatchDmlResponse

Represents an ExecuteBatchDmlResponse.

protos.google.spanner.v1.ExecuteSqlRequest

Represents an ExecuteSqlRequest.

protos.google.spanner.v1.ExecuteSqlRequest.QueryOptions

Represents a QueryOptions.

protos.google.spanner.v1.GetSessionRequest

Represents a GetSessionRequest.

protos.google.spanner.v1.KeyRange

Represents a KeyRange.

protos.google.spanner.v1.KeySet

Represents a KeySet.

protos.google.spanner.v1.ListSessionsRequest

Represents a ListSessionsRequest.

protos.google.spanner.v1.ListSessionsResponse

Represents a ListSessionsResponse.

protos.google.spanner.v1.Mutation

Represents a Mutation.

protos.google.spanner.v1.Mutation.Delete

Represents a Delete.

protos.google.spanner.v1.Mutation.Write

Represents a Write.

protos.google.spanner.v1.PartialResultSet

Represents a PartialResultSet.

protos.google.spanner.v1.Partition

Represents a Partition.

protos.google.spanner.v1.PartitionOptions

Represents a PartitionOptions.

protos.google.spanner.v1.PartitionQueryRequest

Represents a PartitionQueryRequest.

protos.google.spanner.v1.PartitionReadRequest

Represents a PartitionReadRequest.

protos.google.spanner.v1.PartitionResponse

Represents a PartitionResponse.

protos.google.spanner.v1.PlanNode

Represents a PlanNode.

Represents a ChildLink.

protos.google.spanner.v1.PlanNode.ShortRepresentation

Represents a ShortRepresentation.

protos.google.spanner.v1.QueryPlan

Represents a QueryPlan.

protos.google.spanner.v1.ReadRequest

Represents a ReadRequest.

protos.google.spanner.v1.RequestOptions

Represents a RequestOptions.

protos.google.spanner.v1.ResultSet

Represents a ResultSet.

protos.google.spanner.v1.ResultSetMetadata

Represents a ResultSetMetadata.

protos.google.spanner.v1.ResultSetStats

Represents a ResultSetStats.

protos.google.spanner.v1.RollbackRequest

Represents a RollbackRequest.

protos.google.spanner.v1.Session

Represents a Session.

protos.google.spanner.v1.Spanner

Represents a Spanner

protos.google.spanner.v1.StructType

Represents a StructType.

protos.google.spanner.v1.StructType.Field

Represents a Field.

protos.google.spanner.v1.Transaction

Represents a Transaction.

protos.google.spanner.v1.TransactionOptions

Represents a TransactionOptions.

protos.google.spanner.v1.TransactionOptions.PartitionedDml

Represents a PartitionedDml.

protos.google.spanner.v1.TransactionOptions.ReadOnly

Represents a ReadOnly.

protos.google.spanner.v1.TransactionOptions.ReadWrite

Represents a ReadWrite.

protos.google.spanner.v1.TransactionSelector

Represents a TransactionSelector.

protos.google.spanner.v1.Type

Represents a Type.

protos.google.type.Expr

Represents an Expr.

Session

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

SessionPool

Class used to manage connections to Spanner.

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

{EventEmitter}

Snapshot

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

Spanner

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

Table

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

Transaction

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

v1.DatabaseAdminClient

Cloud Spanner Database Admin API

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

v1.InstanceAdminClient

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

v1.SpannerClient

Cloud Spanner API

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

Interfaces

CreateInstanceRequest

GetInstanceConfigOptions

protos.google.api.ICustomHttpPattern

Properties of a CustomHttpPattern.

protos.google.api.IHttp

Properties of a Http.

protos.google.api.IHttpRule

Properties of a HttpRule.

protos.google.api.IResourceDescriptor

Properties of a ResourceDescriptor.

protos.google.api.IResourceReference

Properties of a ResourceReference.

protos.google.iam.v1.IAuditConfigDelta

Properties of an AuditConfigDelta.

protos.google.iam.v1.IBinding

Properties of a Binding.

protos.google.iam.v1.IBindingDelta

Properties of a BindingDelta.

protos.google.iam.v1.IGetIamPolicyRequest

Properties of a GetIamPolicyRequest.

protos.google.iam.v1.IGetPolicyOptions

Properties of a GetPolicyOptions.

protos.google.iam.v1.IPolicy

Properties of a Policy.

protos.google.iam.v1.IPolicyDelta

Properties of a PolicyDelta.

protos.google.iam.v1.ISetIamPolicyRequest

Properties of a SetIamPolicyRequest.

protos.google.iam.v1.ITestIamPermissionsRequest

Properties of a TestIamPermissionsRequest.

protos.google.iam.v1.ITestIamPermissionsResponse

Properties of a TestIamPermissionsResponse.

protos.google.longrunning.ICancelOperationRequest

Properties of a CancelOperationRequest.

protos.google.longrunning.IDeleteOperationRequest

Properties of a DeleteOperationRequest.

protos.google.longrunning.IGetOperationRequest

Properties of a GetOperationRequest.

protos.google.longrunning.IListOperationsRequest

Properties of a ListOperationsRequest.

protos.google.longrunning.IListOperationsResponse

Properties of a ListOperationsResponse.

protos.google.longrunning.IOperation

Properties of an Operation.

protos.google.longrunning.IOperationInfo

Properties of an OperationInfo.

protos.google.longrunning.IWaitOperationRequest

Properties of a WaitOperationRequest.

protos.google.protobuf.DescriptorProto.IExtensionRange

Properties of an ExtensionRange.

protos.google.protobuf.DescriptorProto.IReservedRange

Properties of a ReservedRange.

protos.google.protobuf.EnumDescriptorProto.IEnumReservedRange

Properties of an EnumReservedRange.

protos.google.protobuf.GeneratedCodeInfo.IAnnotation

Properties of an Annotation.

protos.google.protobuf.IAny

Properties of an Any.

protos.google.protobuf.IDescriptorProto

Properties of a DescriptorProto.

protos.google.protobuf.IDuration

Properties of a Duration.

protos.google.protobuf.IEmpty

Properties of an Empty.

protos.google.protobuf.IEnumDescriptorProto

Properties of an EnumDescriptorProto.

protos.google.protobuf.IEnumOptions

Properties of an EnumOptions.

protos.google.protobuf.IEnumValueDescriptorProto

Properties of an EnumValueDescriptorProto.

protos.google.protobuf.IEnumValueOptions

Properties of an EnumValueOptions.

protos.google.protobuf.IExtensionRangeOptions

Properties of an ExtensionRangeOptions.

protos.google.protobuf.IFieldDescriptorProto

Properties of a FieldDescriptorProto.

protos.google.protobuf.IFieldMask

Properties of a FieldMask.

protos.google.protobuf.IFieldOptions

Properties of a FieldOptions.

protos.google.protobuf.IFileDescriptorProto

Properties of a FileDescriptorProto.

protos.google.protobuf.IFileDescriptorSet

Properties of a FileDescriptorSet.

protos.google.protobuf.IFileOptions

Properties of a FileOptions.

protos.google.protobuf.IGeneratedCodeInfo

Properties of a GeneratedCodeInfo.

protos.google.protobuf.IListValue

Properties of a ListValue.

protos.google.protobuf.IMessageOptions

Properties of a MessageOptions.

protos.google.protobuf.IMethodDescriptorProto

Properties of a MethodDescriptorProto.

protos.google.protobuf.IMethodOptions

Properties of a MethodOptions.

protos.google.protobuf.IOneofDescriptorProto

Properties of an OneofDescriptorProto.

protos.google.protobuf.IOneofOptions

Properties of an OneofOptions.

protos.google.protobuf.IServiceDescriptorProto

Properties of a ServiceDescriptorProto.

protos.google.protobuf.IServiceOptions

Properties of a ServiceOptions.

protos.google.protobuf.ISourceCodeInfo

Properties of a SourceCodeInfo.

protos.google.protobuf.IStruct

Properties of a Struct.

protos.google.protobuf.ITimestamp

Properties of a Timestamp.

protos.google.protobuf.IUninterpretedOption

Properties of an UninterpretedOption.

protos.google.protobuf.IValue

Properties of a Value.

protos.google.protobuf.SourceCodeInfo.ILocation

Properties of a Location.

protos.google.protobuf.UninterpretedOption.INamePart

Properties of a NamePart.

protos.google.rpc.BadRequest.IFieldViolation

Properties of a FieldViolation.

Properties of a Link.

protos.google.rpc.IBadRequest

Properties of a BadRequest.

protos.google.rpc.IDebugInfo

Properties of a DebugInfo.

protos.google.rpc.IErrorInfo

Properties of an ErrorInfo.

protos.google.rpc.IHelp

Properties of a Help.

protos.google.rpc.ILocalizedMessage

Properties of a LocalizedMessage.

protos.google.rpc.IPreconditionFailure

Properties of a PreconditionFailure.

protos.google.rpc.IQuotaFailure

Properties of a QuotaFailure.

protos.google.rpc.IRequestInfo

Properties of a RequestInfo.

protos.google.rpc.IResourceInfo

Properties of a ResourceInfo.

protos.google.rpc.IRetryInfo

Properties of a RetryInfo.

protos.google.rpc.IStatus

Properties of a Status.

protos.google.rpc.PreconditionFailure.IViolation

Properties of a Violation.

protos.google.rpc.QuotaFailure.IViolation

Properties of a Violation.

protos.google.spanner.admin.database.v1.IBackup

Properties of a Backup.

protos.google.spanner.admin.database.v1.IBackupInfo

Properties of a BackupInfo.

protos.google.spanner.admin.database.v1.ICreateBackupEncryptionConfig

Properties of a CreateBackupEncryptionConfig.

protos.google.spanner.admin.database.v1.ICreateBackupMetadata

Properties of a CreateBackupMetadata.

protos.google.spanner.admin.database.v1.ICreateBackupRequest

Properties of a CreateBackupRequest.

protos.google.spanner.admin.database.v1.ICreateDatabaseMetadata

Properties of a CreateDatabaseMetadata.

protos.google.spanner.admin.database.v1.ICreateDatabaseRequest

Properties of a CreateDatabaseRequest.

protos.google.spanner.admin.database.v1.IDatabase

Properties of a Database.

protos.google.spanner.admin.database.v1.IDeleteBackupRequest

Properties of a DeleteBackupRequest.

protos.google.spanner.admin.database.v1.IDropDatabaseRequest

Properties of a DropDatabaseRequest.

protos.google.spanner.admin.database.v1.IEncryptionConfig

Properties of an EncryptionConfig.

protos.google.spanner.admin.database.v1.IEncryptionInfo

Properties of an EncryptionInfo.

protos.google.spanner.admin.database.v1.IGetBackupRequest

Properties of a GetBackupRequest.

protos.google.spanner.admin.database.v1.IGetDatabaseDdlRequest

Properties of a GetDatabaseDdlRequest.

protos.google.spanner.admin.database.v1.IGetDatabaseDdlResponse

Properties of a GetDatabaseDdlResponse.

protos.google.spanner.admin.database.v1.IGetDatabaseRequest

Properties of a GetDatabaseRequest.

protos.google.spanner.admin.database.v1.IListBackupOperationsRequest

Properties of a ListBackupOperationsRequest.

protos.google.spanner.admin.database.v1.IListBackupOperationsResponse

Properties of a ListBackupOperationsResponse.

protos.google.spanner.admin.database.v1.IListBackupsRequest

Properties of a ListBackupsRequest.

protos.google.spanner.admin.database.v1.IListBackupsResponse

Properties of a ListBackupsResponse.

protos.google.spanner.admin.database.v1.IListDatabaseOperationsRequest

Properties of a ListDatabaseOperationsRequest.

protos.google.spanner.admin.database.v1.IListDatabaseOperationsResponse

Properties of a ListDatabaseOperationsResponse.

protos.google.spanner.admin.database.v1.IListDatabasesRequest

Properties of a ListDatabasesRequest.

protos.google.spanner.admin.database.v1.IListDatabasesResponse

Properties of a ListDatabasesResponse.

protos.google.spanner.admin.database.v1.IOperationProgress

Properties of an OperationProgress.

protos.google.spanner.admin.database.v1.IOptimizeRestoredDatabaseMetadata

Properties of an OptimizeRestoredDatabaseMetadata.

protos.google.spanner.admin.database.v1.IRestoreDatabaseEncryptionConfig

Properties of a RestoreDatabaseEncryptionConfig.

protos.google.spanner.admin.database.v1.IRestoreDatabaseMetadata

Properties of a RestoreDatabaseMetadata.

protos.google.spanner.admin.database.v1.IRestoreDatabaseRequest

Properties of a RestoreDatabaseRequest.

protos.google.spanner.admin.database.v1.IRestoreInfo

Properties of a RestoreInfo.

protos.google.spanner.admin.database.v1.IUpdateBackupRequest

Properties of an UpdateBackupRequest.

protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata

Properties of an UpdateDatabaseDdlMetadata.

protos.google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest

Properties of an UpdateDatabaseDdlRequest.

protos.google.spanner.admin.instance.v1.ICreateInstanceMetadata

Properties of a CreateInstanceMetadata.

protos.google.spanner.admin.instance.v1.ICreateInstanceRequest

Properties of a CreateInstanceRequest.

protos.google.spanner.admin.instance.v1.IDeleteInstanceRequest

Properties of a DeleteInstanceRequest.

protos.google.spanner.admin.instance.v1.IGetInstanceConfigRequest

Properties of a GetInstanceConfigRequest.

protos.google.spanner.admin.instance.v1.IGetInstanceRequest

Properties of a GetInstanceRequest.

protos.google.spanner.admin.instance.v1.IInstance

Properties of an Instance.

protos.google.spanner.admin.instance.v1.IInstanceConfig

Properties of an InstanceConfig.

protos.google.spanner.admin.instance.v1.IListInstanceConfigsRequest

Properties of a ListInstanceConfigsRequest.

protos.google.spanner.admin.instance.v1.IListInstanceConfigsResponse

Properties of a ListInstanceConfigsResponse.

protos.google.spanner.admin.instance.v1.IListInstancesRequest

Properties of a ListInstancesRequest.

protos.google.spanner.admin.instance.v1.IListInstancesResponse

Properties of a ListInstancesResponse.

protos.google.spanner.admin.instance.v1.IReplicaInfo

Properties of a ReplicaInfo.

protos.google.spanner.admin.instance.v1.IUpdateInstanceMetadata

Properties of an UpdateInstanceMetadata.

protos.google.spanner.admin.instance.v1.IUpdateInstanceRequest

Properties of an UpdateInstanceRequest.

protos.google.spanner.v1.CommitResponse.ICommitStats

Properties of a CommitStats.

protos.google.spanner.v1.ExecuteBatchDmlRequest.IStatement

Properties of a Statement.

protos.google.spanner.v1.ExecuteSqlRequest.IQueryOptions

Properties of a QueryOptions.

protos.google.spanner.v1.IBatchCreateSessionsRequest

Properties of a BatchCreateSessionsRequest.

protos.google.spanner.v1.IBatchCreateSessionsResponse

Properties of a BatchCreateSessionsResponse.

protos.google.spanner.v1.IBeginTransactionRequest

Properties of a BeginTransactionRequest.

protos.google.spanner.v1.ICommitRequest

Properties of a CommitRequest.

protos.google.spanner.v1.ICommitResponse

Properties of a CommitResponse.

protos.google.spanner.v1.ICreateSessionRequest

Properties of a CreateSessionRequest.

protos.google.spanner.v1.IDeleteSessionRequest

Properties of a DeleteSessionRequest.

protos.google.spanner.v1.IExecuteBatchDmlRequest

Properties of an ExecuteBatchDmlRequest.

protos.google.spanner.v1.IExecuteBatchDmlResponse

Properties of an ExecuteBatchDmlResponse.

protos.google.spanner.v1.IExecuteSqlRequest

Properties of an ExecuteSqlRequest.

protos.google.spanner.v1.IGetSessionRequest

Properties of a GetSessionRequest.

protos.google.spanner.v1.IKeyRange

Properties of a KeyRange.

protos.google.spanner.v1.IKeySet

Properties of a KeySet.

protos.google.spanner.v1.IListSessionsRequest

Properties of a ListSessionsRequest.

protos.google.spanner.v1.IListSessionsResponse

Properties of a ListSessionsResponse.

protos.google.spanner.v1.IMutation

Properties of a Mutation.

protos.google.spanner.v1.IPartialResultSet

Properties of a PartialResultSet.

protos.google.spanner.v1.IPartition

Properties of a Partition.

protos.google.spanner.v1.IPartitionOptions

Properties of a PartitionOptions.

protos.google.spanner.v1.IPartitionQueryRequest

Properties of a PartitionQueryRequest.

protos.google.spanner.v1.IPartitionReadRequest

Properties of a PartitionReadRequest.

protos.google.spanner.v1.IPartitionResponse

Properties of a PartitionResponse.

protos.google.spanner.v1.IPlanNode

Properties of a PlanNode.

protos.google.spanner.v1.IQueryPlan

Properties of a QueryPlan.

protos.google.spanner.v1.IReadRequest

Properties of a ReadRequest.

protos.google.spanner.v1.IRequestOptions

Properties of a RequestOptions.

protos.google.spanner.v1.IResultSet

Properties of a ResultSet.

protos.google.spanner.v1.IResultSetMetadata

Properties of a ResultSetMetadata.

protos.google.spanner.v1.IResultSetStats

Properties of a ResultSetStats.

protos.google.spanner.v1.IRollbackRequest

Properties of a RollbackRequest.

protos.google.spanner.v1.ISession

Properties of a Session.

protos.google.spanner.v1.IStructType

Properties of a StructType.

protos.google.spanner.v1.ITransaction

Properties of a Transaction.

protos.google.spanner.v1.ITransactionOptions

Properties of a TransactionOptions.

protos.google.spanner.v1.ITransactionSelector

Properties of a TransactionSelector.

protos.google.spanner.v1.IType

Properties of a Type.

protos.google.spanner.v1.Mutation.IDelete

Properties of a Delete.

protos.google.spanner.v1.Mutation.IWrite

Properties of a Write.

Properties of a ChildLink.

protos.google.spanner.v1.PlanNode.IShortRepresentation

Properties of a ShortRepresentation.

protos.google.spanner.v1.StructType.IField

Properties of a Field.

protos.google.spanner.v1.TransactionOptions.IPartitionedDml

Properties of a PartitionedDml.

protos.google.spanner.v1.TransactionOptions.IReadOnly

Properties of a ReadOnly.

protos.google.spanner.v1.TransactionOptions.IReadWrite

Properties of a ReadWrite.

protos.google.type.IExpr

Properties of an Expr.

RequestConfig

SpannerOptions

Enums

protos.google.api.FieldBehavior

FieldBehavior enum.

protos.google.api.ResourceDescriptor.History

History enum.

protos.google.api.ResourceDescriptor.Style

Style enum.

protos.google.iam.v1.AuditConfigDelta.Action

Action enum.

protos.google.iam.v1.BindingDelta.Action

Action enum.

protos.google.protobuf.FieldDescriptorProto.Label

Label enum.

protos.google.protobuf.FieldDescriptorProto.Type

Type enum.

protos.google.protobuf.FieldOptions.CType

CType enum.

protos.google.protobuf.FieldOptions.JSType

JSType enum.

protos.google.protobuf.FileOptions.OptimizeMode

OptimizeMode enum.

protos.google.protobuf.MethodOptions.IdempotencyLevel

IdempotencyLevel enum.

protos.google.protobuf.NullValue

NullValue enum.

protos.google.spanner.admin.database.v1.Backup.State

State enum.

protos.google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType

EncryptionType enum.

protos.google.spanner.admin.database.v1.Database.State

State enum.

protos.google.spanner.admin.database.v1.EncryptionInfo.Type

Type enum.

protos.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType

EncryptionType enum.

protos.google.spanner.admin.database.v1.RestoreSourceType

RestoreSourceType enum.

protos.google.spanner.admin.instance.v1.Instance.State

State enum.

protos.google.spanner.admin.instance.v1.ReplicaInfo.ReplicaType

ReplicaType enum.

protos.google.spanner.v1.ExecuteSqlRequest.QueryMode

QueryMode enum.

protos.google.spanner.v1.PlanNode.Kind

Kind enum.

protos.google.spanner.v1.RequestOptions.Priority

Priority enum.

protos.google.spanner.v1.TypeCode

TypeCode enum.

Variables

_default

_default: {
    Spanner: typeof Spanner;
}

Type Aliases

EnumKey

export declare type EnumKey

Translates enum values to string keys.

Type Parameter
TypeDescription
E

GetInstanceConfigCallback

export declare type GetInstanceConfigCallback = NormalCallback

GetInstanceConfigResponse

export declare type GetInstanceConfigResponse = [IInstanceConfig];

GetInstanceConfigsCallback

export declare type GetInstanceConfigsCallback = PagedCallback

GetInstanceConfigsOptions

export declare type GetInstanceConfigsOptions = PagedOptions;

GetInstanceConfigsResponse

export declare type GetInstanceConfigsResponse = PagedResponse

GetInstancesCallback

export declare type GetInstancesCallback = PagedCallback

GetInstancesOptions

export declare type GetInstancesOptions = PagedOptionsWithFilter;

GetInstancesResponse

export declare type GetInstancesResponse = PagedResponse

IOperation

export declare type IOperation = instanceAdmin.longrunning.IOperation;

protos.google.iam.v1.IAMPolicy.GetIamPolicyCallback

type GetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;

Callback as used by .

protos.google.iam.v1.IAMPolicy.SetIamPolicyCallback

type SetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;

Callback as used by .

protos.google.iam.v1.IAMPolicy.TestIamPermissionsCallback

type TestIamPermissionsCallback = (error: (Error|null), response?: google.iam.v1.TestIamPermissionsResponse) => void;

Callback as used by .

protos.google.longrunning.Operations.CancelOperationCallback

type CancelOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.DeleteOperationCallback

type DeleteOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.GetOperationCallback

type GetOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.longrunning.Operations.ListOperationsCallback

type ListOperationsCallback = (error: (Error|null), response?: google.longrunning.ListOperationsResponse) => void;

Callback as used by .

protos.google.longrunning.Operations.WaitOperationCallback

type WaitOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.CreateBackupCallback

type CreateBackupCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabaseCallback

type CreateDatabaseCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackupCallback

type DeleteBackupCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.DropDatabaseCallback

type DropDatabaseCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.GetBackupCallback

type GetBackupCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.Backup) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseCallback

type GetDatabaseCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.Database) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdlCallback

type GetDatabaseDdlCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.GetDatabaseDdlResponse) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.GetIamPolicyCallback

type GetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperationsCallback

type ListBackupOperationsCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.ListBackupOperationsResponse) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.ListBackupsCallback

type ListBackupsCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.ListBackupsResponse) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperationsCallback

type ListDatabaseOperationsCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.ListDatabaseOperationsResponse) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.ListDatabasesCallback

type ListDatabasesCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.ListDatabasesResponse) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabaseCallback

type RestoreDatabaseCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.SetIamPolicyCallback

type SetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.TestIamPermissionsCallback

type TestIamPermissionsCallback = (error: (Error|null), response?: google.iam.v1.TestIamPermissionsResponse) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupCallback

type UpdateBackupCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.Backup) => void;

Callback as used by .

protos.google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdlCallback

type UpdateDatabaseDdlCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceCallback

type CreateInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstanceCallback

type DeleteInstanceCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.GetIamPolicyCallback

type GetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceCallback

type GetInstanceCallback = (error: (Error|null), response?: google.spanner.admin.instance.v1.Instance) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfigCallback

type GetInstanceConfigCallback = (error: (Error|null), response?: google.spanner.admin.instance.v1.InstanceConfig) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigsCallback

type ListInstanceConfigsCallback = (error: (Error|null), response?: google.spanner.admin.instance.v1.ListInstanceConfigsResponse) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.ListInstancesCallback

type ListInstancesCallback = (error: (Error|null), response?: google.spanner.admin.instance.v1.ListInstancesResponse) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.SetIamPolicyCallback

type SetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.TestIamPermissionsCallback

type TestIamPermissionsCallback = (error: (Error|null), response?: google.iam.v1.TestIamPermissionsResponse) => void;

Callback as used by .

protos.google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceCallback

type UpdateInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.BatchCreateSessionsCallback

type BatchCreateSessionsCallback = (error: (Error|null), response?: google.spanner.v1.BatchCreateSessionsResponse) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.BeginTransactionCallback

type BeginTransactionCallback = (error: (Error|null), response?: google.spanner.v1.Transaction) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.CommitCallback

type CommitCallback = (error: (Error|null), response?: google.spanner.v1.CommitResponse) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.CreateSessionCallback

type CreateSessionCallback = (error: (Error|null), response?: google.spanner.v1.Session) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.DeleteSessionCallback

type DeleteSessionCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.ExecuteBatchDmlCallback

type ExecuteBatchDmlCallback = (error: (Error|null), response?: google.spanner.v1.ExecuteBatchDmlResponse) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.ExecuteSqlCallback

type ExecuteSqlCallback = (error: (Error|null), response?: google.spanner.v1.ResultSet) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.ExecuteStreamingSqlCallback

type ExecuteStreamingSqlCallback = (error: (Error|null), response?: google.spanner.v1.PartialResultSet) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.GetSessionCallback

type GetSessionCallback = (error: (Error|null), response?: google.spanner.v1.Session) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.ListSessionsCallback

type ListSessionsCallback = (error: (Error|null), response?: google.spanner.v1.ListSessionsResponse) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.PartitionQueryCallback

type PartitionQueryCallback = (error: (Error|null), response?: google.spanner.v1.PartitionResponse) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.PartitionReadCallback

type PartitionReadCallback = (error: (Error|null), response?: google.spanner.v1.PartitionResponse) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.ReadCallback

type ReadCallback = (error: (Error|null), response?: google.spanner.v1.ResultSet) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.RollbackCallback

type RollbackCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.spanner.v1.Spanner.StreamingReadCallback

type StreamingReadCallback = (error: (Error|null), response?: google.spanner.v1.PartialResultSet) => void;

Callback as used by .

TranslateEnumKeys

export declare type TranslateEnumKeys

Translates an enum property of an object from enum value to enum key, leaving all other properties as-is.

Type Parameters
TypeDescription
T
U
E