Skip to content
Visit Covalent docs on GitHub
Set theme to dark (⇧+D)
Covalent docs

Primer Query Parameters

NameDescription
primerBy using $pipeline, records enter a multi-stage pipeline that transforms the records into aggregated results. Supports $group and Aggregation operators.
matchFilters the records to pass only the documents that match the specified condition(s).
sortSorts all input records and returns them in acsending or decsending sorted order.
skipSkips over the specified number of records
limitLimits the number of records.

Note: These are listed in order of precedence. Eg: If primer={ ... } and match={ ... } are used, primer is executed first.

Operator Reference

Comparison

NameDescription
$eqMatches values that are equal to a specified value.
$neMatches values that are not equal to a specified value.
$gtMatches values that are greater than a specified value.
$gteMatches values that are greater than or equal to a specified value.
$ltMatches values that are less than a specified value.
$lteMatches values that are less than or equal to a specified value.
$inMatches any of the values specified in an array.
$ninMatches none of the values specified in an array.

Logical

NameDescription
$andJoins query clauses with a logical AND returns all documents that match the conditions of both clauses.
$notInverts the effect of a query expression and returns documents that do not match the query expression.
$norJoins query clauses with a logical NOR returns all documents that fail to match both clauses.
$orJoins query clauses with a logical OR returns all documents that match the conditions of either clause.

Element

NameDescription
$existsMatches documents that have the specified field.

Projection

NameDescription
$elemMatchProjects the first element in an array that matches the specified $elemMatch condition.
$groupGroups input elements by the specified _id expression and for each distinct grouping, outputs an element.

Aggregation

NameDescription
$matchFilters the records to pass only the documents that match the specified condition(s) to the next pipeline stage.
$limitLimits the number of records passed to the next stage in the pipeline.
$skipSkips over the specified number of records and passes the remaining records to the next stage in the pipeline.
$sortSorts all input records and returns them in acsending or decsending sorted order.