Extends · closed
| includes Spaces and path prefixes whose documents the query returns, each with a `Children` or `AllDescendants` mode. | of | |
| sort Sort terms for the results; the daemon applies the first. | of | optional |
| limit Maximum number of results to return. | optional |
A query is a live document query: which spaces and paths to include, how to sort, and an optional result limit. It is stored in a query block's attributes, and it is also the input of the Query API.
includes is a list of inclusions, each a space, an optional path prefix and a mode of Children or AllDescendants. sort is a list of sort terms, and the daemon applies the first. limit caps the result. The same object is the payload of a query block and of the Seed API's Query and QueryBlock requests, which return each matching document's info and metadata. Attribute filters live elsewhere: in the QueryDocuments request and the Explore grammar, described in the query grammar.
See also
block/query: the block that renders a query.
query/inclusion and query/sort: the parts of a query.
Seed API: the Query request.
Query grammar: attribute filters and QueryDocuments.
Blocks: query blocks in documents.
Do you like what you are reading? Subscribe to receive updates.
Unsubscribe anytime