Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Query Component

Prev Next

The Query Component runs a Query Smart Component definition inside a module. It becomes available in the component tray after a Query Smart Component is created and shared, and Creators use it to retrieve and store query results without writing code.

Query Component In a Module

The Build Agent places a Query Component automatically when Creators ask it to add a smart query to a module. It wires the component to the Query Smart Component definition it creates, maps the input parameters, and places the component on the canvas.

Creators can also add a Query Component manually. When a Query Smart Component is shared (marked as discoverable), it displays as a preset item in the QUERY section of the Config View component tray. Dragging a preset onto the canvas places a Query Component pre-configured to run that definition.

The QUERY section in the component tray carries the UnqorkAI sparkle icon to indicate that Query Components are powered by UnqorkAI. The section displays only when UnqorkAI is enabled for the workspace. Each item in the section uses the Smart Components icon and represents a single shared Query Smart Component.

How to read settings tables

The tables below describe each configurable option as it displays in the Unqork IDE. Values are formatted as follows: inline code — a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked

General Settings

Setting

Field

Type

Default

Description

Property ID

key

Text input

The unique identifier for this component instance.

Description

description

Text input

A free-text note about the component's purpose. This field is for Creator reference and does not affect component behavior.

Configuration Settings

The Configuration tab maps module data to the query definition's input parameters. Each row binds a parameter declared in the Query Smart Component to a module component that supplies its value.

Setting

Field

Type

Default

Description

Query Inputs

dataInputObject

Table

Maps each query input parameter to a module component by alias. Add a row for each parameter the query definition declares.

Outputs Settings

The Outputs tab defines where the component stores the data the query returns. The query definition's output schema determines the shape of the results slot.

Setting

Field

Type

Default

Description

Outputs

dataOutputObject

Table

Maps the query's return data to module component property IDs. The results slot stores data from a successful query run. The error slot stores a code, message, and optional errors detail when the query fails.

Actions Settings

Triggers

Setting

Field

Type

Default

Description

Trigger Type

triggerType

Drop-down

Manual

Sets when the query runs. Options include: Manual or Watch.

↳ Set Debounce

debounceSetting

Number input

500

The delay in milliseconds before the query runs after an input changes. Visible when Trigger Type is set to Watch. Accepts values of 0 or greater.

Triggered By

Read-only display

Displays the components that  this Query Component. Trigger wiring is set on the triggering component, not here.

Post Trigger

postTrigger

Property ID

The component to trigger after the query runs successfully.

Error Trigger

errorTrigger

Property ID

The component to trigger when the query returns an error.


Changelog

Date

Change

2026-08-21

Article created.