sqlct 0.2.1

SQL Change Tracker (sqlct)

sqlct is a cross-platform CLI for state-based SQL Server schema change tracking. It focuses on deterministic output and schema-folder workflows that are Git and CI/CD friendly.

Purpose

• Manage SQL schema changes as code using a schema folder as the source of truth.
• Keep scripting output deterministic for stable diffs and repeatable automation.
• Support compatibility-oriented workflows for teams with existing schema-folder conventions.

Principles

• State-based workflow.
• Deterministic scripting.
• Explicit, reversible commands.
• Cross-platform usage on Windows, macOS, and Linux.
• Git-agnostic operation.

Current Commands

sqlct init [--project-dir <path>]
sqlct config [--project-dir <path>]
sqlct data track <pattern> [--project-dir <path>]
sqlct data untrack <pattern> [--project-dir <path>]
sqlct data list [--project-dir <path>]
sqlct status [--project-dir <path>] [--target <db|folder>] [--no-progress]
sqlct diff [--project-dir <path>] [--target <db|folder>] [--object <selector>] [--no-progress]
sqlct pull [--project-dir <path>] [--no-progress]

Current runtime scope for status, diff, and pull covers:

• Table
• View
• StoredProcedure
• Function
• Sequence
• Schema
• Role
• User
• Synonym
• UserDefinedType
• PartitionFunction
• PartitionScheme

When data.trackedTables is configured, status, diff, and pull also process TableData artifacts for those explicit tracked tables.

--object selectors support:

• schema.name for schema-scoped objects
• name for schema-less objects
• type:name and type:schema.name for explicit selection
• data:schema.name for tracked table-data scripts

Selective Data Scripting

Tracked-table data scripting is configuration-driven.

• sqlct data track matches user tables in the current database and asks for confirmation before updating data.trackedTables.
• sqlct data untrack previews tracked matches and asks for confirmation before removing them.
• sqlct data list shows the currently tracked tables from config.
• sqlct pull creates, updates, and deletes Data/Schema.Table_Data.sql files for tracked tables.
• sqlct status and sqlct diff include TableData alongside schema artifacts, with separate schema/data summaries in status.

Example:

sqlct data track Sales.* --project-dir ./schema
sqlct data list --project-dir ./schema
sqlct diff --project-dir ./schema --object data:Sales.Customer
sqlct pull --project-dir ./schema

Install

Global:

dotnet tool install --global sqlct

Local (tool manifest):

dotnet new tool-manifest
dotnet tool install --local sqlct