DatabaseAdminClient

DatabaseAdminClient

Cloud Spanner Database Admin API

The Cloud Spanner Database Admin API can be used to:

  • create, drop, and list databases
  • update the schema of pre-existing databases
  • create, delete, copy and list backups for a database
  • restore a database from an existing backup

Constructor

new DatabaseAdminClient(optionsopt, gaxInstanceopt)

Construct an instance of DatabaseAdminClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new DatabaseAdminClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

backupPath(project, instance, backup) → {string}

Return a fully-qualified backup resource name string.

Parameters:
Name Type Description
project string
instance string
backup string
Returns:
Type Description
string

Resource name string.

backupSchedulePath(project, instance, database, schedule) → {string}

Return a fully-qualified backupSchedule resource name string.

Parameters:
Name Type Description
project string
instance string
database string
schedule string
Returns:
Type Description
string

Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkCopyBackupProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.

(async) checkCreateBackupProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.

(async) checkCreateDatabaseProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.

(async) checkRestoreDatabaseProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.

(async) checkUpdateDatabaseDdlProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.

(async) checkUpdateDatabaseProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.

close() → {Promise}

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

A promise that resolves when the client is closed.

cryptoKeyPath(project, location, key_ring, crypto_key) → {string}

Return a fully-qualified cryptoKey resource name string.

Parameters:
Name Type Description
project string
location string
key_ring string
crypto_key string
Returns:
Type Description
string

Resource name string.

databasePath(project, instance, database) → {string}

Return a fully-qualified database resource name string.

Parameters:
Name Type Description
project string
instance string
database string
Returns:
Type Description
string

Resource name string.

databaseRolePath(project, instance, database, role) → {string}

Return a fully-qualified databaseRole resource name string.

Parameters:
Name Type Description
project string
instance string
database string
role string
Returns:
Type Description
string

Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

instancePath(project, instance) → {string}

Return a fully-qualified instance resource name string.

Parameters:
Name Type Description
project string
instance string
Returns:
Type Description
string

Resource name string.

listBackupOperationsAsync(request, optionsopt) → {Object}

Equivalent to listBackupOperations, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.
filter string

An expression that filters the list of returned backup operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the operation are eligible for filtering:

* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
   for
   CreateBackupMetadata
   is
   `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
   `metadata.@type` must be specified first if filtering on metadata
   fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `done:true` - The operation is complete.
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
   `metadata.database:prod` - Returns operations where:
   * The operation's metadata type is
   CreateBackupMetadata.
   * The source database name of backup contains the string "prod".
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
  `(metadata.name:howl) AND` \
  `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
  `(error:*)` - Returns operations where:
  * The operation's metadata type is
  CreateBackupMetadata.
  * The backup name contains the string "howl".
  * The operation started before 2018-03-28T14:50:00Z.
  * The operation resulted in an error.
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
  `(metadata.source_backup:test) AND` \
  `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
  `(error:*)` - Returns operations where:
  * The operation's metadata type is
  CopyBackupMetadata.
  * The source backup name contains the string "test".
  * The operation started before 2022-01-18T14:50:00Z.
  * The operation resulted in an error.
* `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
  `(metadata.database:test_db)) OR` \
  `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
  AND` \
  `(metadata.source_backup:test_bkp)) AND` \
  `(error:*)` - Returns operations where:
  * The operation's metadata matches either of criteria:
    * The operation's metadata type is
    CreateBackupMetadata
    AND the source database name of the backup contains the string
    "test_db"
    * The operation's metadata type is
    CopyBackupMetadata
    AND the source backup name contains the string "test_bkp"
  * The operation resulted in an error.
pageSize number

Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListBackupOperationsResponse to the same parent and with the same filter.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 for more details and examples.

listBackupOperationsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.
filter string

An expression that filters the list of returned backup operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the operation are eligible for filtering:

* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
   for
   CreateBackupMetadata
   is
   `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
   `metadata.@type` must be specified first if filtering on metadata
   fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `done:true` - The operation is complete.
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
   `metadata.database:prod` - Returns operations where:
   * The operation's metadata type is
   CreateBackupMetadata.
   * The source database name of backup contains the string "prod".
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
  `(metadata.name:howl) AND` \
  `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
  `(error:*)` - Returns operations where:
  * The operation's metadata type is
  CreateBackupMetadata.
  * The backup name contains the string "howl".
  * The operation started before 2018-03-28T14:50:00Z.
  * The operation resulted in an error.
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
  `(metadata.source_backup:test) AND` \
  `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
  `(error:*)` - Returns operations where:
  * The operation's metadata type is
  CopyBackupMetadata.
  * The source backup name contains the string "test".
  * The operation started before 2022-01-18T14:50:00Z.
  * The operation resulted in an error.
* `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
  `(metadata.database:test_db)) OR` \
  `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
  AND` \
  `(metadata.source_backup:test_bkp)) AND` \
  `(error:*)` - Returns operations where:
  * The operation's metadata matches either of criteria:
    * The operation's metadata type is
    CreateBackupMetadata
    AND the source database name of the backup contains the string
    "test_db"
    * The operation's metadata type is
    CopyBackupMetadata
    AND the source backup name contains the string "test_bkp"
  * The operation resulted in an error.
