Skip to content

Chore: update blueprint docs #5714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
georgesittas merged 1 commit into from
Mar 2, 2026
+9 −8
Merged

Chore: update blueprint docs #5714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/concepts/models/sql_models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,8 @@ MODEL (

SELECT
@field_a,
@{field_b} AS field_b
@{field_b} AS field_b,
@'prefix_@{field_a}_suffix' AS literal_example
FROM @customer.some_source
```

Expand All @@ -163,8 +164,9 @@ MODEL (
);

SELECT
'x',
y AS field_b
x,
y AS field_b,
'prefix_x_suffix' AS literal_example
FROM customer1.some_source

-- This uses the second variable mapping
Expand All @@ -174,14 +176,13 @@ MODEL (
);

SELECT
'z',
w AS field_b
z,
w AS field_b,
'prefix_z_suffix' AS literal_example
FROM customer2.some_source
```

Note the use of curly brace syntax `@{field_b} AS field_b` in the model query above. It is used to tell SQLMesh that the rendered variable value should be treated as a SQL identifier instead of a string literal.

You can see the different behavior in the first rendered model. `@field_a` is resolved to the string literal `'x'` (with single quotes) and `@{field_b}` is resolved to the identifier `y` (without quotes). Learn more about the curly brace syntax [here](../../concepts/macros/sqlmesh_macros.md#embedding-variables-in-strings).
Both `@field_a` and `@{field_b}` resolve blueprint variable values as SQL identifiers. The curly brace syntax is useful when embedding a variable within a larger string where the variable boundary would otherwise be ambiguous (e.g. `@{customer}_suffix`). To produce a string literal with interpolated variables, use the `@'...@{var}...'` syntax as shown with `literal_example` above. Learn more about the curly brace syntax [here](../../concepts/macros/sqlmesh_macros.md#embedding-variables-in-strings).

Blueprint variable mappings can also be constructed dynamically, e.g., by using a macro: `blueprints @gen_blueprints()`. This is useful in cases where the `blueprints` list needs to be sourced from external sources, such as CSV files.

Expand Down