@squidcloud/client
    Preparing search index...

    Interface Query<Doc>

    A query object defining a database retrieval operation.

    interface Query<Doc extends DocumentData = any> {
        collectionName: string;
        conditions: Conditions<Doc>;
        integrationId: string;
        limit: number;
        limitBy?: LimitBy<Doc>;
        sortOrder: FieldSort<Doc>[];
    }

    Type Parameters

    Index

    Properties

    collectionName conditions integrationId limit limitBy? sortOrder

    Properties

    collectionName: string

    The full collection path such as "c1" or "c1/d1/c2".

    conditions: Conditions<Doc>

    An array of conditions to filter the query results.

    integrationId: string

    The ID of the integration associated with the query.

    limit: number

    The maximum number of records to return.

    limitBy?: LimitBy<Doc>

    Optional configuration to limit results by specific fields with custom sorting.

    sortOrder: FieldSort<Doc>[]

    An array of field sort definitions to order the results.

    Settings

    Member Visibility

    On This Page

    Properties