Expression Language Reference
    Preparing search index...

    Interface QueryDocumentOpts

    Options for document query operation

    interface QueryDocumentOpts {
        advanced?: boolean;
        client_identifier?: string;
        columns?: string[];
        document_types?: string[];
        ids_only?: boolean;
        include_child_count?: boolean;
        is_fragment?: boolean;
        limit?: number;
        offset?: number;
        order?: string[];
        parent?: string;
        query?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    advanced? client_identifier? columns? document_types? ids_only? include_child_count? is_fragment? limit? offset? order? parent? query?

    Properties

    advanced?: boolean
    client_identifier?: string
    columns?: string[]
    document_types?: string[]

    Document types to allow in the response

    ids_only?: boolean

    When true the result will contain just the document ids

    include_child_count?: boolean

    When true the result will include the # of children of each returned documents

    is_fragment?: boolean

    Filter explicitly for or without fragments

    limit?: number
    offset?: number
    order?: string[]
    parent?: string

    UUID of parent document

    query?: string

    Settings

    Member Visibility

    On This Page

    Properties