Interface RunCommandOptions

Options for executing some arbitrary command.

Field

collection - The collection to run the command on. If not provided, the command is run on the database.

Field

keyspace - Overrides the keyspace to run the command in. If not provided, the default keyspace is used.

See

Db.command

interface RunCommandOptions {
    collection?: string;
    keyspace?: null | string;
    maxTimeMS?: number;
    namespace?: null | string;
}

Hierarchy (view full)

Properties

collection? keyspace? maxTimeMS? namespace?

Properties

Optional collection

collection?: string

The collection to run the command on. If not provided, the command is run on the database.

Optional keyspace

keyspace?: null | string

The keyspace to use for the db operation.

Optional maxTimeMS

maxTimeMS?: number

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

Optional namespace

namespace?: null | string

The keyspace to use for the db operation.

This is now a deprecated alias for the strictly equivalent RunCommandOptions.keyspace, and will be removed in an upcoming major version.

https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5

Deprecated

Settings

Member Visibility

Theme

On This Page

collectionkeyspacemaxTimeMSnamespace