@dxos/client
    Preparing search index...

    Interface Query<T>

    interface Query<T> {
        "~Query": { value: T };
        ast:
            | QuerySelectClause
            | QueryFilterClause
            | QueryReferenceTraversalClause
            | QueryIncomingReferencesClause
            | QueryRelationClause
            | QueryRelationTraversalClause
            | QueryHierarchyTraversalClause
            | QueryUnionClause
            | QuerySetDifferenceClause
            | QueryOrderClause
            | QueryOptionsClause
            | QueryLimitClause;
        children(): Query.Query<any>;
        from(
            database: Database.Database | Database.Database[],
            options?: { includeFeeds?: boolean },
        ): Query.Query<T>;
        from(feeds: Feed | Feed[]): Query.Query<T>;
        from(
            allSpaces: "all-accessible-spaces",
            options?: { includeFeeds?: boolean },
        ): Query.Query<T>;
        limit(limit: number): Query.Query<T>;
        options(options: QueryOptions): Query.Query<T>;
        orderBy(...order: [Order<T>, ...Order<T>[]]): Query.Query<T>;
        parent(): Query.Query<any>;
        reference<K extends string>(
            key: K,
        ): Query.Query<
            T[K] extends Unknown
                ? Target<any[any]>
                : T[K] extends undefined
                | Unknown
                    ? Target<Exclude<any[any], undefined>>
                    : never,
        >;
        referencedBy<S extends All>(
            target: string | S,
            key: RefPropKey<Type<S>>,
        ): Query.Query<Type<S>>;
        referencedBy<S extends All>(target: string | S): Query.Query<Type<S>>;
        referencedBy(): Query.Query<any>;
        select(filter: Filter.Filter<T>): Query.Query<T>;
        select(props: Props<T>): Query.Query<T>;
        source(): Query.Query<Type.Relation.Source<T>>;
        sourceOf<S extends All>(
            relation?: string | S,
            predicates?: Props<Type<S>>,
        ): Query.Query<Type<S>>;
        target(): Query.Query<Type.Relation.Target<T>>;
        targetOf<S extends All>(
            relation?: string | S,
            predicates?: Props<Type<S>>,
        ): Query.Query<Type<S>>;
    }

    Type Parameters

    • T
    Index

    Properties

    ~Query ast

    Methods

    children from limit options orderBy parent reference referencedBy select source sourceOf target targetOf

    Properties

    "~Query": { value: T }
    ast:
        | QuerySelectClause
        | QueryFilterClause
        | QueryReferenceTraversalClause
        | QueryIncomingReferencesClause
        | QueryRelationClause
        | QueryRelationTraversalClause
        | QueryHierarchyTraversalClause
        | QueryUnionClause
        | QuerySetDifferenceClause
        | QueryOrderClause
        | QueryOptionsClause
        | QueryLimitClause

    Methods

    • Get all child objects of the current selection.

      Returns Query.Query<any>

      Query for the child objects.

    • Query from selected databases only.

      Example:

      Query.select(Filter.type(Person)).from(db);

      Parameters

      • database: Database.Database | Database.Database[]
      • Optionaloptions: { includeFeeds?: boolean }
        • OptionalincludeFeeds?: boolean

          [false] - Whether to include feeds in the query. Default is to query from automerge documents only.

      Returns Query.Query<T>

    • Query from selected feeds only.

      Example:

      Query.select(Filter.type(Person)).from(feed);

      Parameters

      • feeds: Feed | Feed[]

      Returns Query.Query<T>

    • Query from all accessible spaces.

      Example:

      Query.select(Filter.type(Person)).from('all-accessible-spaces');

      Parameters

      • allSpaces: "all-accessible-spaces"
      • Optionaloptions: { includeFeeds?: boolean }
        • OptionalincludeFeeds?: boolean

          [false] - Whether to include feeds in the query. Default is to query from automerge documents only.

      Returns Query.Query<T>

    • Limit the number of results.

      Parameters

      • limit: number

        Maximum number of results to return.

      Returns Query.Query<T>

      Query for the limited results.

    • Add options to a query.

      Parameters

      • options: QueryOptions

      Returns Query.Query<T>

    • Order the query results. Orders are specified in priority order. The first order will be applied first, etc.

      Parameters

      • ...order: [Order<T>, ...Order<T>[]]

        Order to sort the results.

      Returns Query.Query<T>

      Query for the ordered results.

    • Get the parent object of the current selection.

      Returns Query.Query<any>

      Query for the parent objects.

    • Traverse an outgoing reference.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        Property path inside T that is a reference or optional reference.

      Returns Query.Query<
          T[K] extends Unknown
              ? Target<any[any]>
              : T[K] extends undefined
              | Unknown
                  ? Target<Exclude<any[any], undefined>>
                  : never,
      >

      Query for the target of the reference.

    • Find objects referencing this object.

      Type Parameters

      • S extends All

      Parameters

      • target: string | S

        Schema of the referencing object. If not provided, matches any type.

      • key: RefPropKey<Type<S>>

        Property path inside the referencing object that is a reference. If not provided, matches any property.

      Returns Query.Query<Type<S>>

      Query for the referencing objects.

    • Type Parameters

      • S extends All

      Parameters

      • target: string | S

      Returns Query.Query<Type<S>>

    • Returns Query.Query<any>

    • Filter the current selection based on a filter.

      Parameters

      Returns Query.Query<T>

      Query for the selected objects.

    • Parameters

      Returns Query.Query<T>

    • Find relations where this object is the source.

      Type Parameters

      • S extends All

      Parameters

      • Optionalrelation: string | S

        Schema of the relation.

      • Optionalpredicates: Props<Type<S>>

        Predicates to filter the relation objects.

      Returns Query.Query<Type<S>>

      Query for the relation objects.

    • Find relations where this object is the target.

      Type Parameters

      • S extends All

      Parameters

      • Optionalrelation: string | S

        Schema of the relation.

      • Optionalpredicates: Props<Type<S>>

        Predicates to filter the relation objects.

      Returns Query.Query<Type<S>>

      Query for the relation objects.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods