DatabaseAdmin

google.spanner.admin.database.v1. DatabaseAdmin

Represents a DatabaseAdmin

Constructor

new DatabaseAdmin(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new DatabaseAdmin service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {DatabaseAdmin}

Creates new DatabaseAdmin service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

createBackup(request, callback) → {undefined}

Calls CreateBackup.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.ICreateBackupRequest

CreateBackupRequest message or plain object

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

Node-style callback called with the error, if any, and Operation

createBackup(request) → {Promise.<google.longrunning.Operation>}

Calls CreateBackup.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.ICreateBackupRequest

CreateBackupRequest message or plain object

createDatabase(request, callback) → {undefined}

Calls CreateDatabase.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.ICreateDatabaseRequest

CreateDatabaseRequest message or plain object

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

Node-style callback called with the error, if any, and Operation

createDatabase(request) → {Promise.<google.longrunning.Operation>}

Calls CreateDatabase.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.ICreateDatabaseRequest

CreateDatabaseRequest message or plain object

deleteBackup(request, callback) → {undefined}

Calls DeleteBackup.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IDeleteBackupRequest

DeleteBackupRequest message or plain object

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

Node-style callback called with the error, if any, and Empty

deleteBackup(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteBackup.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IDeleteBackupRequest

DeleteBackupRequest message or plain object

dropDatabase(request, callback) → {undefined}

Calls DropDatabase.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IDropDatabaseRequest

DropDatabaseRequest message or plain object

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

Node-style callback called with the error, if any, and Empty

dropDatabase(request) → {Promise.<google.protobuf.Empty>}

Calls DropDatabase.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IDropDatabaseRequest

DropDatabaseRequest message or plain object

getBackup(request, callback) → {undefined}

Calls GetBackup.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IGetBackupRequest

GetBackupRequest message or plain object

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

Node-style callback called with the error, if any, and Backup

getBackup(request) → {Promise.<google.spanner.admin.database.v1.Backup>}

Calls GetBackup.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IGetBackupRequest

GetBackupRequest message or plain object

getDatabase(request, callback) → {undefined}

Calls GetDatabase.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IGetDatabaseRequest

GetDatabaseRequest message or plain object

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

Node-style callback called with the error, if any, and Database

getDatabase(request) → {Promise.<google.spanner.admin.database.v1.Database>}

Calls GetDatabase.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IGetDatabaseRequest

GetDatabaseRequest message or plain object

getDatabaseDdl(request, callback) → {undefined}

Calls GetDatabaseDdl.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IGetDatabaseDdlRequest

GetDatabaseDdlRequest message or plain object

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

Node-style callback called with the error, if any, and GetDatabaseDdlResponse

getDatabaseDdl(request) → {Promise.<google.spanner.admin.database.v1.GetDatabaseDdlResponse>}

Calls GetDatabaseDdl.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IGetDatabaseDdlRequest

GetDatabaseDdlRequest message or plain object

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

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

Node-style callback called with the error, if any, and Policy

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

listBackupOperations(request, callback) → {undefined}

Calls ListBackupOperations.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IListBackupOperationsRequest

ListBackupOperationsRequest message or plain object

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

Node-style callback called with the error, if any, and ListBackupOperationsResponse

listBackupOperations(request) → {Promise.<google.spanner.admin.database.v1.ListBackupOperationsResponse>}

Calls ListBackupOperations.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IListBackupOperationsRequest

ListBackupOperationsRequest message or plain object

listBackups(request, callback) → {undefined}

Calls ListBackups.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IListBackupsRequest

ListBackupsRequest message or plain object

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

Node-style callback called with the error, if any, and ListBackupsResponse

listBackups(request) → {Promise.<google.spanner.admin.database.v1.ListBackupsResponse>}

Calls ListBackups.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IListBackupsRequest

ListBackupsRequest message or plain object

listDatabaseOperations(request, callback) → {undefined}

Calls ListDatabaseOperations.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IListDatabaseOperationsRequest

ListDatabaseOperationsRequest message or plain object

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

Node-style callback called with the error, if any, and ListDatabaseOperationsResponse

listDatabaseOperations(request) → {Promise.<google.spanner.admin.database.v1.ListDatabaseOperationsResponse>}

Calls ListDatabaseOperations.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IListDatabaseOperationsRequest

ListDatabaseOperationsRequest message or plain object

listDatabases(request, callback) → {undefined}

Calls ListDatabases.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IListDatabasesRequest

ListDatabasesRequest message or plain object

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

Node-style callback called with the error, if any, and ListDatabasesResponse

listDatabases(request) → {Promise.<google.spanner.admin.database.v1.ListDatabasesResponse>}

Calls ListDatabases.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IListDatabasesRequest

ListDatabasesRequest message or plain object

restoreDatabase(request, callback) → {undefined}

Calls RestoreDatabase.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IRestoreDatabaseRequest

RestoreDatabaseRequest message or plain object

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

Node-style callback called with the error, if any, and Operation

restoreDatabase(request) → {Promise.<google.longrunning.Operation>}

Calls RestoreDatabase.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IRestoreDatabaseRequest

RestoreDatabaseRequest message or plain object

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

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

Node-style callback called with the error, if any, and Policy

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

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

Node-style callback called with the error, if any, and TestIamPermissionsResponse

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

updateBackup(request, callback) → {undefined}

Calls UpdateBackup.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IUpdateBackupRequest

UpdateBackupRequest message or plain object

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

Node-style callback called with the error, if any, and Backup

updateBackup(request) → {Promise.<google.spanner.admin.database.v1.Backup>}

Calls UpdateBackup.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IUpdateBackupRequest

UpdateBackupRequest message or plain object

updateDatabaseDdl(request, callback) → {undefined}

Calls UpdateDatabaseDdl.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest

UpdateDatabaseDdlRequest message or plain object

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

Node-style callback called with the error, if any, and Operation

updateDatabaseDdl(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateDatabaseDdl.

Parameters:
Name Type Description
request google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest

UpdateDatabaseDdlRequest message or plain object

Type Definitions

CreateBackupCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#createBackup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

CreateDatabaseCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#createDatabase.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

DeleteBackupCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#deleteBackup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DropDatabaseCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#dropDatabase.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetBackupCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#getBackup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.spanner.admin.database.v1.Backup <optional>

Backup

GetDatabaseCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#getDatabase.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.spanner.admin.database.v1.Database <optional>

Database

GetDatabaseDdlCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#getDatabaseDdl.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.spanner.admin.database.v1.GetDatabaseDdlResponse <optional>

GetDatabaseDdlResponse

GetIamPolicyCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

ListBackupOperationsCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#listBackupOperations.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.spanner.admin.database.v1.ListBackupOperationsResponse <optional>

ListBackupOperationsResponse

ListBackupsCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#listBackups.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.spanner.admin.database.v1.ListBackupsResponse <optional>

ListBackupsResponse

ListDatabaseOperationsCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#listDatabaseOperations.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.spanner.admin.database.v1.ListDatabaseOperationsResponse <optional>

ListDatabaseOperationsResponse

ListDatabasesCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#listDatabases.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.spanner.admin.database.v1.ListDatabasesResponse <optional>

ListDatabasesResponse

RestoreDatabaseCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#restoreDatabase.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

SetIamPolicyCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.TestIamPermissionsResponse <optional>

TestIamPermissionsResponse

UpdateBackupCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#updateBackup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.spanner.admin.database.v1.Backup <optional>

Backup

UpdateDatabaseDdlCallback(error, responseopt)

Callback as used by google.spanner.admin.database.v1.DatabaseAdmin#updateDatabaseDdl.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation