Skip to content

docs(plugin-sqlmesh): add how-to doc #70

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

Open
aj-emerich wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(plugin-sqlmesh): add how-to doc #70

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
11 changes: 11 additions & 0 deletions src/main/resources/doc/io.kestra.plugin.sqlmesh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# How to use the SQLMesh plugin

Run SQLMesh CLI commands — plan, apply, test, and audit transformations — from Kestra flows inside a container.

## Common properties

`containerImage` defaults to `ghcr.io/kestra-io/sqlmesh`. `taskRunner` controls where the container runs — defaults to Docker.

## Tasks

`cli.SQLMeshCLI` runs one or more SQLMesh CLI commands set in `commands` (e.g. `sqlmesh plan --auto-apply`, `sqlmesh run`, `sqlmesh test`). Use `beforeCommands` for setup steps. Pass database credentials and other secrets as environment variables via `env` — store sensitive values in [secrets](https://kestra.io/docs/concepts/secret). Pass supporting config files via `inputFiles` or pull them from [namespace files](https://kestra.io/docs/concepts/namespace-files). Apply runner properties globally with [plugin defaults](https://kestra.io/docs/workflow-components/plugin-defaults).
Loading