Interface RunCommandOptions

Options for executing some arbitrary command.

Field

collections - The collections 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;
    table?: string;
    timeout?: number | Pick<Partial<TimeoutDescriptor>, "requestTimeoutMs" | "generalMethodTimeoutMs">;
}

Hierarchy (view full)

Properties

collection? keyspace? table? timeout?

Properties

Optional collection

collection?: string

The collections 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 table

table?: string

Optional timeout

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

The method timeout override.

See TimeoutDescriptor for much more information.

Settings

Member Visibility

Theme

On This Page

collectionkeyspacetabletimeout