Interface CreateTableOptions<Def>

The API key for the embedding service to use, or the EmbeddingHeadersProvider if using a provider that requires it (e.g. AWS bedrock).

The keyspace to use for the operation.

The configuration for logging events emitted by the DataAPIClient.

This can be set at any level of the major class hierarchy, and will be inherited by all child classes.

See LoggingConfig for much more information on configuration, outputs, and inheritance.

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.

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

Deprecated

• The namespace terminology has been removed, and replaced with keyspace throughout the client.

The API key for the reranking service to use, or the RerankingHeadersProvider if using a provider that requires it (e.g. AWS bedrock).

Advanced & currently somewhat unstable features related to customizing the table's ser/des behavior at a lower level.

Use with caution. See official DataStax documentation for more info.

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 },
});
Copy

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 },
});
Copy

See TimeoutDescriptor for much more information.

See

TimeoutDescriptor

Overview

The default timeout options for any operation performed on this Table instance.

See TimeoutDescriptor for much more information about timeouts.

Example

// The request timeout for all operations is set to 1000ms.
const client = new DataAPIClient('...', {
  timeoutDefaults: { requestTimeoutMs: 1000 },
});

// The request timeout for all operations borne from this Db is set to 2000ms.
const db = client.db('...', {
  timeoutDefaults: { requestTimeoutMs: 2000 },
});
Copy

Inheritance

The timeout options are inherited by all child classes, and can be overridden at any level, including the individual method level.

Individual-method-level overrides can vary in behavior depending on the method; again, see TimeoutDescriptor.

Defaults

The default timeout options are as follows:

• requestTimeoutMs: 15000
• generalMethodTimeoutMs: 30000
• collectionAdminTimeoutMs: 60000
• tableAdminTimeoutMs: 30000
• databaseAdminTimeoutMs: 600000
• keyspaceAdminTimeoutMs: 30000

See

TimeoutDescriptor