The Cloud Spanner Database Admin API can be used to: * create, drop, and list databases * update the schema of pre-existing databases * create, delete, copy 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

v1.SpannerExecutorProxyClient

Service that executes SpannerActions asynchronously. v1

Variables

_default

_default: {
    v1: typeof v1;
    DatabaseAdminClient: typeof v1.DatabaseAdminClient;
    InstanceAdminClient: typeof v1.InstanceAdminClient;
    SpannerClient: typeof v1.SpannerClient;
    SpannerExecutorProxyClient: typeof v1.SpannerExecutorProxyClient;
}

DatabaseAdminClient

DatabaseAdminClient: typeof v1.DatabaseAdminClient

InstanceAdminClient

InstanceAdminClient: typeof v1.InstanceAdminClient

SpannerClient

SpannerClient: typeof v1.SpannerClient

SpannerExecutorProxyClient

SpannerExecutorProxyClient: typeof v1.SpannerExecutorProxyClient

Type Aliases

DatabaseAdminClient

type DatabaseAdminClient = v1.DatabaseAdminClient;

InstanceAdminClient

type InstanceAdminClient = v1.InstanceAdminClient;

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

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

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

type DeleteBackupScheduleCallback = (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.GetBackupScheduleCallback

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

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

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

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

type CreateInstancePartitionCallback = (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.DeleteInstancePartitionCallback

type DeleteInstancePartitionCallback = (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.GetInstancePartitionCallback

type GetInstancePartitionCallback = (error: (Error|null), response?: google.spanner.admin.instance.v1.InstancePartition) => 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.ListInstancePartitionOperationsCallback

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

Callback as used by .

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

type ListInstancePartitionsCallback = (error: (Error|null), response?: google.spanner.admin.instance.v1.ListInstancePartitionsResponse) => 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.MoveInstanceCallback

type MoveInstanceCallback = (error: (Error|null), response?: google.longrunning.Operation) => 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.admin.instance.v1.InstanceAdmin.UpdateInstancePartitionCallback

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

Callback as used by .

protos.google.spanner.executor.v1.SpannerExecutorProxy.ExecuteActionAsyncCallback

type ExecuteActionAsyncCallback = (error: (Error|null), response?: google.spanner.executor.v1.SpannerAsyncActionResponse) => 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.FetchCacheUpdateCallback

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

SpannerClient

type SpannerClient = v1.SpannerClient;

SpannerExecutorProxyClient

type SpannerExecutorProxyClient = v1.SpannerExecutorProxyClient;

Package @google-cloud/spanner-api (0.2.0) Stay organized with collections Save and categorize content based on your preferences.

Classes

Package @google-cloud/spanner-api (0.2.0)