Class 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

Package

@google-cloud/spanner!

Constructors

(constructor)(opts)

  constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

Construct an instance of DatabaseAdminClient.

Parameter

Type	Name	Description
ClientOptions	opts

Properties

apiEndpoint

  static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value

Type	Description
string

auth

  auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;

Property Value

Type	Description
gax. GoogleAuth

databaseAdminStub

  databaseAdminStub 
 ?: 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;

Property Value

Type	Description
Promise <{ [name: string]: Function ; }>

descriptors

  descriptors 
 : 
  
 Descriptors 
 ;

Property Value

Type	Description
Descriptors

innerApiCalls

  innerApiCalls 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 };

Property Value

Type	Description
{ [name: string]: Function ; }

operationsClient

  operationsClient 
 : 
  
 gax 
 . 
 OperationsClient 
 ;

Property Value

Type	Description
gax. OperationsClient

pathTemplates

  pathTemplates 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 gax 
 . 
 PathTemplate 
 ; 
  
 };

Property Value

Type	Description
{ [name: string]: gax. PathTemplate ; }

port

  static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

The port for this API service.

Property Value

Type	Description
number

scopes

  static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value

Type	Description
string[]

servicePath

  static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

The DNS address for this API service.

Property Value

Type	Description
string

Methods

backupPath(project, instance, backup)

  backupPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 instance 
 : 
  
 string 
 , 
  
 backup 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified backup resource name string.

Parameters

Type	Name	Description
string	project
string	instance
string	backup

Returns

Type	Description
string	{string} Resource name string.

checkCreateBackupProgress(name)

  checkCreateBackupProgress 
 ( 
 name 
 : 
  
 string 
 ) 
 : 
  
 Promise<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 Backup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 CreateBackupMetadata 
>> ;

Check the status of the long running operation returned by createBackup() .

Parameter

Type	Name	Description
string	name	The operation name that will be passed.

Returns

Type	Description
Promise < LROperation <protos. google.spanner.admin.database.v1.Backup , protos. google.spanner.admin.database.v1.CreateBackupMetadata >>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkCreateDatabaseProgress(name)

  checkCreateDatabaseProgress 
 ( 
 name 
 : 
  
 string 
 ) 
 : 
  
 Promise<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 Database 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 CreateDatabaseMetadata 
>> ;

Check the status of the long running operation returned by createDatabase() .

Parameter

Type	Name	Description
string	name	The operation name that will be passed.

Returns

Type	Description
Promise < LROperation <protos. google.spanner.admin.database.v1.Database , protos. google.spanner.admin.database.v1.CreateDatabaseMetadata >>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkRestoreDatabaseProgress(name)

  checkRestoreDatabaseProgress 
 ( 
 name 
 : 
  
 string 
 ) 
 : 
  
 Promise<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 Database 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 RestoreDatabaseMetadata 
>> ;

Check the status of the long running operation returned by restoreDatabase() .

Parameter

Type	Name	Description
string	name	The operation name that will be passed.

Returns

Type	Description
Promise < LROperation <protos. google.spanner.admin.database.v1.Database , protos. google.spanner.admin.database.v1.RestoreDatabaseMetadata >>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateDatabaseDdlProgress(name)

  checkUpdateDatabaseDdlProgress 
 ( 
 name 
 : 
  
 string 
 ) 
 : 
  
 Promise<LROperation<protos 
 . 
 google 
 . 
 protobuf 
 . 
 Empty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 UpdateDatabaseDdlMetadata 
>> ;

Check the status of the long running operation returned by updateDatabaseDdl() .

Parameter

Type	Name	Description
string	name	The operation name that will be passed.

Returns

Type	Description
Promise < LROperation <protos. google.protobuf.Empty , protos. google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata >>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

  close 
 () 
 : 
  
 Promise<void> 
 ;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise <void>	{Promise} A promise that resolves when the client is closed.

createBackup(request, options)

  createBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateBackupRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateBackupMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.ICreateBackupRequest	request
CallOptions	options

Returns

Type	Description
Promise <[ LROperation <protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.ICreateBackupMetadata >, protos. google.longrunning.IOperation \| undefined, {} \| undefined]>

createBackup(request, options, callback)

  createBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateBackupRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateBackupMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.ICreateBackupRequest	request
CallOptions	options
Callback < LROperation <protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.ICreateBackupMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

createBackup(request, callback)

  createBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateBackupRequest 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateBackupMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.ICreateBackupRequest	request
