query

name	query
description	Run a semantic query against the database via airlayer. Use when the user wants to query data through the semantic layer, test view definitions, or debug query results.

Run a Semantic Query

You are running a semantic query through airlayer's execution interface.

Usage

# Compile + execute (returns structured JSON envelope)
airlayer query -x \
  --dimension <view>.<dim> \
  --measure <view>.<measure> \
  [--filter <view>.<dim>:<operator>:<value>] \
  [--order <view>.<member>:asc|desc] \
  [--limit N] \
  [--segments <view>.<segment>] \
  [--motif <motif_name>] \
  [--motif-param <key>=<value>]

Filter operators

Format: member:operator:value (multiple values comma-separated)

Operator	Example	Description
equals	orders.status:equals:completed	Exact match
notEquals	orders.status:notEquals:cancelled	Not equal
contains	orders.name:contains:widget	String contains
notContains	orders.name:notContains:test	String doesn't contain
startsWith	orders.name:startsWith:Pro	String starts with
endsWith	orders.name:endsWith:Plan	String ends with
gt	orders.amount:gt:100	Greater than
gte	orders.amount:gte:100	Greater than or equal
lt	orders.amount:lt:1000	Less than
lte	orders.amount:lte:1000	Less than or equal
in	orders.status:in:completed,shipped	In list
notIn	orders.status:notIn:cancelled,returned	Not in list
set	orders.email:set	Is not null
notSet	orders.email:notSet	Is null
beforeDate	orders.created_at:beforeDate:2025-01-01	Before date
afterDate	orders.created_at:afterDate:2025-01-01	After date

Reading the envelope

The --execute flag returns a JSON envelope:

{
  "status": "success",           // or "parse_error", "compile_error", "execution_error"
  "sql": "SELECT ...",           // the compiled SQL
  "columns": [...],              // column metadata (name, member, kind)
  "data": [...],                 // result rows (max 50)
  "row_count": 3,                // true total row count
  "views_used": ["orders"],      // which .view.yml files were involved
  "error": null                  // error message if status != "success"
}

Interpreting errors

• parse_error: Bad YAML in view files, or invalid query input. Fix the YAML syntax.
• compile_error: Member path doesn't exist, or join can't be resolved. Check dimension/measure names.
• execution_error: Database rejected the SQL. Check expr fields — the column names may be wrong. The sql field shows exactly what was sent.

Motifs

Motifs add post-aggregation analytical columns by wrapping the base query as a CTE. Use --motif <name> on the CLI or "motif": "<name>" in JSON queries.

Builtin motifs: yoy, qoq, mom, wow, dod, anomaly, contribution, trend, moving_average, rank, percent_of_total, cumulative.

• contribution: adds total and share columns (what % does each group contribute?)
• rank: adds rank column (ordered by the measure descending)
• percent_of_total: adds percent_of_total column (100 * measure / total)
• anomaly: adds mean_value, stddev_value, z_score, is_anomaly columns (default z-score threshold: 2)
• yoy: adds previous_value, growth_rate — use with granularity: year
• qoq: adds previous_value, growth_rate — use with granularity: quarter
• mom: adds previous_value, growth_rate — use with granularity: month
• wow: adds previous_value, growth_rate — use with granularity: week
• dod: adds previous_value, growth_rate — use with granularity: day
• moving_average: adds moving_avg column (7-period rolling average, requires time dimension)
• cumulative: adds cumulative_value column (running sum, requires time dimension)
• trend: adds row_n, slope, intercept, trend_value columns (linear regression, requires time dimension)

Critical: PoP motifs use LAG(1), so granularity MUST match: yoy needs year, mom needs month, etc.

# Non-time motif (contribution analysis)
airlayer query -x \
  --dimension orders.category \
  --measure orders.total_revenue \
  --motif contribution

# Period-over-period (granularity must match motif)
airlayer query -x -q '{
  "measures": ["orders.total_revenue"],
  "time_dimensions": [{"dimension": "orders.order_date", "granularity": "day"}],
  "motif": "dod"
}'

# Anomaly with custom threshold
airlayer query -x -q '{
  "measures": ["orders.total_revenue"],
  "motif": "anomaly",
  "motif_params": {"threshold": 3}
}'

Motif params

Motif params control which measure/dimension a motif operates on. Pass them via motif_params in JSON queries or --motif-param on the CLI.

Auto-binding: When a query has exactly one measure, {{ measure }} auto-binds to it. When there are multiple measures, you MUST specify which one via motif_params. Same rule for {{ time }} with multiple time dimensions.

# Single measure — auto-binds, no motif_params needed
airlayer query -x \
  --measure orders.total_revenue \
  --motif rank

# Multiple measures — must specify which measure the motif operates on
airlayer query -x \
  --measure orders.total_revenue --measure orders.order_count \
  --motif rank --motif-param measure=orders.total_revenue

motif_params values are semantic member names (e.g., orders.total_revenue), not SQL aliases. They are resolved to CTE column aliases internally.

Other params:

• anomaly: threshold — z-score threshold (default: 2)
• moving_average: window — periods preceding (default: 6, meaning 7-period window)

Custom motifs

Custom motifs (.motif.yml in motifs/) extend the builtin catalog. They use {{ param }} substitution and are always single-stage. Custom motifs can declare multiple type: measure params for different roles:

name: ratio
params:
  numerator: { type: measure }
  denominator: { type: measure }
outputs:
  - name: ratio
    expr: "CAST({{ numerator }} AS DOUBLE) / NULLIF({{ denominator }}, 0)"

# Custom motif with two measure params
airlayer query -x \
  --measure orders.total_revenue --measure orders.order_count \
  --motif ratio \
  --motif-param numerator=orders.total_revenue \
  --motif-param denominator=orders.order_count

Discovery

Before querying, discover what's available. All commands auto-detect the project root — no --config needed from inside the project.

# List all views, dimensions, measures (machine-readable)
airlayer inspect --json

# List all motifs with params and outputs
airlayer inspect --motifs

# List all saved queries with steps
airlayer inspect --queries

Saved queries

Run a saved query by filepath:

# Compile all steps to SQL (dry run)
airlayer query queries/revenue_investigation.query.yml

# Execute all steps against the database
airlayer query queries/revenue_investigation.query.yml -x

JSON query format

For complex queries, use -q with JSON:

airlayer query -x -q '{
  "dimensions": ["orders.category", "orders.region"],
  "measures": ["orders.total_revenue"],
  "filters": [{"member": "orders.status", "operator": "equals", "values": ["completed"]}],
  "order": [{"id": "orders.total_revenue", "desc": true}],
  "limit": 10
}'