EntitySearchRequest

EntitySearchRequest

Schema definition for EntitySearchRequest

Schema Viewer

EntitySearchRequest

conditionobjectrequired

Query condition to use for building this snapshot.

limitinteger

Caps the matched result set; not a page size. A matched set larger than `limit` is rejected rather than returned as a truncated prefix. Values below 1 are rejected.

modelModelSpecrequired

Entity model to use for building this snapshot.

▶orderByarray

pointInTimestring

point in time

timeoutMillisinteger

The maximum time to wait in milliseconds for the query to complete.

trackingReadboolean

When true and this search runs inside an active transaction, the entities it returns are recorded into the transaction's read-set so commit-time first-committer-wins validates them. Defaults to false. Ignored outside a transaction.

Description

This schema defines the structure and validation rules for EntitySearchRequest.

Properties

• condition (object, required): Query condition to use for building this snapshot.
• limit (integer): Caps the matched result set; not a page size. A matched set larger than limit is rejected rather than returned as a truncated prefix. Values below 1 are rejected.
• model (object, required): Entity model to use for building this snapshot.
• orderBy (array):
• pointInTime (string): point in time
• timeoutMillis (integer): The maximum time to wait in milliseconds for the query to complete.
• trackingRead (boolean): When true and this search runs inside an active transaction, the entities it returns are recorded into the transaction’s read-set so commit-time first-committer-wins validates them. Defaults to false. Ignored outside a transaction.

Related Schemas

See other schemas in the search category.