DocsWorkflowsComponentsAppapp:records:query

app:records:query

Queries records from a schema table using filters, sorting and pagination

Options

Name	Type	Description
`org_id`	`string`	The organization ID that scopes the operation
`schema`	`string`	The name of the schema (database) to query records from
`table`	`string`	The name of the table to query records from
`page`	`int`	The page number to retrieve (1-based)
`query`	`Query`	The filter, sort, limit and offset parameters for the query
↳ `filters`	`[]Filter`	Are AND-combined predicates that records must satisfy
↳ `field`	`string`	Is the name of the field to compare. Must exist on the target table.
↳ `op`	`FilterOp`	Is the comparison operator.
↳ `value`	`any`	Is the operand. For OpIn and OpNotIn it must be a slice. Ignored for OpIsNull and OpIsNotNull.
↳ `sort`	`[]SortField`	Is the ordered list of sort criteria. Earlier entries take precedence
↳ `field`	`string`	Is the name of the field to sort by.
↳ `direction`	`SortDirection`	Is the sort order (ascending or descending).
↳ `limit`	`int`	Caps the number of returned records. 0 means no limit
↳ `offset`	`int`	Skips the first N matching records. Intended for pagination
↳ `include_deleted`	`bool`	IncludeDeleted, when true, includes soft-deleted records in the result Defaults to false so deleted records are filtered out
↳ `search`	`string`	Is a full-text search query

Outputs

Name	Type	Description
`limit`	`int`	The maximum number of records per page applied to the query
`page`	`int`	The current page number returned
`total`	`int`	The total number of matching records across all pages
`items`	`[]Record`	The records on the current page

Example

name: Query published articles
actions:
  - name: articles
    component: app:records:query
    vars:
      org_id: "{{ var.org_id }}"
      schema: content
      table: articles
      query:
        status: published

outputs:
  articles: "{{ articles.items }}"
  total: "{{ articles.total }}"

Edit or read the source on GitHub