Callback < LROperation <protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.ICreateBackupMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

createDatabase(request, options)

  createDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateDatabaseRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateDatabaseMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.ICreateDatabaseRequest	request
CallOptions	options

Returns

Type	Description
Promise <[ LROperation <protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.ICreateDatabaseMetadata >, protos. google.longrunning.IOperation \| undefined, {} \| undefined]>

createDatabase(request, options, callback)

  createDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateDatabaseRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateDatabaseMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.ICreateDatabaseRequest	request
CallOptions	options
Callback < LROperation <protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.ICreateDatabaseMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

createDatabase(request, callback)

  createDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateDatabaseRequest 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 ICreateDatabaseMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.ICreateDatabaseRequest	request
Callback < LROperation <protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.ICreateDatabaseMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

cryptoKeyPath(project, location, keyRing, cryptoKey)

  cryptoKeyPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 keyRing 
 : 
  
 string 
 , 
  
 cryptoKey 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified cryptoKey resource name string.

Parameters

Type	Name	Description
string	project
string	location
string	keyRing
string	cryptoKey

Returns

Type	Description
string	{string} Resource name string.

databasePath(project, instance, database)

  databasePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 instance 
 : 
  
 string 
 , 
  
 database 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified database resource name string.

Parameters

Type	Name	Description
string	project
string	instance
string	database

Returns

Type	Description
string	{string} Resource name string.

deleteBackup(request, options)

  deleteBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDeleteBackupRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDeleteBackupRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IDeleteBackupRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IDeleteBackupRequest \| undefined, {} \| undefined]>

deleteBackup(request, options, callback)

  deleteBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDeleteBackupRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDeleteBackupRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IDeleteBackupRequest	request
CallOptions	options
Callback <protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IDeleteBackupRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

deleteBackup(request, callback)

  deleteBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDeleteBackupRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDeleteBackupRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IDeleteBackupRequest	request
Callback <protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IDeleteBackupRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

dropDatabase(request, options)

  dropDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDropDatabaseRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDropDatabaseRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IDropDatabaseRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IDropDatabaseRequest \| undefined, {} \| undefined]>

dropDatabase(request, options, callback)

  dropDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDropDatabaseRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDropDatabaseRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IDropDatabaseRequest	request
CallOptions	options
Callback <protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IDropDatabaseRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

dropDatabase(request, callback)

  dropDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDropDatabaseRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDropDatabaseRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IDropDatabaseRequest	request
Callback <protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IDropDatabaseRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getBackup(request, options)

  getBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetBackupRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetBackupRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetBackupRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.IGetBackupRequest \| undefined, {} \| undefined]>

getBackup(request, options, callback)

  getBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetBackupRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetBackupRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetBackupRequest	request
CallOptions	options
Callback <protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.IGetBackupRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getBackup(request, callback)

  getBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetBackupRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetBackupRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetBackupRequest	request
Callback <protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.IGetBackupRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getDatabase(request, options)

  getDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetDatabaseRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.IGetDatabaseRequest \| undefined, {} \| undefined]>

getDatabase(request, options, callback)

  getDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetDatabaseRequest	request
CallOptions	options
Callback <protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.IGetDatabaseRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getDatabase(request, callback)

  getDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetDatabaseRequest	request
Callback <protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.IGetDatabaseRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getDatabaseDdl(request, options)

  getDatabaseDdl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlResponse 
 , 
  
 ( 
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlRequest 
  
 | 
  
 undefined 
 ), 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetDatabaseDdlRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.spanner.admin.database.v1.IGetDatabaseDdlResponse , (protos. google.spanner.admin.database.v1.IGetDatabaseDdlRequest \| undefined), {} \| undefined]>

getDatabaseDdl(request, options, callback)

  getDatabaseDdl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlResponse 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetDatabaseDdlRequest	request
CallOptions	options
Callback <protos. google.spanner.admin.database.v1.IGetDatabaseDdlResponse , protos. google.spanner.admin.database.v1.IGetDatabaseDdlRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getDatabaseDdl(request, callback)

  getDatabaseDdl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlResponse 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IGetDatabaseDdlRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IGetDatabaseDdlRequest	request
Callback <protos. google.spanner.admin.database.v1.IGetDatabaseDdlResponse , protos. google.spanner.admin.database.v1.IGetDatabaseDdlRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getIamPolicy(request, options)

  getIamPolicy 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IGetIamPolicyRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IPolicy 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IGetIamPolicyRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.iam.v1.IGetIamPolicyRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.iam.v1.IPolicy , protos. google.iam.v1.IGetIamPolicyRequest \| undefined, {} \| undefined]>

