Interface MongoDBStoreInput

Type definition for the input parameters required to initialize an instance of the MongoDBStoreInput class.

interface MongoDBStoreInput {
    collection: Collection<Document>;
    namespace?: string;
    primaryKey?: string;
    yieldKeysScanBatchSize?: number;
}

Properties

collection namespace? primaryKey? yieldKeysScanBatchSize?

Properties

collection

collection: Collection<Document>

Optional namespace

namespace?: string

The namespace to use for the keys in the database.

Optional primaryKey

primaryKey?: string

The primary key to use for the database.

Default

"_id"

Optional yieldKeysScanBatchSize

yieldKeysScanBatchSize?: number

The amount of keys to retrieve per batch when yielding keys.

Default

1000

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc