@oxia-db/client - v0.1.0
    Preparing search index...

    Interface GetOptions

    Options for OxiaClient.get.

    interface GetOptions {
        partitionKey?: string;
        comparisonType?: ComparisonType;
        includeValue?: boolean;
        useIndex?: string;
    }
    Index

    Properties

    partitionKey? comparisonType? includeValue? useIndex?

    Properties

    partitionKey?: string

    Override shard routing (see PutOptions.partitionKey).

    comparisonType?: ComparisonType

    Comparison mode. Defaults to ComparisonType.EQUAL. Non-EQUAL modes query every shard when no partitionKey is set.

    includeValue?: boolean

    If false, the response's value is undefined (metadata-only read). Defaults to true.

    useIndex?: string

    Look up the record via this secondary index (the key argument is interpreted as a secondary key). Without a partitionKey, the lookup is fanned out to every shard.

    Settings

    Member Visibility

    On This Page

    Properties