getIamPolicy(request, options, callback)

  getIamPolicy 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IGetIamPolicyRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IPolicy 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IGetIamPolicyRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.iam.v1.IGetIamPolicyRequest	request
CallOptions	options
Callback <protos. google.iam.v1.IPolicy , protos. google.iam.v1.IGetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getIamPolicy(request, callback)

  getIamPolicy 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IGetIamPolicyRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IPolicy 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IGetIamPolicyRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.iam.v1.IGetIamPolicyRequest	request
Callback <protos. google.iam.v1.IPolicy , protos. google.iam.v1.IGetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

getProjectId()

  getProjectId 
 () 
 : 
  
 Promise<string> 
 ;

Returns

Type	Description
Promise <string>

getProjectId(callback)

  getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameter

Type	Name	Description
Callback <string, undefined, undefined>	callback

Returns

Type	Description
void

initialize()

  initialize 
 () 
 : 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns

Type	Description
Promise <{ [name: string]: Function ; }>	{Promise} A promise that resolves to an authenticated service stub.

instancePath(project, instance)

  instancePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 instance 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified instance resource name string.

Parameters

Type	Name	Description
string	project
string	instance

Returns

Type	Description
string	{string} Resource name string.

listBackupOperations(request, options)

  listBackupOperations 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
 [], 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsResponse 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupOperationsRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.longrunning.IOperation [], protos. google.spanner.admin.database.v1.IListBackupOperationsRequest \| null, protos. google.spanner.admin.database.v1.IListBackupOperationsResponse ]>

listBackupOperations(request, options, callback)

  listBackupOperations 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupOperationsRequest	request
CallOptions	options
PaginationCallback <protos. google.spanner.admin.database.v1.IListBackupOperationsRequest , protos. google.spanner.admin.database.v1.IListBackupOperationsResponse \| null \| undefined, protos. google.longrunning.IOperation >	callback

Returns

Type	Description
void

listBackupOperations(request, callback)

  listBackupOperations 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupOperationsRequest	request
PaginationCallback <protos. google.spanner.admin.database.v1.IListBackupOperationsRequest , protos. google.spanner.admin.database.v1.IListBackupOperationsResponse \| null \| undefined, protos. google.longrunning.IOperation >	callback

Returns

Type	Description
void

listBackupOperationsAsync(request, options)

  listBackupOperationsAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
> ;

Equivalent to listBackupOperations , but returns an iterable object.

for - await - of syntax is used with the iterable to get response elements on-demand.

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupOperationsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
AsyncIterable <protos. google.longrunning.IOperation >	{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Operation]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBackupOperationsStream(request, options)

  listBackupOperationsStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupOperationsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

Equivalent to method.name.toCamelCase() , but returns a NodeJS Stream object.

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupOperationsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
Transform	{Stream} An object stream which emits an object representing [Operation] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listBackupOperationsAsync()` method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBackups(request, options)

  listBackups 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 [], 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsResponse 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupsRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.spanner.admin.database.v1.IBackup [], protos. google.spanner.admin.database.v1.IListBackupsRequest \| null, protos. google.spanner.admin.database.v1.IListBackupsResponse ]>

listBackups(request, options, callback)

  listBackups 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupsRequest	request
CallOptions	options
PaginationCallback <protos. google.spanner.admin.database.v1.IListBackupsRequest , protos. google.spanner.admin.database.v1.IListBackupsResponse \| null \| undefined, protos. google.spanner.admin.database.v1.IBackup >	callback

Returns

Type	Description
void

listBackups(request, callback)

  listBackups 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupsRequest	request
PaginationCallback <protos. google.spanner.admin.database.v1.IListBackupsRequest , protos. google.spanner.admin.database.v1.IListBackupsResponse \| null \| undefined, protos. google.spanner.admin.database.v1.IBackup >	callback

Returns

Type	Description
void

listBackupsAsync(request, options)

  listBackupsAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
> ;

Equivalent to listBackups , but returns an iterable object.

for - await - of syntax is used with the iterable to get response elements on-demand.

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
AsyncIterable <protos. google.spanner.admin.database.v1.IBackup >	{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Backup]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBackupsStream(request, options)

  listBackupsStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListBackupsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

Equivalent to method.name.toCamelCase() , but returns a NodeJS Stream object.

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListBackupsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
Transform	{Stream} An object stream which emits an object representing [Backup] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listBackupsAsync()` method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatabaseOperations(request, options)

  listDatabaseOperations 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
 [], 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsResponse 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabaseOperationsRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.longrunning.IOperation [], protos. google.spanner.admin.database.v1.IListDatabaseOperationsRequest \| null, protos. google.spanner.admin.database.v1.IListDatabaseOperationsResponse ]>

