Docs: add interactive init to quickstart docs #4736
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
treysp
force-pushed
the
trey/quickstart-init-update
branch
from
79adfb7 to
bd848d3
Compare
sungchun12
requested changes
Jun 18, 2025
| After SQLMesh creates a plan, it summarizes the breaking and non-breaking changes so you can understand what will happen if you apply the plan. It will prompt you to "backfill" data to apply the plan - in this context, backfill is a generic term for updating or adding to a table's data (including an initial load or full refresh). | ||
| Other changes, like adding a new column to a model in `dev`, are non-breaking because all the existing data in `prod` are still valid to use - only new data must be added to align the environments. | ||
|
|
||
| After SQLMesh creates a plan, it summarizes the breaking and non-breaking changes so you can understand what will happen if you apply the plan. It will prompt you to "backfill" data to apply the plan. (In this context, backfill is a generic term for updating or adding to a table's data, including an initial load or full refresh.) | ||
|
|
||
| The first SQLMesh plan must execute every model to populate the production environment. Running `sqlmesh plan` will generate the plan and the following output: | ||
|
|
There was a problem hiding this comment.
Add in a toggle section for sqlmesh plan --explain to show people they can see in plain terms what exact SQL will run with an example output.
| 0.05s | ||
| [1/1] sqlmesh_example.seed_model [insert seed file] 0.02s | ||
| [1/1] sqlmesh_example.incremental_model [insert 2020-01-01 -2025-04-17] 0.03s | ||
| [1/1] sqlmesh_example.full_model [full refresh, audits ✔1] 0.05s |
There was a problem hiding this comment.
After the terminal output example, include a screenshot of the tables/schemas in duckdb. You can screenshot what you see in the duckdb cli output here.
There was a problem hiding this comment.
Make it easy for people to visualize the VDEs
|
|
||
| SQLMesh's core commands have multiple options that alter their behavior. Some of those options streamline the SQLMesh `plan` workflow and CLI output. | ||
|
|
||
| If you prefer a streamlined workflow, choose the `FLOW` CLI mode to automatically include those options in your project configuration file. If you prefer to see all the output SQLMesh provides, choose `DEFAULT` mode. |
There was a problem hiding this comment.
Suggested change
| If you prefer a streamlined workflow, choose the `FLOW` CLI mode to automatically include those options in your project configuration file. If you prefer to see all the output SQLMesh provides, choose `DEFAULT` mode. | |
| If you prefer a streamlined workflow (no prompts, no diff previews, auto-apply changes), choose the `FLOW` CLI mode to automatically include those options in your project configuration file. If you prefer to see all the output SQLMesh provides, choose `DEFAULT` mode. |
| • Docs: https://sqlmesh.readthedocs.io | ||
| • Slack: https://www.tobikodata.com/slack | ||
| • GitHub: https://github.com/TobikoData/sqlmesh/issues | ||
| ``` | ||
|
|
||
| ??? info "Learn more about the project's configuration" |
There was a problem hiding this comment.
Suggested change
| ??? info "Learn more about the project's configuration" | |
| ??? info "Learn more about the project's configuration: `config.yaml`" |
| @@ -9,20 +9,20 @@ SQLMesh supports integrations with the following tools: | |||
| * [Kestra](https://kestra.io/plugins/plugin-sqlmesh/tasks/cli/io.kestra.plugin.sqlmesh.cli.sqlmeshcli) | |||
|
|
|||
| ## Execution engines | |||
| SQLMesh supports the following execution engines for running SQLMesh projects: | |||
| SQLMesh supports the following execution engines for running SQLMesh projects (engine `type` in parentheses): | |||
There was a problem hiding this comment.
Suggested change
| SQLMesh supports the following execution engines for running SQLMesh projects (engine `type` in parentheses): | |
| SQLMesh supports the following execution engines for running SQLMesh projects (engine `type` in parentheses - example usage: `pip install "sqlmesh[databricks]"`): |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.