Skip to content

Commit e6dff9b

Browse files
authoredFeb 8, 2025··
Docs: update CLI quickstart's CLI output (#3802)
1 parent d9f8f55 commit e6dff9b

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed
 

‎docs/quickstart/cli.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,7 @@ $ sqlmesh plan dev
324324
======================================================================
325325
Successfully Ran 1 tests against duckdb
326326
----------------------------------------------------------------------
327+
327328
New environment `dev` will be created from `prod`
328329

329330
Differences from the `prod` environment:
@@ -349,39 +350,36 @@ Models:
349350
Directly Modified: sqlmesh_example__dev.incremental_model (Non-breaking)
350351
└── Indirectly Modified Children:
351352
└── sqlmesh_example__dev.full_model (Indirect Non-breaking)
352-
Models needing backfill (missing dates):
353-
└── sqlmesh_example__dev.incremental_model: 2020-01-01 - 2023-05-31
354-
Enter the backfill start date (eg. '1 year', '2020-01-01') or blank to backfill from the beginning of history:
353+
Models needing backfill:
354+
└── sqlmesh_example__dev.incremental_model: [2020-01-01 - 2023-05-31]
355+
Apply - Backfill Tables [y/n]: y
355356
```
356357

357-
Line 5 of the output states that a new environment `dev` will be created from the existing `prod` environment.
358+
Line 6 of the output states that a new environment `dev` will be created from the existing `prod` environment.
358359

359-
Lines 7-13 summarize the differences between the modified model and the `prod` environment, detecting that we directly modified `incremental_model` and that `full_model` was indirectly modified because it selects from the incremental model. Note that the model schemas are `sqlmesh_example__dev`, indicating that they are being created in the `dev` environment.
360+
Lines 8-14 summarize the differences between the modified model and the `prod` environment, detecting that we directly modified `incremental_model` and that `full_model` was indirectly modified because it selects from the incremental model. Note that the model schemas are `sqlmesh_example__dev`, indicating that they are being created in the `dev` environment.
360361

361-
On line 27, we see that SQLMesh automatically classified the change as `Non-breaking` because it understood that the change was additive (added a column not used by `full_model`) and did not invalidate any data already in `prod`.
362+
On line 28, we see that SQLMesh automatically classified the change as `Non-breaking` because it understood that the change was additive (added a column not used by `full_model`) and did not invalidate any data already in `prod`.
362363

363-
Hit `Enter` at the prompt to backfill data from our start date `2020-01-01`. Another prompt will appear asking for a backfill end date; hit `Enter` to backfill until now. Finally, enter `y` and press `Enter` to apply the plan and execute the backfill:
364+
Enter `y` at the prompt and press `Enter` to apply the plan and execute the backfill:
364365

365366
```bash linenums="1"
366-
Enter the backfill start date (eg. '1 year', '2020-01-01') or blank to backfill from the beginning of history:
367-
Enter the backfill end date (eg. '1 month ago', '2020-01-01') or blank to backfill up until now:
368367
Apply - Backfill Tables [y/n]: y
369368
Creating physical tables ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.0% • 2/2 • 0:00:00
370369

371-
All model versions have been created successfully
370+
Model versions created successfully
372371

373372
[1/1] sqlmesh_example__dev.incremental_model evaluated in 0.01s
374373
Evaluating models ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.0% • 1/1 • 0:00:00
375374

376-
377-
All model batches have been executed successfully
375+
Model batches executed successfully
378376

379377
Virtually Updating 'dev' ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.0% • 0:00:00
380378

381-
The target environment has been updated successfully
379+
Target environment updated successfully
382380
```
383381

384-
Line 8 of the output shows that SQLMesh applied the change and evaluated `sqlmesh_example__dev.incremental_model`.
382+
Line 6 of the output shows that SQLMesh applied the change and evaluated `sqlmesh_example__dev.incremental_model`.
385383

386384
SQLMesh did not need to backfill anything for the `full_model` since the change was `Non-breaking`.
387385

@@ -460,7 +458,7 @@ Directly Modified: sqlmesh_example.incremental_model (Non-breaking)
460458
Apply - Virtual Update [y/n]: y
461459
Virtually Updating 'prod' ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.0% • 0:00:00
462460

463-
The target environment has been updated successfully
461+
Target environment updated successfully
464462

465463
Virtual Update executed successfully
466464
```

0 commit comments

Comments
 (0)
Please sign in to comment.