Entity
    Preparing search index...

    Interface PostgresQuerySelectionModifiers<TFields>

    SQL modifiers that only affect the selection but not the projection.

    interface PostgresQuerySelectionModifiers<TFields extends Record<string, any>> {
        forShare?: boolean;
        forUpdate?: boolean;
        limit?: number;
        offset?: number;
        orderBy?: readonly PostgresOrderByClause<TFields>[];
        skipLocked?: boolean;
    }

    Type Parameters

    • TFields extends Record<string, any>
    Index
    forShare? forUpdate? limit? offset? orderBy? skipLocked?
    forShare?: boolean

    Lock the selected rows in share mode using SELECT ... FOR SHARE. Mutually exclusive with forUpdate.

    forUpdate?: boolean

    Lock the selected rows for update using SELECT ... FOR UPDATE. Mutually exclusive with forShare.

    limit?: number

    Limit the number of entities returned.

    offset?: number

    Skip the specified number of entities queried before returning.

    orderBy?: readonly PostgresOrderByClause<TFields>[]

    Order the entities by specified columns and orders.

    skipLocked?: boolean

    Skip rows that are already locked by another transaction using SKIP LOCKED. Requires forUpdate or forShare.

    Settings
    Member Visibility

    On This Page
    Properties