On this page
Kater SQL Language
Comment directives
The comments that give a field its description, AI context, format, tags and business questions.
| Directive | Where | Example |
|---|---|---|
-- @description | Above a field, join or filter | -- @description Order amount before discounts. |
-- @ai_context | Above a field, join or filter | -- @ai_context Values are combined without currency conversion. |
-- @format | Above a field, or trailing as /* @format … */ | -- @format currency(union__currency, 2) |
-- @categorical, -- @continuous | Above a field or a DDL column | -- @categorical |
-- @tags | Above a field. Double-quoted values. | -- @tags "acquisition" |
-- @business_questions | Above a field. Double-quoted values. | -- @business_questions "When did each client first show up?" |
-- @label | Above a RELATIONSHIP only | -- @label Customer |
Formats are a closed list: number(n), percent(n), big(n), id, plain, currency('USD', n) and currency(<dimension>, n), where n is 0 to 20. See Formats, descriptions and AI context.