Interface StructuredQuery

A structured query

interface StructuredQuery {
    endAt?: Cursor;
    from?: CollectionSelector[];
    limit?: number;
    offset?: number;
    orderBy?: Order[];
    select?: Projection;
    startAt?: Cursor;
    where?: Filter;
}

Index

Properties

endAt? from? limit? offset? orderBy? select? startAt? where?

Properties

`Optional`endAt

endAt?: Cursor

An end point for the query results

`Optional`from

from?: CollectionSelector[]

The collections to query

`Optional`limit

limit?: number

The maximum number of results to return

`Optional`offset

offset?: number

The number of documents to skip

`Optional`orderBy

orderBy?: Order[]

The order to apply to the query results

`Optional`select

select?: Projection

The projection to return

`Optional`startAt

startAt?: Cursor

A starting point for the query results

`Optional`where

where?: Filter

The filter to apply