Query Syntax

Overview

Generally queries will consist of a where clause plus optional modifiers controlling the specific subset of results returned.

Where Clause

The Where clause is an optional array of conditions. If omitted or empty, all documents of the queried type are returned (subject to limit). For some operators, value will be an array. All fields referenced in a query’s where clause must be defined in the same index. This includes system timestamp fields (e.g., $createdAt, $updatedAt, $transferredAt, and their block-height variants such as $createdAtBlockHeight and $createdAtCoreBlockHeight). See the following general syntax example:

{
  where: [
    [<fieldName>, <operator>, <value>],
    [<fieldName>, <array operator>, [<value1>, <value2>]] 
  ] 
}

Fields

Valid fields consist of the indices defined for the document being queried. For example, the DPNS data contract defines two indices for domain documents:

Index Field(s)	Index Type	Unique
normalizedParentDomainName, normalizedLabel	Compound	Yes
records.identity	Single Field	No

Comparison Operators

Equal

Name	Description
== (or =)	Matches values that are equal to a specified value

Range

Name	Description
<	Matches values that are less than a specified value
<=	Matches values that are less than or equal to a specified value
>=	Matches values that are greater than or equal to a specified value
>	Matches values that are greater than a specified value
in	Matches all document(s) where the value of the field equals any value in the specified array Array may include up to 100 (unique) elements
Between	Matches values between two bounds (inclusive on both sides) — value must be a two-element array [lower, upper] with lower < upper
BetweenExcludeBounds	Matches values strictly between two bounds (exclusive on both sides)
BetweenExcludeLeft	Matches values between two bounds, excluding the lower bound
BetweenExcludeRight	Matches values between two bounds, excluding the upper bound

Tip

• Only one range operator is allowed in a query. Between and its variants are single operators that replace a >=/<= pair — the engine also normalizes two range operators on the same field into the equivalent Between* form automatically

• The in operator is only allowed for last two indexed properties

• Range operators are only allowed after == and in operators

• Range operators are only allowed for the last two fields used in the where condition

• Queries using range operators must also include an orderBy statement

Evaluation Operators

Name	Description
startsWith	Selects documents where the value of a field begins with the specified characters. Must include an orderBy statement.

Operator Examples

Range

{
  where: [
    ["nameHash", "<", "56116861626961756e6176657a382e64617368"],
  ],
}

Between

{
  where: [
    ["normalizedParentDomainName", "==", "dash"],
    // Return names between "alice" and "carol" (inclusive)
    ["normalizedLabel", "Between", ["alice", "carol"]],
  ],
  orderBy: [
    ["normalizedLabel", "asc"],
  ]
}

in

{
  where: [
      ["normalizedParentDomainName", "==", "dash"],
      // Return all matching names from the provided array
      ["normalizedLabel", "in", ["alice", "bob"]],
    ]
}

startsWith

{
  where: [
      ["normalizedParentDomainName", "==", "dash"],
      // Return any names beginning with "al" (e.g. alice, alfred)
      ["normalizedLabel", "startsWith", "al"],
    ],
  orderBy: [
    ["normalizedLabel", "asc"],
  ]
}

Query Modifiers

The query modifiers described here determine how query results will be sorted and what subset of data matching the query will be returned.

Modifier	Effect	Example
limit	Restricts the number of results returned (maximum: 100)	limit: 10
orderBy	Returns records sorted by the field(s) provided. Sorting must be by the last indexed property. Can only be used with >, <, >=, <=, Between, BetweenExcludeBounds, BetweenExcludeLeft, BetweenExcludeRight, and startsWith queries.	orderBy: [['normalizedLabel', 'asc']]
startAt	Returns records beginning with the document ID provided	startAt: '<document ID>'
startAfter	Returns records beginning after the document ID provided	startAfter: '<document ID>'
offset	Skips the first N matching results (available at the CBOR/DAPI layer; not exposed in the JS SDK)	offset: 10

Attention

For indices composed of multiple fields (example from the DPNS data contract), the sort order in an orderBy must either match the order defined in the data contract OR be the inverse order.

Example query

The following query combines both a where clause and query modifiers.

Query object

const query = {
  limit: 5,
  startAt: '4Qp3menV9QjE92hc3BzkUCusAmHLxh1AU6gsVsPF4L2q',
  where: [
    ['normalizedParentDomainName', '==', 'dash'],
    ['normalizedLabel', 'startsWith', 'test'],
  ],
  orderBy: [
    ['normalizedLabel', 'asc'],
  ],
}

Evo SDK example

import { EvoSDK } from '@dashevo/evo-sdk';

const sdk = EvoSDK.testnetTrusted();
await sdk.connect();

const results = await sdk.documents.query({
  dataContractId: 'GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec',
  documentTypeName: 'domain',
  limit: 5,
  startAt: '4etYFuWbXRXB74gTDp53eLUqjLEAtNSfUX2XtrQ1uMdT',
  where: [
    ['normalizedParentDomainName', '==', 'dash'],
    ['normalizedLabel', 'startsWith', 'test'],
  ],
  orderBy: [
    ['normalizedLabel', 'asc'],
  ],
});

for (const [id, doc] of results) {
  console.log(id.toString(), doc?.toJSON());
}