Package @google-cloud/spanner (7.1.0)

Classes

Backup

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.

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.

InstanceConfig

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

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

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

protos.google.api.ClientLibrarySettings

Represents a ClientLibrarySettings.

protos.google.api.CommonLanguageSettings

Represents a CommonLanguageSettings.

protos.google.api.CppSettings

Represents a CppSettings.

protos.google.api.CustomHttpPattern

Represents a CustomHttpPattern.

protos.google.api.DotnetSettings

Represents a DotnetSettings.

protos.google.api.GoSettings

Represents a GoSettings.

protos.google.api.Http

Represents a Http.

protos.google.api.HttpRule

Represents a HttpRule.

protos.google.api.JavaSettings

Represents a JavaSettings.

protos.google.api.MethodSettings

Represents a MethodSettings.

protos.google.api.MethodSettings.LongRunning

Represents a LongRunning.

protos.google.api.NodeSettings

Represents a NodeSettings.

protos.google.api.PhpSettings

Represents a PhpSettings.

protos.google.api.Publishing

Represents a Publishing.

protos.google.api.PythonSettings

Represents a PythonSettings.

protos.google.api.ResourceDescriptor

Represents a ResourceDescriptor.

protos.google.api.ResourceReference

Represents a ResourceReference.

protos.google.api.RubySettings

Represents a RubySettings.

protos.google.iam.v1.AuditConfig

Represents an AuditConfig.

protos.google.iam.v1.AuditConfigDelta

Represents an AuditConfigDelta.

protos.google.iam.v1.AuditLogConfig

Represents an AuditLogConfig.

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.ExtensionRangeOptions.Declaration

Represents a Declaration.

protos.google.protobuf.FeatureSet

Represents a FeatureSet.

protos.google.protobuf.FieldDescriptorProto

Represents a FieldDescriptorProto.

protos.google.protobuf.FieldMask

Represents a FieldMask.

protos.google.protobuf.FieldOptions

Represents a FieldOptions.

protos.google.protobuf.FieldOptions.EditionDefault

Represents an EditionDefault.

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.

protos.google.rpc.Help.Link

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

Represents a CopyBackupEncryptionConfig.

protos.google.spanner.admin.database.v1.CopyBackupMetadata

Represents a CopyBackupMetadata.

protos.google.spanner.admin.database.v1.CopyBackupRequest

Represents a CopyBackupRequest.

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

Represents a DatabaseRole.

protos.google.spanner.admin.database.v1.DdlStatementActionInfo

Represents a DdlStatementActionInfo.

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

Represents a ListDatabaseRolesRequest.

protos.google.spanner.admin.database.v1.ListDatabaseRolesResponse

Represents a ListDatabaseRolesResponse.

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

Represents an UpdateDatabaseMetadata.

protos.google.spanner.admin.database.v1.UpdateDatabaseRequest

Represents an UpdateDatabaseRequest.

protos.google.spanner.admin.instance.v1.AutoscalingConfig

Represents an AutoscalingConfig.

protos.google.spanner.admin.instance.v1.AutoscalingConfig.AutoscalingLimits

Represents an AutoscalingLimits.

protos.google.spanner.admin.instance.v1.AutoscalingConfig.AutoscalingTargets

Represents an AutoscalingTargets.

protos.google.spanner.admin.instance.v1.CreateInstanceConfigMetadata

Represents a CreateInstanceConfigMetadata.

protos.google.spanner.admin.instance.v1.CreateInstanceConfigRequest

Represents a CreateInstanceConfigRequest.

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

Represents a DeleteInstanceConfigRequest.

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

Represents a ListInstanceConfigOperationsRequest.

protos.google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse

Represents a ListInstanceConfigOperationsResponse.

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

Represents an OperationProgress.

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

Represents a ReplicaInfo.

protos.google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata

Represents an UpdateInstanceConfigMetadata.

protos.google.spanner.admin.instance.v1.UpdateInstanceConfigRequest

Represents an UpdateInstanceConfigRequest.

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

Represents a BatchWriteRequest.

protos.google.spanner.v1.BatchWriteRequest.MutationGroup

Represents a MutationGroup.

protos.google.spanner.v1.BatchWriteResponse

Represents a BatchWriteResponse.

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

Represents a DirectedReadOptions.

protos.google.spanner.v1.DirectedReadOptions.ExcludeReplicas

Represents an ExcludeReplicas.

protos.google.spanner.v1.DirectedReadOptions.IncludeReplicas

Represents an IncludeReplicas.

protos.google.spanner.v1.DirectedReadOptions.ReplicaSelection

Represents a ReplicaSelection.

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.

protos.google.spanner.v1.PlanNode.ChildLink

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.

SpannerDate

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

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 * update the schema of pre-existing databases * create, delete and list backups for a database * restore a database 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

Variables

_default

_default: {
    Spanner: typeof Spanner;
}

Type Aliases

EnumKey

export type EnumKey

Translates enum values to string keys.

Type Parameter
Type	Description
`E`

GetInstanceConfigCallback

export type GetInstanceConfigCallback = NormalCallback

GetInstanceConfigOperationsCallback

export type GetInstanceConfigOperationsCallback = PagedCallback

GetInstanceConfigOperationsOptions

export type GetInstanceConfigOperationsOptions = PagedOptionsWithFilter;

GetInstanceConfigOperationsResponse

export type GetInstanceConfigOperationsResponse = PagedResponse

GetInstanceConfigResponse

export type GetInstanceConfigResponse = [IInstanceConfig];

GetInstanceConfigsCallback

export type GetInstanceConfigsCallback = PagedCallback

GetInstanceConfigsOptions

export type GetInstanceConfigsOptions = PagedOptions;

GetInstanceConfigsResponse

export type GetInstanceConfigsResponse = PagedResponse

GetInstancesCallback

export type GetInstancesCallback = PagedCallback

GetInstancesOptions

export type GetInstancesOptions = PagedOptionsWithFilter;

GetInstancesResponse

export type GetInstancesResponse = PagedResponse

IOperation

export 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.CopyBackupCallback

type CopyBackupCallback = (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.ListDatabaseRolesCallback

type ListDatabaseRolesCallback = (error: (Error|null), response?: google.spanner.admin.database.v1.ListDatabaseRolesResponse) => 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.UpdateDatabaseCallback

type UpdateDatabaseCallback = (error: (Error|null), response?: google.longrunning.Operation) => 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.CreateInstanceConfigCallback

type CreateInstanceConfigCallback = (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.DeleteInstanceConfigCallback

type DeleteInstanceConfigCallback = (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.ListInstanceConfigOperationsCallback

type ListInstanceConfigOperationsCallback = (error: (Error|null), response?: google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse) => 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.admin.instance.v1.InstanceAdmin.UpdateInstanceConfigCallback

type UpdateInstanceConfigCallback = (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.BatchWriteCallback

type BatchWriteCallback = (error: (Error|null), response?: google.spanner.v1.BatchWriteResponse) => 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 type TranslateEnumKeys

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

Type Parameters
Type	Description
`T`
`U`
`E`