Query Entity Records

Reads the records of a Data Hub entity that match a filter, a page at a time or all of them.

Behaviour

Risk: None · Idempotent: Yes · Safe to retry: Yes · Recovery: Replayed after a crash

Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.dataHub.queryRecords

Properties#

Input#

Entity#

Entity · String · Required · Default: Not specified in package metadata

The entity's name in the job's workspace, such as Invoice.

Filter#

Filter · String · Optional · Default: Not specified in package metadata

A JSON filter, such as {"field":"status","op":"eq","value":"open"}; combine clauses with {"and":[...]} or {"or":[...]}. Empty matches every record.

Match#

Match · IDictionary<String, Object> · Optional · Default: Not specified in package metadata

Field values the records must equal, by field name; a null value matches records without one. Applies together with Filter.

Sort#

Sort · String · Optional · Default: Not specified in package metadata

Fields to sort by, each optionally followed by asc or desc, such as 'amount desc, invoiceNumber'. Only indexed and system fields sort.

Fields#

Fields · String · Optional · Default: Not specified in package metadata

The fields to return, separated by commas, such as 'invoiceNumber, amount'. Empty returns every field.

Top#

Top · Int32 · Optional · Default: 100

The most records one page returns, 1 to 1000.

Must be between 1 and 1000.

Cursor#

Cursor · String · Optional · Default: Not specified in package metadata

The Next Cursor of the previous page, sent with the same Filter, Match and Sort. Empty starts at the first page.

Fetch All#

FetchAll · Boolean · Optional · Default: False

Read every page. Faults with dh_result_too_large past 10,000 records or 64 MiB.

Output#

Records#

Records · List<Dictionary<String, Object>> · Output

The records, each a dictionary of id, revision, createdAt, createdBy, updatedAt, updatedBy and the fields.

Data Table#

DataTable · DataTable · Output

The records as a table: id, the fields in the entity's order with their types, then the system fields.

Count#

Count · Int32 · Output

How many records were returned.

Next Cursor#

NextCursor · String · Output

Pass it as Cursor to read the next page; empty after the last page.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Create Entity Record
• Create or Update Entity Record
• Delete Entity Record
• Get Entity Record
• Update Entity Record

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Data Hub. Keywords: data hub, data service, entity, records, query, filter, search, find, list, orchestrator.

Properties

Input

Output

Retry and risk

Related activities