nodes/generated

Interface MongoDbNodeParameters

Source
interface MongoDbNodeParameters {
    collection?: string;
    fields?: string;
    indexDefinition?: string;
    indexName?: string;
    indexNameRequired?: string;
    indexType?: "search" | "vectorSearch";
    operation?:
        | "update"
        | "delete"
        | "insert"
        | "find"
        | "aggregate"
        | "findOneAndReplace"
        | "findOneAndUpdate"
        | "createSearchIndex"
        | "dropSearchIndex"
        | "listSearchIndexes"
        | "updateSearchIndex";
    options?: | {
        limit?: number;
        projection?: string;
        skip?: number;
        sort?: string;
    }
    | { dateFields?: string; useDotNotation?: boolean };
    query?: string;
    resource?: "document" | "searchIndexes";
    updateKey?: string;
    upsert?: boolean;
}

Properties§

§readonly collection?: string

MongoDB Collection

§readonly fields?: string

Comma-separated list of the fields to be included into the new document

§readonly indexDefinition?: string

The search index definition Default: "{}" Type options: {"alwaysOpenEditWindow":true}

§readonly indexName?: string

If provided, only lists indexes with the specified name

§readonly indexNameRequired?: string

The name of the search index

§readonly indexType?: "search" | "vectorSearch"

The search index index type Default: "vectorSearch"

§readonly operation?:
    | "update"
    | "delete"
    | "insert"
    | "find"
    | "aggregate"
    | "findOneAndReplace"
    | "findOneAndUpdate"
    | "createSearchIndex"
    | "dropSearchIndex"
    | "listSearchIndexes"
    | "updateSearchIndex"

Default: "find"

§readonly options?:
    | {
        limit?: number;
        projection?: string;
        skip?: number;
        sort?: string;
    }
    | { dateFields?: string; useDotNotation?: boolean }

Add query options Default: {}

§readonly query?: string

MongoDB aggregation pipeline query in JSON format Type options: {"alwaysOpenEditWindow":true}

§readonly resource?: "document" | "searchIndexes"

Default: "document"

§readonly updateKey?: string

Name of the property which decides which rows in the database should be updated. Normally that would be "id". Default: "id"

§readonly upsert?: boolean

Whether to perform an insert if no documents match the update key