Interface TextQueryOptionsExperimental

Options for a Queryable Encryption field supporting text queries.

Public Technical Preview: textPreview is an experimental feature and may break at any time.

interface TextQueryOptions {
    caseSensitive: boolean;
    diacriticSensitive: boolean;
    prefix?: {
        strMaxQueryLength: number | Int32;
        strMinQueryLength: number | Int32;
    };
    substring?: {
        strMaxLength: number | Int32;
        strMaxQueryLength: number | Int32;
        strMinQueryLength: number | Int32;
    };
    suffix?: {
        strMaxQueryLength: number | Int32;
        strMinQueryLength: number | Int32;
    };
}

Properties

caseSensitive diacriticSensitive prefix? substring? suffix?

Properties

ExperimentalcaseSensitive

caseSensitive: boolean

Indicates that text indexes for this field are case sensitive

ExperimentaldiacriticSensitive

diacriticSensitive: boolean

Indicates that text indexes for this field are diacritic sensitive.

Optional Experimentalprefix

prefix?: {
    strMaxQueryLength: number | Int32;
    strMinQueryLength: number | Int32;
}

Type declaration

  • strMaxQueryLength: number | Int32

    The maximum allowed query length.

  • strMinQueryLength: number | Int32

    The minimum allowed query length.

Optional Experimentalsubstring

substring?: {
    strMaxLength: number | Int32;
    strMaxQueryLength: number | Int32;
    strMinQueryLength: number | Int32;
}

Type declaration

  • strMaxLength: number | Int32

    The maximum allowed length to insert.

  • strMaxQueryLength: number | Int32

    The maximum allowed query length.

  • strMinQueryLength: number | Int32

    The minimum allowed query length.

Optional Experimentalsuffix

suffix?: {
    strMaxQueryLength: number | Int32;
    strMinQueryLength: number | Int32;
}

Type declaration

  • strMaxQueryLength: number | Int32

    The maximum allowed query length.

  • strMinQueryLength: number | Int32

    The minimum allowed query length.

Settings

Member Visibility

On This Page

Properties