Skip to main content

​
Overview

Microsoft SQL Server is a robust relational database management system that enables secure and efficient data management. Datazone provides native integration with SQL Server to read data directly from your databases.

​
Connection Parameters

Set on the source when you create it. Names match the API and CLI payload.
​
string
required
Name — a unique identifier for your SQL Server source.
​
string
required
Host — hostname or IP address of your SQL Server instance.
​
string
required
Port — port the instance listens on. Typically 1433.
​
string
required
Database Name — the database to connect to.
​
string
default:"dbo"
Schema Name — schema that extracts resolve table names within.
​
string
required
User — username with read permission on the tables you intend to extract.
​
string
required
Password — password for the specified user. Stored encrypted.

​
Extract Parameters

Set per extract, in source_parameters. See Shared Extract Parameters for mode, replication_key, and schema_mapping.
​
string
required
Table Name — the table or view to extract, resolved within the source’s schema_name.
​
string
default:"*"
Columns to read, as a comma-separated list.
​
string
Row filter pushed down to SQL Server, written without the WHERE keyword — for example modified_at >= '2024-01-01'.
batch_size is fixed at 100,000 rows for SQL Server extracts and cannot be overridden in source_parameters.

​
Required Permissions

The SQL Server user account needs the following permissions:
  • SELECT - For reading data from tables and views
  • VIEW DEFINITION - For accessing object metadata
  • VIEW DATABASE STATE - For viewing database state information
  • CONNECT - For connecting to the database

​
Limitations

Be aware of the following limitations when working with SQL Server sources:
  • Some SQL Server-specific data types may be converted to standard formats
  • CLR data types are not supported
  • Individual query size and timeout limits apply
  • Connection pooling settings may affect performance

​
Next Steps

After configuring your SQL Server source:
  1. Create extracts to specify which tables to ingest
  2. Configure scheduling for recurring extracts
  3. Integrate the source into your data pipelines
For more information about working with extracts and pipelines, refer to their respective documentation sections.