SQLMesh

sqlmesh

SQLMesh is a next-generation data transformation framework designed to ship data quickly, efficiently, and without error.

Detected by sqlmesh | macOS, Linux, Windows |sqlmesh.readthedocs.io

Sync it sqlmesh.toml

Sync rules

What travels, what stays, what never leaves

SQLMesh in your home directory Every rule on this page, by file

gateways.*.*.passwordgateways.*.*.tokengateways.*.*.access_tokengateways.*.*.private_keygateways.*.*.private_key_passphrasegateways.*.*.client_secretgateways.*.*.keyfile_jsonenv_vars.*

Lifted into your secret store; the rest of the file syncs.

gateways.*.*.passwordgateways.*.*.tokengateways.*.*.access_tokengateways.*.*.private_keygateways.*.*.private_key_passphrasegateways.*.*.client_secretgateways.*.*.keyfile_jsonenv_vars.*

Lifted into your secret store; the rest of the file syncs.

gateways.*.*.passwordgateways.*.*.tokengateways.*.*.access_tokengateways.*.*.private_keygateways.*.*.private_key_passphrasegateways.*.*.client_secretgateways.*.*.keyfile_jsonenv_vars.*

Lifted into your secret store; the rest of the file syncs.

gateways.*.*.passwordgateways.*.*.tokengateways.*.*.access_tokengateways.*.*.private_keygateways.*.*.private_key_passphrasegateways.*.*.client_secretgateways.*.*.keyfile_jsonenv_vars.*

Lifted into your secret store; the rest of the file syncs.

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/sqlmesh.tomlThe file this page is generated from

id = "sqlmesh"

name = "SQLMesh"

homepage = "https://sqlmesh.readthedocs.io"

description = "SQLMesh is a next-generation data transformation framework designed to ship data quickly, efficiently, and without error."

# SQLMesh's own favicon, the SVG the documentation site serves.

icon = "https://sqlmesh.readthedocs.io/en/stable/_readthedocs/html/favicon.svg"

detect = ["sqlmesh"]

# https://sqlmesh.readthedocs.io/en/stable/guides/configuration/ — "SQLMesh

# configuration parameters can be set as environment variables, in a

# configuration file in the ~/.sqlmesh folder, and in the configuration file

# within a project folder", and the connections guide says a gateway "can be

# done in either the config.yaml file in your project folder, or the one in

# ~/.sqlmesh".

# The four names are sqlmesh/core/config/common.py:

# ALL_CONFIG_FILENAMES = ("config.py", "config.yml", "config.yaml",

# "sqlmesh.yml", "sqlmesh.yaml")

# # For personal paths (~/.sqlmesh/) where python config is not supported

# YAML_CONFIG_FILENAMES = tuple(n for n in ALL_CONFIG_FILENAMES

# if not n.endswith(".py"))

# and the directory is sqlmesh/core/constants.py:

# SQLMESH_PATH = Path(os.getenv("SQLMESH_HOME") or Path.home() / ".sqlmesh")

# config.py is project-only, so it is not listed here.

paths = [

"~/.sqlmesh/config.yaml",

"~/.sqlmesh/config.yml",

"~/.sqlmesh/sqlmesh.yaml",

"~/.sqlmesh/sqlmesh.yml",

]

exclude = []

# Not a whole-file secret: gateway names, dialect and model defaults are the

# point of the personal config. The connection credentials are lifted out.

secret = []

# Read when a command starts; the CLI and the web UI both reload it on the

# next run rather than holding it.

side_effect = false

# Every personal file name, or the credential is only lifted out of whichever

# spelling this machine happens to use.

# A gateway is `gateways.<name>.<connection|state_connection|test_connection>`,

# so the second `*` covers all three. The field names come from

# sqlmesh/core/config/connection.py: `password` (Snowflake, Postgres, Redshift,

# MySQL, MSSQL, Trino, StarRocks…), `token` (MotherDuck, Snowflake OAuth,

# BigQuery), `access_token` (Databricks), `private_key` and

# `private_key_passphrase` (Snowflake key-pair auth), `client_secret` and

# `keyfile_json` (BigQuery service accounts).

# `env_vars` is the personal config's own escape hatch — loader.py reads it

# before anything else and exports it into the process — and the docs point

# users at env vars precisely so credentials do not sit in the file, which

# makes it the place they end up.

[[secret_paths]]

file = [

"~/.sqlmesh/config.yaml",

"~/.sqlmesh/config.yml",

"~/.sqlmesh/sqlmesh.yaml",

"~/.sqlmesh/sqlmesh.yml",

]

match = { key_path = [

"gateways.*.*.password",

"gateways.*.*.token",

"gateways.*.*.access_token",

"gateways.*.*.private_key",

"gateways.*.*.private_key_passphrase",

"gateways.*.*.client_secret",

"gateways.*.*.keyfile_json",

"env_vars.*",

] }

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/sqlmesh. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page.