Snowflake
Schema-driven source documentation.
SNOWFLAKE45 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 | — | — | — |
Masked
Sensitive fields under `config.masked` (secrets/credentials).
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| masked | object | Yes | — | — | — |
Optional
Optional configuration fields under `config.optional`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| optional | object | No | — | — | no extra properties |
| optional.connection | object | No | Snowflake connection and session tuning options. | — | no extra properties |
| optional.connection.connect_args | object | No | Additional snowflake.connector.connect keyword arguments (advanced usage). | {} | — |
| optional.connection.connect_timeout_seconds | integer | No | Connection timeout in seconds | 15 | min 1, max 300 |
| optional.connection.role | string | No | Snowflake role to use for metadata and sampling queries | — | — |
| optional.connection.snowflake_domain | string | No | Snowflake domain suffix (use snowflakecomputing.cn for China regions). | snowflakecomputing.com | — |
| optional.connection.warehouse | string | No | Snowflake warehouse to use for metadata and sampling queries | — | — |
| optional.extraction | object | No | Lineage extraction controls for Snowflake metadata ingestion. | — | no extra properties |
| optional.extraction.include_table_lineage | boolean | No | Include table-level lineage links when dependency metadata is accessible. | true | — |
| optional.extraction.include_view_lineage | boolean | No | Include view-to-table/view lineage links when dependency metadata is accessible. | true | — |
| optional.extraction.start_time | string | No | Optional lineage lower bound timestamp (ISO 8601). | — | format date-time |
| 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) | ["SNOWFLAKE","SNOWFLAKE_SAMPLE_DATA"] | — |
| optional.scope.exclude_databases[] | string | No | — | — | — |
| optional.scope.exclude_schemas | array | No | Schema denylist (exact schema names) | ["INFORMATION_SCHEMA"] | — |
| 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.
Snowflake key pair authentication with lineage
Extract Snowflake tables/views using key pair auth with table and view lineage enabled
Schedule
{
"enabled": true,
"preset": "nightly",
"cron": "31 1 * * *",
"timezone": "UTC"
}Config Payload
{
"type": "SNOWFLAKE",
"required": {
"authentication_type": "KEY_PAIR_AUTHENTICATOR",
"account_id": "LMAUONV-ONE_DATA_DEV"
},
"masked": {
"username": "some_user",
"private_key": "-----BEGIN PRIVATE KEY-----\\nMIIE...\\n-----END PRIVATE KEY-----"
},
"optional": {
"connection": {
"role": "some_role",
"warehouse": "compute_wh"
},
"scope": {
"database": "ANALYTICS",
"include_tables": true,
"include_views": true
},
"extraction": {
"start_time": "2025-01-01T00:00:00.000Z",
"include_table_lineage": true,
"include_view_lineage": true
}
},
"sampling": {
"strategy": "RANDOM",
"limit": 20,
"max_columns": 20,
"max_cell_chars": 512
}
}Snowflake password auth with latest sampling
Extract scoped Snowflake objects with default username/password authentication
Schedule
{
"enabled": true,
"preset": "weekday_business",
"cron": "3 12 * * 1-5",
"timezone": "UTC"
}Config Payload
{
"type": "SNOWFLAKE",
"required": {
"authentication_type": "DEFAULT_AUTHENTICATOR",
"account_id": "xy12345.us-east-2.aws"
},
"masked": {
"username": "snowflake_reader",
"password": "example-password"
},
"optional": {
"connection": {
"warehouse": "compute_wh"
},
"scope": {
"database": "ANALYTICS",
"include_schemas": [
"PUBLIC"
],
"include_tables": true,
"include_views": false
},
"extraction": {
"include_table_lineage": true,
"include_view_lineage": false
}
},
"sampling": {
"strategy": "LATEST",
"limit": 30,
"order_by_column": "UPDATED_AT",
"fallback_to_random": true
}
}