runQL creates and maintains clear descriptions across your schema so anyone can find the right data and meaning fast.
varchar(255) • NOT NULL
This identifier connects an individual order item to the main customer
order. It allows you to group all items that were purchased together in
a single transaction. It is found in the order_id column of
the order_items
table and links to the id in the orders table.
tinyint(1) • NOT NULL
This is a True/False indicator that tells you whether the product is
categorized as a drink item. It's useful for analyzing beverage sales,
managing drink inventory, or understanding customer preferences for
drinks. This is derived from the type column in the
products
table.
timestamp • NOT NULL
This field shows the exact date and time when a customer placed their
order. It's useful for understanding sales trends over time, identifying
peak ordering periods, and analyzing customer behavior patterns. It
comes from the ordered_at column in
the orders
table.
Not just table names, real descriptions people can actually use.
What this table represents and how it should be used.
Meaning, data types, formats, and example values.
The Sigma/Retool resources available and how they help.
Official definitions for metrics like "activation date" or "ARR".
What connects to what, explained in plain language.
Links to relevant dashboards, apps, and saved answers (queries).
This is a one-time setup, then it keeps improving over time.
Read-only access to schemas and external apps.
Ingest internal docs, dbt docs, or our built-in Saleforce CRM and MS F&O docs.
Create metadata and business descriptions for all data and external resources.
New resources get auto documented; changes get flagged for review.
You’re not stuck with the automated text. Your team owns the final definitions.
This is a True/False indicator that tells you whether the product is categorized as a drink item. It's useful for analyzing beverage sales, managing drink inventory, or understanding customer preferences for drinks. This is derived from the type column in the products table.
0 means it is not a drink order, 1 means it is a drink order. Use this indicator to understand drink order history for example as part of a query to understand the revenue we make from drink orders or what type of drinks get ordered the most.
`orders`.`count_order_items`
DECIMAL(10,2) -> INT in `orders`.`total_cents`
`customer_mapping`
This is where manual documentation always breaks.
Documenting and maintiaing a real schema manually is a major project. runQL does the first pass automatically.