Implementation:TobikoData Sqlmesh PlanOptions
| Knowledge Sources | |
|---|---|
| Domains | Web_UI, Plan_Configuration, User_Input |
| Last Updated | 2026-02-07 20:00 GMT |
Overview
Concrete tool for configuring plan execution options in the SQLMesh web client.
Description
PlanOptions is a React form component that provides a collapsible interface for configuring plan execution parameters. It exposes options for test skipping, gap prevention, backfill skipping, forward-only changes, auto-apply, manual categorization, include unmodified models, environment creation source, and model restatement. The component uses toggle switches for boolean options and input fields for text-based options. It integrates with PlanBackfillDates for date range selection and automatically disables options during plan execution or when the plan is already applied. The component syncs with plan context to persist user selections.
Usage
Use this component in the plan view to allow users to configure plan execution behavior before running a plan. It should be rendered above the plan tracker and action buttons.
Code Reference
Source Location
- Repository: TobikoData_Sqlmesh
- File: web/client/src/library/components/plan/PlanOptions.tsx
Signature
export default function PlanOptions(): JSX.Element
Import
import PlanOptions from '@components/plan/PlanOptions'
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| (none) | - | - | Reads from plan context (usePlan) and environment context |
Outputs
| Name | Type | Description |
|---|---|---|
| JSX.Element | React component | Form with collapsible plan options |
Usage Examples
// Basic usage in plan view
<form>
<PlanOptions />
</form>
// The component renders:
// - Backfill date range selector (via PlanBackfillDates)
// - Collapsible "Additional Options" section with:
// - Create From Environment (dropdown)
// - Restate Models (text input)
// - Skip Tests (toggle)
// - No Gaps (toggle)
// - Skip Backfill (toggle)
// - Include Unmodified (toggle)
// - Forward Only (toggle)
// - Auto Apply (toggle)
// - No Auto Categorization (toggle)
// Options automatically dispatch to plan context:
dispatch({
type: EnumPlanActions.PlanOptions,
skip_tests: true,
no_gaps: false,
forward_only: true,
// ... other options
})
// State-aware behavior:
// - Disables all options during plan execution
// - Shows "(Read Only)" label when disabled
// - Auto-collapses during processing
// - Disables specific options for initial prod plans