Interface AstraFindAvailableRegionsOptions

Overview

The options for AstraAdmin.findAvailableRegions.

Example

const regions = await admin.findAvailableRegions({
  onlyOrgEnabledRegions: false,
});

See

  • AstraAdmin.findAvailableRegions
  • AstraAvailableRegionInfo
interface AstraFindAvailableRegionsOptions {
    maxTimeMS?: "ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`";
    onlyOrgEnabledRegions?: boolean;
    timeout?: number | Pick<Partial<TimeoutDescriptor>, "requestTimeoutMs" | "databaseAdminTimeoutMs">;
}

Hierarchy (view full)

  • CommandOptions<{
        timeout: "databaseAdminTimeoutMs";
    }>
    • AstraFindAvailableRegionsOptions

Properties

maxTimeMS? onlyOrgEnabledRegions? timeout?

Properties

Optional maxTimeMS

maxTimeMS?: "ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • The maxTimeMS option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using timeout, and defaults in timeoutDefaults. You may generally Ctrl+R replace maxTimeMS with timeout to retain the same behavior.

Optional onlyOrgEnabledRegions

onlyOrgEnabledRegions?: boolean

Whether to only return regions that are enabled for the current organization.

  • When true or unset: only returns regions enabled for the current organization.
  • When false: returns all available regions, including those not enabled for the organization.

Note that the organization is determined by the token used to authenticate the request.

Defaults to true.

Optional timeout

timeout?: number | Pick<Partial<TimeoutDescriptor>, "requestTimeoutMs" | "databaseAdminTimeoutMs">
Overview

Lets you specify timeouts for individual methods, in two different formats:

  • A subtype of TimeoutDescriptor, which lets you specify the timeout for specific categories.
  • A number, which specifies the "happy path" timeout for the method.
    • In single-call methods, this sets both the request & overall method timeouts.
    • In multi-call methods, this sets the overall method timeout (request timeouts are kept as default).

Example

// Both `requestTimeoutMs` and `generalMethodTimeoutMs` are set to 1000ms.
await coll.insertOne({ ... }, { timeout: 1000 });

// `requestTimeoutMs` is left as default, `generalMethodTimeoutMs` is set to 2000ms.
await coll.insertOne({ ... }, { timeout: { generalMethodTimeoutMs: 2000 } });

// Both `requestTimeoutMs` and `generalMethodTimeoutMs` are set to 2000ms.
await coll.insertMany([...], {
  timeout: { requestTimeoutMs: 2000, generalMethodTimeoutMs: 2000 },
});

Example

// `requestTimeoutMs` is left as default, `generalMethodTimeoutMs` is set to 2000ms.
await coll.insertMany([...], { timeout: 2000 });

// `requestTimeoutMs` is left as default, `generalMethodTimeoutMs` is set to 2000ms.
await coll.insertMany([...], { timeout: { generalMethodTimeoutMs: 2000 } });

// Both `requestTimeoutMs` and `generalMethodTimeoutMs` are set to 2000ms.
await coll.insertMany([...], {
  timeout: { requestTimeoutMs: 2000, generalMethodTimeoutMs: 2000 },
});

See TimeoutDescriptor for much more information.

See

TimeoutDescriptor

Settings

Member Visibility

Theme

On This Page

maxTimeMSonlyOrgEnabledRegionstimeout