pageSize number

Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListBackupOperationsResponse to the same parent and with the same filter.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

listBackupSchedulesAsync(request, optionsopt) → {Object}

Equivalent to listBackupSchedules, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/
pageSize number <optional>

Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string <optional>

Optional. If non-empty, page_token should contain a next_page_token from a previous ListBackupSchedulesResponse to the same parent.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing BackupSchedule. 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 for more details and examples.

listBackupSchedulesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/
pageSize number <optional>

Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string <optional>

Optional. If non-empty, page_token should contain a next_page_token from a previous ListBackupSchedulesResponse to the same parent.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing BackupSchedule 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 listBackupSchedulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackupsAsync(request, optionsopt) → {Object}

Equivalent to listBackups, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.
filter string

An expression that filters the list of returned backups.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Backup are eligible for filtering:

* `name`
* `database`
* `state`
* `create_time`  (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `expire_time`  (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `size_bytes`
* `backup_schedules`

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `name:Howl` - The backup's name contains the string "howl".
* `database:prod`
       - The database's name contains the string "prod".
* `state:CREATING` - The backup is pending creation.
* `state:READY` - The backup is fully created and ready for use.
* `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
       - The backup name contains the string "howl" and `create_time`
           of the backup is before 2018-03-28T14:50:00Z.
* `expire_time < \"2018-03-28T14:50:00Z\"`
       - The backup `expire_time` is before 2018-03-28T14:50:00Z.
* `size_bytes > 10000000000` - The backup's size is greater than 10GB
* `backup_schedules:daily`
       - The backup is created from a schedule with "daily" in its name.
pageSize number

Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 for more details and examples.

listBackupsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.
filter string

An expression that filters the list of returned backups.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Backup are eligible for filtering:

* `name`
* `database`
* `state`
* `create_time`  (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `expire_time`  (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `size_bytes`
* `backup_schedules`

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `name:Howl` - The backup's name contains the string "howl".
* `database:prod`
       - The database's name contains the string "prod".
* `state:CREATING` - The backup is pending creation.
* `state:READY` - The backup is fully created and ready for use.
* `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
       - The backup name contains the string "howl" and `create_time`
           of the backup is before 2018-03-28T14:50:00Z.
* `expire_time < \"2018-03-28T14:50:00Z\"`
       - The backup `expire_time` is before 2018-03-28T14:50:00Z.
* `size_bytes > 10000000000` - The backup's size is greater than 10GB
* `backup_schedules:daily`
       - The backup is created from a schedule with "daily" in its name.
pageSize number

Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

listDatabaseOperationsAsync(request, optionsopt) → {Object}

Equivalent to listDatabaseOperations, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.
filter string

An expression that filters the list of returned operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Operation are eligible for filtering:

* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
   for
   RestoreDatabaseMetadata
   is
   `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
   `metadata.@type` must be specified first, if filtering on metadata
   fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `done:true` - The operation is complete.
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
  `(metadata.source_type:BACKUP) AND` \
  `(metadata.backup_info.backup:backup_howl) AND` \
  `(metadata.name:restored_howl) AND` \
  `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
  `(error:*)` - Return operations where:
  * The operation's metadata type is
  RestoreDatabaseMetadata.
  * The database is restored from a backup.
  * The backup name contains "backup_howl".
  * The restored database's name contains "restored_howl".
  * The operation started before 2018-03-28T14:50:00Z.
  * The operation resulted in an error.
pageSize number

Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same parent and with the same filter.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 for more details and examples.

listDatabaseOperationsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.
filter string

An expression that filters the list of returned operations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Operation are eligible for filtering:

* `name` - The name of the long-running operation
* `done` - False if the operation is in progress, else true.
* `metadata.@type` - the type of metadata. For example, the type string
   for
   RestoreDatabaseMetadata
   is
   `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
* `metadata.<field_name>` - any field in metadata.value.
   `metadata.@type` must be specified first, if filtering on metadata
   fields.
* `error` - Error associated with the long-running operation.
* `response.@type` - the type of response.
* `response.<field_name>` - any field in response.value.

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

* `done:true` - The operation is complete.
* `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
  `(metadata.source_type:BACKUP) AND` \
  `(metadata.backup_info.backup:backup_howl) AND` \
  `(metadata.name:restored_howl) AND` \
  `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
  `(error:*)` - Return operations where:
  * The operation's metadata type is
  RestoreDatabaseMetadata.
  * The database is restored from a backup.
  * The backup name contains "backup_howl".
  * The restored database's name contains "restored_howl".
  * The operation started before 2018-03-28T14:50:00Z.
  * The operation resulted in an error.
pageSize number

Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same parent and with the same filter.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

listDatabaseRolesAsync(request, optionsopt) → {Object}

Equivalent to listDatabaseRoles, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The database whose roles should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>.
pageSize number

Number of database roles to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListDatabaseRolesResponse.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DatabaseRole. 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 for more details and examples.

listDatabaseRolesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The database whose roles should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>.
pageSize number

Number of database roles to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListDatabaseRolesResponse.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing DatabaseRole 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 listDatabaseRolesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDatabasesAsync(request, optionsopt) → {Object}

Equivalent to listDatabases, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.
pageSize number

Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListDatabasesResponse.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 for more details and examples.

listDatabasesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.
pageSize number

Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken string

If non-empty, page_token should contain a next_page_token from a previous ListDatabasesResponse.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

matchBackupFromBackupName(backupName) → {string}

Parse the backup from Backup resource.

Parameters:
Name Type Description
backupName string

A fully-qualified path representing Backup resource.
Returns:
Type Description
string

A string representing the backup.

matchCryptoKeyFromCryptoKeyName(cryptoKeyName) → {string}

Parse the crypto_key from CryptoKey resource.

Parameters:
Name Type Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.
Returns:
Type Description
string

A string representing the crypto_key.

matchDatabaseFromBackupScheduleName(backupScheduleName) → {string}

Parse the database from BackupSchedule resource.

Parameters:
Name Type Description
backupScheduleName string

A fully-qualified path representing BackupSchedule resource.
Returns:
Type Description
string

A string representing the database.

matchDatabaseFromDatabaseName(databaseName) → {string}

Parse the database from Database resource.

Parameters:
Name Type Description
databaseName string

A fully-qualified path representing Database resource.
Returns:
Type Description
string

A string representing the database.

matchDatabaseFromDatabaseRoleName(databaseRoleName) → {string}

Parse the database from DatabaseRole resource.

Parameters:
Name Type Description
databaseRoleName string

A fully-qualified path representing DatabaseRole resource.
Returns:
Type Description
string

A string representing the database.

matchInstanceFromBackupName(backupName) → {string}

Parse the instance from Backup resource.

Parameters:
Name Type Description
backupName string

A fully-qualified path representing Backup resource.
Returns:
Type Description
string

A string representing the instance.

matchInstanceFromBackupScheduleName(backupScheduleName) → {string}

Parse the instance from BackupSchedule resource.

Parameters:
Name Type Description
backupScheduleName string

A fully-qualified path representing BackupSchedule resource.
Returns:
Type Description
string

A string representing the instance.

matchInstanceFromDatabaseName(databaseName) → {string}

Parse the instance from Database resource.

Parameters:
Name Type Description
databaseName string

A fully-qualified path representing Database resource.
Returns:
Type Description
string

A string representing the instance.

matchInstanceFromDatabaseRoleName(databaseRoleName) → {string}

Parse the instance from DatabaseRole resource.

Parameters:
Name Type Description
databaseRoleName string

A fully-qualified path representing DatabaseRole resource.
Returns:
Type Description
string

A string representing the instance.

matchInstanceFromInstanceName(instanceName) → {string}

Parse the instance from Instance resource.

Parameters:
Name Type Description
instanceName string

A fully-qualified path representing Instance resource.
Returns:
Type Description
string

A string representing the instance.

matchKeyRingFromCryptoKeyName(cryptoKeyName) → {string}

Parse the key_ring from CryptoKey resource.

Parameters:
Name Type Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.
Returns:
Type Description
string

A string representing the key_ring.

matchLocationFromCryptoKeyName(cryptoKeyName) → {string}

Parse the location from CryptoKey resource.

Parameters:
Name Type Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.
Returns:
Type Description
string

A string representing the location.

matchProjectFromBackupName(backupName) → {string}

Parse the project from Backup resource.

Parameters:
Name Type Description
backupName string

A fully-qualified path representing Backup resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromBackupScheduleName(backupScheduleName) → {string}

Parse the project from BackupSchedule resource.

Parameters:
Name Type Description
backupScheduleName string

A fully-qualified path representing BackupSchedule resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromCryptoKeyName(cryptoKeyName) → {string}

Parse the project from CryptoKey resource.

Parameters:
Name Type Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromDatabaseName(databaseName) → {string}

Parse the project from Database resource.

Parameters:
Name Type Description
databaseName string

A fully-qualified path representing Database resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromDatabaseRoleName(databaseRoleName) → {string}

Parse the project from DatabaseRole resource.

Parameters:
Name Type Description
databaseRoleName string

A fully-qualified path representing DatabaseRole resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromInstanceName(instanceName) → {string}

Parse the project from Instance resource.

Parameters:
Name Type Description
instanceName string

A fully-qualified path representing Instance resource.
Returns:
Type Description
string

A string representing the project.

matchRoleFromDatabaseRoleName(databaseRoleName) → {string}

Parse the role from DatabaseRole resource.

Parameters:
Name Type Description
databaseRoleName string

A fully-qualified path representing DatabaseRole resource.
Returns:
Type Description
string

A string representing the role.

matchScheduleFromBackupScheduleName(backupScheduleName) → {string}

Parse the schedule from BackupSchedule resource.

Parameters:
Name Type Description
backupScheduleName string

A fully-qualified path representing BackupSchedule resource.
Returns:
Type Description
string

A string representing the schedule.