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

copyBackup(request, callback) → {undefined}

Calls CopyBackup.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.ICopyBackupRequest	CopyBackupRequest message or plain object
`callback`	google.spanner.admin.database.v1.DatabaseAdmin.CopyBackupCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls CopyBackup.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.ICopyBackupRequest	CopyBackupRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

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

Returns:

Type	Description
undefined

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

Calls CreateBackup.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.ICreateBackupRequest	CreateBackupRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

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

Returns:

Type	Description
undefined

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

Calls CreateDatabase.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.ICreateDatabaseRequest	CreateDatabaseRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

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

Returns:

Type	Description
undefined

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

Calls DeleteBackup.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.IDeleteBackupRequest	DeleteBackupRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

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

Returns:

Type	Description
undefined

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

Calls DropDatabase.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.IDropDatabaseRequest	DropDatabaseRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

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

Returns:

Type	Description
undefined

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

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.Backup>	Promise

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

Returns:

Type	Description
undefined

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

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.Database>	Promise

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

Returns:

Type	Description
undefined

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

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.GetDatabaseDdlResponse>	Promise

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

Returns:

Type	Description
undefined

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

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.Policy>	Promise

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

Returns:

Type	Description
undefined

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

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.ListBackupOperationsResponse>	Promise

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

Returns:

Type	Description
undefined

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

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.ListBackupsResponse>	Promise

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

Returns:

Type	Description
undefined

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

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.ListDatabaseOperationsResponse>	Promise

listDatabaseRoles(request, callback) → {undefined}

Calls ListDatabaseRoles.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.IListDatabaseRolesRequest	ListDatabaseRolesRequest message or plain object
`callback`	google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRolesCallback	Node-style callback called with the error, if any, and ListDatabaseRolesResponse

Returns:

Type	Description
undefined

listDatabaseRoles(request) → {Promise.<google.spanner.admin.database.v1.ListDatabaseRolesResponse>}

Calls ListDatabaseRoles.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.IListDatabaseRolesRequest	ListDatabaseRolesRequest message or plain object

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.ListDatabaseRolesResponse>	Promise

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

Returns:

Type	Description
undefined

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

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.ListDatabasesResponse>	Promise

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

Returns:

Type	Description
undefined

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

Calls RestoreDatabase.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.IRestoreDatabaseRequest	RestoreDatabaseRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

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

Returns:

Type	Description
undefined

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

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.Policy>	Promise

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

Returns:

Type	Description
undefined

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

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.TestIamPermissionsResponse>	Promise

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

Returns:

Type	Description
undefined

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

Returns:

Type	Description
Promise.<google.spanner.admin.database.v1.Backup>	Promise

updateDatabase(request, callback) → {undefined}

Calls UpdateDatabase.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.IUpdateDatabaseRequest	UpdateDatabaseRequest message or plain object
`callback`	google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls UpdateDatabase.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.IUpdateDatabaseRequest	UpdateDatabaseRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

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

Returns:

Type	Description
undefined

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

Calls UpdateDatabaseDdl.

Parameters:

Name	Type	Description
`request`	google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest	UpdateDatabaseDdlRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

(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

Returns:

Type	Description
DatabaseAdmin	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CopyBackupCallback(error, responseopt)

Callback as used by copyBackup.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateBackupCallback(error, responseopt)

Callback as used by 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 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 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 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 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 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 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 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 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 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 listDatabaseOperations.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.spanner.admin.database.v1.ListDatabaseOperationsResponse	<optional>	ListDatabaseOperationsResponse

ListDatabaseRolesCallback(error, responseopt)

Callback as used by listDatabaseRoles.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.spanner.admin.database.v1.ListDatabaseRolesResponse	<optional>	ListDatabaseRolesResponse

ListDatabasesCallback(error, responseopt)

Callback as used by 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 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 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 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 updateBackup.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.spanner.admin.database.v1.Backup	<optional>	Backup

UpdateDatabaseCallback(error, responseopt)

Callback as used by updateDatabase.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateDatabaseDdlCallback(error, responseopt)

Callback as used by updateDatabaseDdl.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation