nodes/generated

Interface AzureCosmosDbNodeParameters

Source


interface AzureCosmosDbNodeParameters {
    additionalFields?:
        | {
            indexingPolicy?: string;
            maxThroughput?: number;
            offerThroughput?: number;
        }
        | { partitionKey?: string };
    container?: { mode: "id" | "list"; value: string };
    containerCreate?: string;
    customProperties?: string;
    item?: { mode: "id" | "list"; value: string };
    limit?: number;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "query";
    options?: {
        queryOptions: {
            queryParameters?: string;
            queryParametersJson?: string;
        };
    };
    partitionKey?: string;
    query?: string;
    resource?: "item"
    | "container";
    returnAll?: boolean;
    simple?: boolean;
}

Properties§

§readonly additionalFields?:
    | {
        indexingPolicy?: string;
        maxThroughput?: number;
        offerThroughput?: number;
    }
    | { partitionKey?: string }

Default: {}

§readonly container?: { ... }

Select the container you want to delete Default: {"mode":"list","value":""}

§readonly containerCreate?: string

Unique identifier for the new container

§readonly customProperties?: string

The item contents as a JSON object Default: "{\n\t"id": "replace_with_new_document_id"\n}"

§readonly item?: { ... }

Select the item to be deleted Default: {"mode":"list","value":""}

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly operation?: "create" | "get" | "getAll" | "update" | "delete" | "query"

Default: "getAll"

§readonly options?: { ... }

Default: {} Type options: {"multipleValues":false}

§readonly partitionKey?: string

The partition key is used to automatically distribute data across partitions for scalability. Choose a property in your JSON document that has a wide range of values and evenly distributes request volume. Default: "{\n\t"paths": [\n\t\t"/id"\n\t],\n\t"kind": "Hash",\n\t"version": 2\n}"

§readonly query?: string

The SQL query to execute. Use $1, $2, $3, etc., to reference the 'Query Parameters' set in the options below. Type options: {"editor":"sqlEditor","sqlDialect":"StandardSQL"}

§readonly resource?: "item" | "container"

Default: "container"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true