listDatabaseOperations(request, options, callback)

  listDatabaseOperations 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabaseOperationsRequest	request
CallOptions	options
PaginationCallback <protos. google.spanner.admin.database.v1.IListDatabaseOperationsRequest , protos. google.spanner.admin.database.v1.IListDatabaseOperationsResponse \| null \| undefined, protos. google.longrunning.IOperation >	callback

Returns

Type	Description
void

listDatabaseOperations(request, callback)

  listDatabaseOperations 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabaseOperationsRequest	request
PaginationCallback <protos. google.spanner.admin.database.v1.IListDatabaseOperationsRequest , protos. google.spanner.admin.database.v1.IListDatabaseOperationsResponse \| null \| undefined, protos. google.longrunning.IOperation >	callback

Returns

Type	Description
void

listDatabaseOperationsAsync(request, options)

  listDatabaseOperationsAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
> ;

Equivalent to listDatabaseOperations , but returns an iterable object.

for - await - of syntax is used with the iterable to get response elements on-demand.

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabaseOperationsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
AsyncIterable <protos. google.longrunning.IOperation >	{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Operation]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatabaseOperationsStream(request, options)

  listDatabaseOperationsStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabaseOperationsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

Equivalent to method.name.toCamelCase() , but returns a NodeJS Stream object.

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabaseOperationsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
Transform	{Stream} An object stream which emits an object representing [Operation] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listDatabaseOperationsAsync()` method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatabases(request, options)

  listDatabases 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 [], 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesResponse 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabasesRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.spanner.admin.database.v1.IDatabase [], protos. google.spanner.admin.database.v1.IListDatabasesRequest \| null, protos. google.spanner.admin.database.v1.IListDatabasesResponse ]>

listDatabases(request, options, callback)

  listDatabases 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesRequest 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabasesRequest	request
CallOptions	options
PaginationCallback <protos. google.spanner.admin.database.v1.IListDatabasesRequest , protos. google.spanner.admin.database.v1.IListDatabasesResponse \| null \| undefined, protos. google.spanner.admin.database.v1.IDatabase >	callback

Returns

Type	Description
void

listDatabases(request, callback)

  listDatabases 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesRequest 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabasesRequest	request
PaginationCallback <protos. google.spanner.admin.database.v1.IListDatabasesRequest , protos. google.spanner.admin.database.v1.IListDatabasesResponse \| null \| undefined, protos. google.spanner.admin.database.v1.IDatabase >	callback

Returns

Type	Description
void

listDatabasesAsync(request, options)

  listDatabasesAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
> ;

Equivalent to listDatabases , but returns an iterable object.

for - await - of syntax is used with the iterable to get response elements on-demand.

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabasesRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
AsyncIterable <protos. google.spanner.admin.database.v1.IDatabase >	{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Database]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatabasesStream(request, options)

  listDatabasesStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IListDatabasesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

Equivalent to method.name.toCamelCase() , but returns a NodeJS Stream object.

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IListDatabasesRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type	Description
Transform	{Stream} An object stream which emits an object representing [Database] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listDatabasesAsync()` method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchBackupFromBackupName(backupName)

  matchBackupFromBackupName 
 ( 
 backupName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the backup from Backup resource.

Parameter

Type	Name	Description
string	backupName	A fully-qualified path representing Backup resource.

Returns

Type	Description
string \| number	{string} A string representing the backup.

matchCryptoKeyFromCryptoKeyName(cryptoKeyName)

  matchCryptoKeyFromCryptoKeyName 
 ( 
 cryptoKeyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the crypto_key from CryptoKey resource.

Parameter

Type	Name	Description
string	cryptoKeyName	A fully-qualified path representing CryptoKey resource.

Returns

Type	Description
string \| number	{string} A string representing the crypto_key.

matchDatabaseFromDatabaseName(databaseName)

  matchDatabaseFromDatabaseName 
 ( 
 databaseName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the database from Database resource.

Parameter

Type	Name	Description
string	databaseName	A fully-qualified path representing Database resource.

Returns

Type	Description
string \| number	{string} A string representing the database.

matchInstanceFromBackupName(backupName)

  matchInstanceFromBackupName 
 ( 
 backupName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the instance from Backup resource.

Parameter

Type	Name	Description
string	backupName	A fully-qualified path representing Backup resource.

Returns

Type	Description
string \| number	{string} A string representing the instance.

matchInstanceFromDatabaseName(databaseName)

  matchInstanceFromDatabaseName 
 ( 
 databaseName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the instance from Database resource.

Parameter

Type	Name	Description
string	databaseName	A fully-qualified path representing Database resource.

Returns

Type	Description
string \| number	{string} A string representing the instance.

matchInstanceFromInstanceName(instanceName)

  matchInstanceFromInstanceName 
 ( 
 instanceName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the instance from Instance resource.

Parameter

Type	Name	Description
string	instanceName	A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the instance.

matchKeyRingFromCryptoKeyName(cryptoKeyName)

  matchKeyRingFromCryptoKeyName 
 ( 
 cryptoKeyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the key_ring from CryptoKey resource.

Parameter

Type	Name	Description
string	cryptoKeyName	A fully-qualified path representing CryptoKey resource.

Returns

Type	Description
string \| number	{string} A string representing the key_ring.

matchLocationFromCryptoKeyName(cryptoKeyName)

  matchLocationFromCryptoKeyName 
 ( 
 cryptoKeyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the location from CryptoKey resource.

Parameter

Type	Name	Description
string	cryptoKeyName	A fully-qualified path representing CryptoKey resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchProjectFromBackupName(backupName)

  matchProjectFromBackupName 
 ( 
 backupName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Backup resource.

Parameter

Type	Name	Description
string	backupName	A fully-qualified path representing Backup resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromCryptoKeyName(cryptoKeyName)

  matchProjectFromCryptoKeyName 
 ( 
 cryptoKeyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from CryptoKey resource.

Parameter

Type	Name	Description
string	cryptoKeyName	A fully-qualified path representing CryptoKey resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromDatabaseName(databaseName)

  matchProjectFromDatabaseName 
 ( 
 databaseName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Database resource.

Parameter

Type	Name	Description
string	databaseName	A fully-qualified path representing Database resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromInstanceName(instanceName)

  matchProjectFromInstanceName 
 ( 
 instanceName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Instance resource.

Parameter

Type	Name	Description
string	instanceName	A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

restoreDatabase(request, options)

  restoreDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IRestoreDatabaseRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IRestoreDatabaseMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IRestoreDatabaseRequest	request
CallOptions	options

Returns

Type	Description
Promise <[ LROperation <protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.IRestoreDatabaseMetadata >, protos. google.longrunning.IOperation \| undefined, {} \| undefined]>

restoreDatabase(request, options, callback)

  restoreDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IRestoreDatabaseRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IRestoreDatabaseMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IRestoreDatabaseRequest	request
CallOptions	options
Callback < LROperation <protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.IRestoreDatabaseMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

restoreDatabase(request, callback)

  restoreDatabase 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IRestoreDatabaseRequest 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IDatabase 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IRestoreDatabaseMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IRestoreDatabaseRequest	request
Callback < LROperation <protos. google.spanner.admin.database.v1.IDatabase , protos. google.spanner.admin.database.v1.IRestoreDatabaseMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

setIamPolicy(request, options)

  setIamPolicy 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ISetIamPolicyRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IPolicy 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ISetIamPolicyRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.iam.v1.ISetIamPolicyRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.iam.v1.IPolicy , protos. google.iam.v1.ISetIamPolicyRequest \| undefined, {} \| undefined]>

setIamPolicy(request, options, callback)

  setIamPolicy 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ISetIamPolicyRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IPolicy 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ISetIamPolicyRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.iam.v1.ISetIamPolicyRequest	request
CallOptions	options
Callback <protos. google.iam.v1.IPolicy , protos. google.iam.v1.ISetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

setIamPolicy(request, callback)

  setIamPolicy 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ISetIamPolicyRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 IPolicy 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ISetIamPolicyRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.iam.v1.ISetIamPolicyRequest	request
Callback <protos. google.iam.v1.IPolicy , protos. google.iam.v1.ISetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

testIamPermissions(request, options)

  testIamPermissions 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsResponse 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.iam.v1.ITestIamPermissionsRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.iam.v1.ITestIamPermissionsResponse , protos. google.iam.v1.ITestIamPermissionsRequest \| undefined, {} \| undefined]>

testIamPermissions(request, options, callback)

  testIamPermissions 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsResponse 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.iam.v1.ITestIamPermissionsRequest	request
CallOptions	options
Callback <protos. google.iam.v1.ITestIamPermissionsResponse , protos. google.iam.v1.ITestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

testIamPermissions(request, callback)

  testIamPermissions 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsResponse 
 , 
  
 protos 
 . 
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.iam.v1.ITestIamPermissionsRequest	request
Callback <protos. google.iam.v1.ITestIamPermissionsResponse , protos. google.iam.v1.ITestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

updateBackup(request, options)

  updateBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateBackupRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateBackupRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IUpdateBackupRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.IUpdateBackupRequest \| undefined, {} \| undefined]>

updateBackup(request, options, callback)

  updateBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateBackupRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateBackupRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IUpdateBackupRequest	request
CallOptions	options
Callback <protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.IUpdateBackupRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

updateBackup(request, callback)

  updateBackup 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateBackupRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IBackup 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateBackupRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IUpdateBackupRequest	request
Callback <protos. google.spanner.admin.database.v1.IBackup , protos. google.spanner.admin.database.v1.IUpdateBackupRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

updateDatabaseDdl(request, options)

  updateDatabaseDdl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateDatabaseDdlRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 LROperation<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateDatabaseDdlMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest	request
CallOptions	options

Returns

Type	Description
Promise <[ LROperation <protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata >, protos. google.longrunning.IOperation \| undefined, {} \| undefined]>

updateDatabaseDdl(request, options, callback)

  updateDatabaseDdl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateDatabaseDdlRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateDatabaseDdlMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest	request
CallOptions	options
Callback < LROperation <protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

updateDatabaseDdl(request, callback)

  updateDatabaseDdl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateDatabaseDdlRequest 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 spanner 
 . 
 admin 
 . 
 database 
 . 
 v1 
 . 
 IUpdateDatabaseDdlMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest	request
Callback < LROperation <protos. google.protobuf.IEmpty , protos. google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

Class v1.DatabaseAdminClient Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts)

Properties

apiEndpoint

auth

databaseAdminStub

descriptors

innerApiCalls

operationsClient

pathTemplates

port

scopes

servicePath

Methods

backupPath(project, instance, backup)

checkCreateBackupProgress(name)

checkCreateDatabaseProgress(name)

checkRestoreDatabaseProgress(name)

checkUpdateDatabaseDdlProgress(name)

close()

createBackup(request, options)

createBackup(request, options, callback)

createBackup(request, callback)

createDatabase(request, options)

createDatabase(request, options, callback)

createDatabase(request, callback)

cryptoKeyPath(project, location, keyRing, cryptoKey)

databasePath(project, instance, database)

deleteBackup(request, options)

deleteBackup(request, options, callback)

deleteBackup(request, callback)

dropDatabase(request, options)

dropDatabase(request, options, callback)

dropDatabase(request, callback)

getBackup(request, options)

getBackup(request, options, callback)

getBackup(request, callback)

getDatabase(request, options)

getDatabase(request, options, callback)

getDatabase(request, callback)

getDatabaseDdl(request, options)

getDatabaseDdl(request, options, callback)

getDatabaseDdl(request, callback)

getIamPolicy(request, options)

getIamPolicy(request, options, callback)

getIamPolicy(request, callback)

getProjectId()

getProjectId(callback)

initialize()

instancePath(project, instance)

listBackupOperations(request, options)

listBackupOperations(request, options, callback)

listBackupOperations(request, callback)

listBackupOperationsAsync(request, options)

listBackupOperationsStream(request, options)

listBackups(request, options)

listBackups(request, options, callback)

listBackups(request, callback)

listBackupsAsync(request, options)

listBackupsStream(request, options)

listDatabaseOperations(request, options)

listDatabaseOperations(request, options, callback)

listDatabaseOperations(request, callback)

listDatabaseOperationsAsync(request, options)

listDatabaseOperationsStream(request, options)

listDatabases(request, options)

listDatabases(request, options, callback)

listDatabases(request, callback)

listDatabasesAsync(request, options)

listDatabasesStream(request, options)

matchBackupFromBackupName(backupName)

matchCryptoKeyFromCryptoKeyName(cryptoKeyName)

matchDatabaseFromDatabaseName(databaseName)

matchInstanceFromBackupName(backupName)

matchInstanceFromDatabaseName(databaseName)

matchInstanceFromInstanceName(instanceName)

matchKeyRingFromCryptoKeyName(cryptoKeyName)

matchLocationFromCryptoKeyName(cryptoKeyName)

Class v1.DatabaseAdminClient