Mssql

Schema-driven source documentation.

MSSQL57 fields2 examples

Commonly Asked Questions

Assistant knowledge mapped to this source type from assistant_knowledge.json.

Required

Fields required for a valid configuration payload under `config.required`.

Path	Type	Required	Description	Default	Constraints
required	object	Yes	—	—	no extra properties
required.host	string	Yes	SQL Server host endpoint	localhost	—
required.port	integer	Yes	SQL Server TCP port	1433	min 1, max 65535

Masked

Sensitive fields under `config.masked` (secrets/credentials).

Path	Type	Required	Description	Default	Constraints
masked	object	Yes	—	—	no extra properties
masked.password	string	Yes	SQL Server login password	—	—
masked.username	string	Yes	SQL Server login username	—	—

Optional

Optional configuration fields under `config.optional`.

Path	Type	Required	Description	Default	Constraints
optional	object	No	—	—	no extra properties
optional.connection	object	No	Connection tuning for SQL Server.	—	no extra properties
optional.connection.auth_mode	enum	No	Authentication mode. CUSTOM uses masked.username as-is, LDAP prefixes username with ldap_domain when provided. Allowed values: CUSTOM, LDAP	CUSTOM	—
optional.connection.connect_timeout_seconds	integer	No	Connection timeout in seconds	10	min 1, max 120
optional.connection.is_aws_rds	boolean	No	Set true for AWS RDS SQL Server, false for on-prem. If unset, runtime auto-detects using host patterns.	—	—
optional.connection.ldap_domain	string	No	Optional LDAP/AD domain for LDAP auth mode (for example, CORP or corp.local).	—	—
optional.extraction	object	No	Lineage and advanced metadata extraction controls for SQL Server.	—	no extra properties
optional.extraction.include_jobs	boolean	No	Include SQL Server Agent jobs metadata extraction.	true	—
optional.extraction.include_query_lineage	boolean	No	Enable query-based lineage extraction from Query Store/DMVs.	false	—
optional.extraction.include_stored_procedures	boolean	No	Include stored procedure metadata extraction.	true	—
optional.extraction.include_stored_procedures_code	boolean	No	Include stored procedure source code metadata when available.	true	—
optional.extraction.include_table_lineage	boolean	No	Include table-level lineage links using foreign key metadata.	true	—
optional.extraction.include_usage_statistics	boolean	No	Enable usage statistics extraction from SQL query metadata.	false	—
optional.extraction.include_view_column_lineage	boolean	No	Enable view column lineage extraction when available.	true	—
optional.extraction.include_view_lineage	boolean	No	Include view-to-table/view lineage links using SQL Server dependency metadata.	true	—
optional.extraction.max_queries_to_extract	integer	No	Maximum number of queries to analyze for query-based lineage.	1000	min 1, max 10000
optional.extraction.min_query_calls	integer	No	Minimum execution count for queries to be included in query-based lineage.	1	min 1
optional.extraction.query_exclude_patterns	array	No	SQL LIKE patterns used to exclude queries from query-based lineage.	—	max items 100
optional.extraction.query_exclude_patterns[]	string	No	—	—	—
optional.scope	object	No	Database, schema, and object selection scope.	—	no extra properties
optional.scope.database	string	No	Single database to scan (optional when include_all_databases is true)	—	—
optional.scope.exclude_databases	array	No	Database denylist (exact database names)	["master","tempdb","model"]	—
optional.scope.exclude_databases[]	string	No	—	—	—
optional.scope.exclude_schemas	array	No	Schema denylist (exact schema names)	["INFORMATION_SCHEMA","sys"]	—
optional.scope.exclude_schemas[]	string	No	—	—	—
optional.scope.include_all_databases	boolean	No	Scan all visible databases except excluded system databases	false	—
optional.scope.include_objects	array	No	Optional object allowlist. Accepted forms: schema.object or database.schema.object	—	—
optional.scope.include_objects[]	string	No	—	—	—
optional.scope.include_schemas	array	No	Optional schema allowlist (exact schema names)	—	—
optional.scope.include_schemas[]	string	No	—	—	—
optional.scope.include_tables	boolean	No	Include table assets in extraction	true	—
optional.scope.include_views	boolean	No	Include view assets in extraction	true	—
optional.scope.table_limit	integer	No	Optional cap on number of table/view assets extracted	—	min 1

Examples

Reference payloads generated from shared source examples JSON.

Scan one MSSQL database with random sampling

Extract tables and views from one SQL Server database with detector-friendly row sampling

Schedule

{
  "enabled": true,
  "preset": "weekday_business",
  "cron": "19 10 * * 1-5",
  "timezone": "UTC"
}

Config Payload

{
  "type": "MSSQL",
  "required": {
    "host": "my-msql.database.com",
    "port": 1433
  },
  "masked": {
    "username": "test",
    "password": "password"
  },
  "optional": {
    "connection": {
      "auth_mode": "CUSTOM",
      "is_aws_rds": false
    },
    "scope": {
      "database": "msdb",
      "include_tables": true,
      "include_views": true
    },
    "extraction": {
      "include_table_lineage": true,
      "include_view_lineage": true,
      "include_view_column_lineage": true,
      "include_stored_procedures": true,
      "include_stored_procedures_code": true,
      "include_jobs": true
    }
  },
  "sampling": {
    "strategy": "RANDOM",
    "limit": 25,
    "max_columns": 20,
    "max_cell_chars": 512
  }
}

Scan all MSSQL databases with latest-row sampling

Enumerate visible SQL Server databases and prioritize latest records where possible

Schedule

{
  "enabled": true,
  "preset": "nightly",
  "cron": "15 1 * * *",
  "timezone": "UTC"
}

Config Payload

{
  "type": "MSSQL",
  "required": {
    "host": "my-msql.database.com",
    "port": 1433
  },
  "masked": {
    "username": "db_reader",
    "password": "password"
  },
  "optional": {
    "connection": {
      "auth_mode": "LDAP",
      "ldap_domain": "TestCompany",
      "is_aws_rds": true
    },
    "scope": {
      "include_all_databases": true,
      "exclude_databases": [
        "master",
        "tempdb"
      ],
      "include_tables": true,
      "include_views": true
    },
    "extraction": {
      "include_table_lineage": true,
      "include_view_lineage": true,
      "include_view_column_lineage": true,
      "include_query_lineage": true,
      "max_queries_to_extract": 1000,
      "min_query_calls": 5,
      "query_exclude_patterns": [
        "%sys.%",
        "%tempdb.%",
        "%INFORMATION_SCHEMA%"
      ]
    }
  },
  "sampling": {
    "strategy": "LATEST",
    "limit": 30,
    "order_by_column": "updated_at",
    "fallback_to_random": true
  }
}

Source name

Required

Authentication

Optional

Sampling