Interface ListDatabasesOptions

Represents the options for listing databases.

Field

include - Allows filtering so that databases in listed states are returned.

Field

provider - Allows filtering so that databases from a given provider are returned.

Field

limit - Specify the number of items for one page of data.

Field

skip - Starting value for retrieving a specific page of results.

interface ListDatabasesOptions {
    include?: DatabaseStatusFilter;
    limit?: number;
    maxTimeMS?: number;
    provider?: DatabaseCloudProviderFilter;
    skip?: number;
}

Hierarchy (view full)

Properties

include? limit? maxTimeMS? provider? skip?

Properties

Optional include

include?: DatabaseStatusFilter

Allows filtering so that databases in listed states are returned.

Optional limit

limit?: number

Optional parameter for pagination purposes. Specify the number of items for one page of data.

Should be between 1 and 100.

Defaults to 25.

Default Value

25

Optional maxTimeMS

maxTimeMS?: number

The maximum time to wait for a response from the server, in milliseconds.

Optional provider

provider?: DatabaseCloudProviderFilter

Allows filtering so that databases from a given provider are returned.

Optional skip

skip?: number

Optional parameter for pagination purposes. Used as this value for starting retrieving a specific page of results.

Settings

Member Visibility

Theme

On This Page

includelimitmaxTimeMSproviderskip