@ibm-cloud/cloudant - v0.12.6
    Preparing search index...

    Interface PostIndexParams

    Parameters for the postIndex operation.

    interface PostIndexParams {
        db: string;
        ddoc?: string;
        headers?: OutgoingHttpHeaders;
        index: CloudantV1.IndexDefinition;
        name?: string;
        partitioned?: boolean;
        signal?: GenericAbortSignal;
        type?: string;
    }

    Hierarchy

    • DefaultParams
      • PostIndexParams
    Index

    Properties

    db ddoc? headers? index name? partitioned? signal? type?

    Properties

    db: string

    Path parameter to specify the database name.

    ddoc?: string

    Specifies the design document name in which the index will be created. The design document name is the design document ID excluding the _design/ prefix.

    headers?: OutgoingHttpHeaders
    index: CloudantV1.IndexDefinition

    Schema for a json or text query index definition. Indexes of type text have additional configuration properties that do not apply to json indexes, these are:

    • default_analyzer - the default text analyzer to use * default_field - whether to index the text in all document fields and what analyzer to use for that purpose.
    name?: string

    name.

    partitioned?: boolean

    The default value is true for databases with partitioned: true and false otherwise. For databases with partitioned: false if this option is specified the value must be false.

    signal?: GenericAbortSignal
    type?: string

    Schema for the type of an index.

    Settings

    Member Visibility

    On This Page

    Properties