Connection Setup
Before reading changes, set up your SQL Server connection. See Connecting to SQL Server for the credentials and network access required. Once the connection exists, add the SQL Server (Snapshot CDC) source component to your pipeline and select it.Snapshot Storage
SQL Server is the only connection type that supports both snapshot storage methods:- Database: the snapshot is stored as a table in your SQL Server database, and change detection runs entirely in SQL. Requires write access (
CREATE TABLE,INSERT, andDELETE) on the source database. This is the most efficient option when you have write access. - File Based: the snapshot is stored as a Parquet file on Integrate.io managed cloud storage. Use this when your database user has read-only access, or when you do not want additional tables created in the source database.
Change Detection
Choose how the component decides whether a row has changed:- Primary Key: matches rows by a unique identifier column (for example
idororder_id) and detects updates by comparing the remaining column values. Best when the table has a reliable key. - Composite Hash: builds a hash from all or selected columns and compares hashes between runs. Best when the table has no reliable primary key.
Example
Track new and updated orders to sync with a data warehouse:- Source table:
orders - Method: Primary Key
- Primary key:
order_id - Snapshot Storage: Database
- Upserted records: send to the data warehouse for processing
- Deleted records: mark as cancelled in the warehouse
Full Configuration Reference
Snapshot CDC Source reference
Configuration steps, change detection methods, query mode, best practices, troubleshooting, and limitations that apply to every Snapshot CDC source.