Snowflake

Required

Fields required for a valid configuration.

Path	Type	Required	Description	Default	Constraints
required	object	Yes	—	—	—

Masked

Sensitive fields under(secrets/credentials).

Path	Type	Required	Description	Default	Constraints
masked	object	Yes	—	—	—

Optional

Optional configuration fields.

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

Extracted Metadata

Table

Field	Type	Required	Description
database	string	Yes	Database or catalog name
table_name	string	Yes	Table name
table_type	string	Yes	Object type (TABLE/VIEW)
schema	string	No	Schema name
columns	object[]	No	Columns as {name, type} objects
row_count	integer	No	Estimated number of rows
account_id	string	No	Snowflake account identifier
object_type	string	No	Source object type
lineage	object	No	Lineage extraction settings and time window

Examples

Password auth discovery scan

Discover all tables and views across the Snowflake account with lineage extraction

Config Payload

{
  "type": "SNOWFLAKE",
  "required": {
    "authentication_type": "DEFAULT_AUTHENTICATOR",
    "account_id": "your-account-id"
  },
  "masked": {
    "username": "your-username",
    "password": "your-password"
  },
  "optional": {
    "connection": {
      "warehouse": "your-warehouse"
    },
    "scope": {
      "include_tables": true,
      "include_views": true
    },
    "extraction": {
      "include_table_lineage": true,
      "include_view_lineage": true
    }
  },
  "sampling": {
    "strategy": "AUTOMATIC",
    "rows_per_page": 50
  }
}

Schedule

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

Key pair auth with scoped database

Scan a specific Snowflake database using key pair authentication — common for automated pipelines

Config Payload

{
  "type": "SNOWFLAKE",
  "required": {
    "authentication_type": "KEY_PAIR_AUTHENTICATOR",
    "account_id": "your-account-id"
  },
  "masked": {
    "username": "your-username",
    "private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
  },
  "optional": {
    "connection": {
      "warehouse": "your-warehouse",
      "role": "your-role"
    },
    "scope": {
      "database": "YOUR_DATABASE",
      "include_tables": true,
      "include_views": true
    },
    "extraction": {
      "include_table_lineage": true,
      "include_view_lineage": true
    }
  },
  "sampling": {
    "strategy": "AUTOMATIC",
    "fallback_to_random": true,
    "rows_per_page": 50
  }
}

Schedule

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