Vex · reference

Vex, to look up

The files the package ships and every example. Each example runs in this page, on the package version shown in the bar above.

Read

README.md DOCS.md DESIGN.md CHANGELOG.md

API

Exported functions and schemas: the query engine, the Zod schema of the DSL, the query analyzer, the $context collector, and the functions that create and merge scope policies.

createQueryEngine QuerySchema analyze collectQueryContext createScopePolicy mergeScopePolicies

Query DSL

Each clause of the query DSL, with the SQL it compiles to. Writes are the last entry.

Select and alias (fields)Filter (filter)Comparison operators Logical operators (and, or, not)Sort (sort)Limit: default and maximum Parameters ($context)Joins Aggregates and groupByOptional filters (optional)Writes: insert, update, delete, upsert

Errors

Queries the engine rejects before any SQL is compiled, with the error each one throws.

Unknown table Unknown column Value in a column position Join without a foreign key

Scope policies

The effect of a scope policy on compiled SQL: row filters by role, scope values as bound parameters, denied tables, and columns set on write.

Row filter by role (match)Scope values as bound parameters Table not granted (scope_denied)Column set by policy on write (set)