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

Index

Properties

~Query ast

Methods

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

Properties

~Query

"~Query": { value: T }

ast

Methods

children

children(): Query.Query<any>
Get all child objects of the current selection.

Returns Query.Query<any>
Query for the child objects.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:74

from

from(
database: Database.Database | Database.Database[],
options?: { includeFeeds?: boolean },
): Query.Query<T>
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>
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:99
from(feeds: Feed | Feed[]): Query.Query<T>
Query from selected feeds only.

Example:
```
Query.select(Filter.type(Person)).from(feed);
```
Parameters
- feeds: Feed | Feed[]
Returns Query.Query<T>
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:112
from(
allSpaces: "all-accessible-spaces",
options?: { includeFeeds?: boolean },
): 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>
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:124

limit

limit(limit: number): 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.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:87

options

options(options: QueryOptions): Query.Query<T>
Add options to a query.
Parameters
- options: QueryOptions
Returns Query.Query<T>
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:130

orderBy

orderBy(...order: [Order<T>, ...Order<T>[]]): 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.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:81

parent

parent(): Query.Query<any>
Get the parent object of the current selection.

Returns Query.Query<any>
Query for the parent objects.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:69

reference

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,
>
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.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:31

referencedBy

referencedBy<S extends All>(
target: string | S,
key: RefPropKey<Type<S>>,
): Query.Query<Type<S>>
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.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:38
referencedBy<S extends All>(target: string | S): Query.Query<Type<S>>
Type Parameters
- S extends All
Parameters
- target: string | S
Returns Query.Query<Type<S>>
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:39
referencedBy(): Query.Query<any>
Returns Query.Query<any>
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:40

select

select(filter: Filter.Filter<T>): Query.Query<T>
Filter the current selection based on a filter.
Parameters
- filter: Filter.Filter<T>
  Filter to select the objects.
Returns Query.Query<T>
Query for the selected objects.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:24
select(props: Props<T>): Query.Query<T>
Parameters
- props: Props<T>
Returns Query.Query<T>
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:25

source

source(): Query.Query<Type.Relation.Source<T>>
For a query for relations, get the source objects.

Returns Query.Query<Type.Relation.Source<T>>
Query for the source objects.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:59

sourceOf

sourceOf<S extends All>(
relation?: string | S,
predicates?: Props<Type<S>>,
): Query.Query<Type<S>>
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.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:47

target

target(): Query.Query<Type.Relation.Target<T>>
For a query for relations, get the target objects.

Returns Query.Query<Type.Relation.Target<T>>
Query for the target objects.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:64

targetOf

targetOf<S extends All>(
relation?: string | S,
predicates?: Props<Type<S>>,
): Query.Query<Type<S>>
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.
- Defined in packages/core/echo/echo/dist/types/src/Query.d.ts:54

Interface Query<T>

Type Parameters

Index

Properties

Methods

Properties

~Query

ast

Methods

children

Returns Query.Query<any>

from

Parameters

OptionalincludeFeeds?: boolean

Returns Query.Query<T>

Parameters

Returns Query.Query<T>

Parameters

OptionalincludeFeeds?: boolean

Returns Query.Query<T>

limit

Parameters

Returns Query.Query<T>

options

Parameters

Returns Query.Query<T>

orderBy

Parameters

Returns Query.Query<T>

parent

Returns Query.Query<any>

reference

Type Parameters

Parameters

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

referencedBy

Type Parameters

Parameters

Returns Query.Query<Type<S>>

Type Parameters

Parameters

Returns Query.Query<Type<S>>

Returns Query.Query<any>

select

Parameters

Returns Query.Query<T>

Parameters

Returns Query.Query<T>

source

Returns Query.Query<Type.Relation.Source<T>>

sourceOf

Type Parameters

Parameters

Returns Query.Query<Type<S>>

target

Returns Query.Query<Type.Relation.Target<T>>

targetOf

Type Parameters

Parameters

Returns Query.Query<Type<S>>

Settings

On This Page

`Optional`includeFeeds?: boolean

`Optional`includeFeeds?: boolean

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