Implementation:TobikoData Sqlmesh PlanApplyStageTracker
| Knowledge Sources | |
|---|---|
| Domains | Web_UI, Plan_Execution, Deployment_Tracking |
| Last Updated | 2026-02-07 20:00 GMT |
Overview
Concrete tool for tracking and displaying plan execution stages in the SQLMesh web client.
Description
PlanApplyStageTracker is a React component that provides real-time visualization of the plan apply workflow in SQLMesh. It displays expandable stage cards for each phase of plan execution including tests, changes detection, backfill computation, virtual updates, snapshot creation, restatement, backfilling, and environment promotion. Each stage shows status indicators (success, failure, in-progress), progress bars, task counts, timestamps, and detailed breakdowns of models being processed. The component integrates with plan state management to reactively update as execution proceeds and provides collapsible panels for detailed inspection of changes, test failures, and backfill intervals.
Usage
Use this component in the plan view to display execution progress when users run a plan or apply changes to an environment. It should be rendered below plan options and above plan action buttons.
Code Reference
Source Location
- Repository: TobikoData_Sqlmesh
- File: web/client/src/library/components/plan/PlanApplyStageTracker.tsx
Signature
export default function PlanApplyStageTracker(): JSX.Element
Import
import PlanApplyStageTracker from '@components/plan/PlanApplyStageTracker'
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| (none) | - | - | Reads from plan context stores (planApply, planOverview, planCancel, tests) |
Outputs
| Name | Type | Description |
|---|---|---|
| JSX.Element | React component | Staged execution tracker with collapsible stages |
Usage Examples
// Basic usage in plan view
<div>
<PlanOptions />
<PlanApplyStageTracker />
<PlanActions />
</div>
// The component automatically:
// - Displays test results if tests were run
// - Shows changes (added, removed, modified directly/indirectly, metadata)
// - Tracks backfill progress with intervals
// - Displays snapshot creation progress
// - Shows restatement operations
// - Tracks promotion status
// Example rendered stages:
// ✓ Tests Completed
// ✓ Changes (expandable: Added Models 3, Modified Directly 2)
// ✓ Backfills (expandable: Models 5 with intervals)
// ⟳ Creating Snapshot Tables... (progress: 3/10 tasks)
// ⟳ Backfilling Intervals... (progress: 150/500 batches)
// ✓ Environment Promoted