Interface OptionItem

Query Selection

interface OptionItem {
    aggregate?: Aggregate[];
    distinct?: boolean;
    fields?: string[];
    forUpdate?: boolean;
    groupby?: GroupBy[];
    limit?: number;
    orderby?: OrderBy[];
    skip?: number;
}

Properties

aggregate? distinct? fields? forUpdate? groupby? limit? orderby? skip?

Properties

Optional aggregate

aggregate?: Aggregate[]

Aggregate function list

Optional distinct

distinct?: boolean

Distinct field

Optional fields

fields?: string[]

Projection Field Collection

Optional forUpdate

forUpdate?: boolean

select for update

Allows you to lock records returned by a query until the entire transaction to which the query belongs is committed.

Other transactions that attempt to query these records are blocked until the transaction that acquired the lock releases the lock or the transaction times out.

Optional groupby

groupby?: GroupBy[]

Grouped field set

Optional limit

limit?: number

Maximum number of records to be queried. The default value is 5000. The maximum value is 10000.

Optional orderby

orderby?: OrderBy[]

Sort field set

Optional skip

skip?: number

Number of skipped records. The default value is 0.

Settings

Member Visibility

Theme

On This Page

aggregatedistinctfieldsforUpdategroupbylimitorderbyskip