SYNQ DWH Agent Configuration

Type: object

Configuration file format for the synq-dwh agent

 No Additional Properties

root agent
Type: object

YAMLAgentConfig contains agent metadata and logging settings.

 No Additional Properties

root agent name
Type: string

Name of the agent instance. Defaults to the hostname if not set.

root agent log_level
Type: enum (of string)

Log verbosity level. Accepts "trace", "debug", "info", "warn", "error".

Must be one of:

  • "trace"
  • "debug"
  • "info"
  • "warn"
  • "error"
  • "LOG_LEVEL_TRACE"
  • "LOG_LEVEL_DEBUG"
  • "LOG_LEVEL_INFO"
  • "LOG_LEVEL_WARN"
  • "LOG_LEVEL_ERROR"

root agent log_json
Type: boolean

Output logs in JSON format.

root agent log_report_caller
Type: boolean

Include caller information in log entries.

root synq
Type: object

SYNQConfig holds SYNQ platform connection settings.

 No Additional Properties

root synq client_id
Type: string

OAuth client ID for authenticating with the SYNQ platform.

root synq client_secret
Type: string

OAuth client secret for authenticating with the SYNQ platform.

root synq endpoint
Type: string

gRPC endpoint for the SYNQ API (e.g. "developer.synq.io:443").

root synq ingest_endpoint
Type: string

gRPC endpoint for the SYNQ ingest API. Defaults to Endpoint if empty.

root synq oauth_url
Type: string

OAuth token URL. Derived from Endpoint if empty.

root connections
Type: object

Each additional property must conform to the following schema

root connections Connection
Type: object

Connection is a single database connection entry in a connections map.

 No Additional Properties

root connections additionalProperties name
Type: string

Display name for this connection. Defaults to the connection ID (map key).

root connections additionalProperties disabled
Type: boolean

When true, the connection is skipped during execution.

root connections additionalProperties parallelism
Type: integer

Maximum number of parallel queries. Range: 1-256. Defaults to 8.

Value must be greater or equal to 1 and lesser or equal to 256

root connections additionalProperties postgres
Type: object

PostgresConf contains PostgreSQL connection parameters.

 No Additional Properties

root connections additionalProperties postgres port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties postgres allow_insecure
Type: boolean

Disable SSL certificate verification.

root connections additionalProperties snowflake
Type: object

SnowflakeConf contains Snowflake connection parameters.

 No Additional Properties

root connections additionalProperties snowflake account
Type: string

Snowflake account identifier.

root connections additionalProperties snowflake warehouse
Type: string

Virtual warehouse to use for queries.

root connections additionalProperties snowflake role
Type: string

Role to assume after connecting.

root connections additionalProperties snowflake private_key
Type: string

PEM-encoded private key content for key-pair authentication.

root connections additionalProperties snowflake private_key_file
Type: string

Path to a PEM-encoded private key file.

root connections additionalProperties snowflake private_key_passphrase
Type: string

Passphrase to decrypt the private key.

root connections additionalProperties snowflake databases
Type: array of string

Databases to include. If empty, all accessible databases are scraped.

 No Additional Items

Each item of this array must be:

root connections additionalProperties snowflake databases databases items
Type: string

root connections additionalProperties snowflake use_get_ddl
Type: boolean

Use GET_DDL() to retrieve DDL for tables and views.

root connections additionalProperties snowflake account_usage_db
Type: string

Database containing the ACCOUNT_USAGE schema. Defaults to SNOWFLAKE.

root connections additionalProperties snowflake auth_type
Type: string

Set to "externalbrowser" to use SSO browser-based authentication.

root connections additionalProperties bigquery
Type: object

BigQueryConf contains BigQuery connection parameters.

 No Additional Properties

root connections additionalProperties bigquery project_id
Type: string

GCP project ID.

root connections additionalProperties bigquery region
Type: string

Region for BigQuery resources.

root connections additionalProperties bigquery service_account_key
Type: string

Inline JSON content of the service account key.

root connections additionalProperties bigquery service_account_key_file
Type: string

Path to the service account key JSON file.

root connections additionalProperties redshift
Type: object

RedshiftConf contains Amazon Redshift connection parameters.

 No Additional Properties

root connections additionalProperties redshift port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties redshift freshness_from_query_logs
Type: boolean

Estimate table freshness from Redshift query logs instead of metadata.

root connections additionalProperties mysql
Type: object

MySQLConf contains MySQL connection parameters.

 No Additional Properties

root connections additionalProperties mysql port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties mysql allow_insecure
Type: boolean

Disable SSL certificate verification.

root connections additionalProperties mysql params
Type: object

Additional DSN parameters passed to the driver.

Each additional property must conform to the following schema

root connections additionalProperties mysql params additionalProperties
Type: string

root connections additionalProperties clickhouse
Type: object

ClickhouseConf contains ClickHouse connection parameters.

 No Additional Properties

root connections additionalProperties clickhouse port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties clickhouse database
Type: string

Database to connect to. If empty, all databases are scraped.

root connections additionalProperties clickhouse allow_insecure
Type: boolean

Disable SSL certificate verification.

root connections additionalProperties trino
Type: object

TrinoConf contains Trino / Starburst connection parameters.

 No Additional Properties

root connections additionalProperties trino port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties trino use_plaintext
Type: boolean

Use a plain HTTP connection instead of HTTPS.

root connections additionalProperties trino catalogs
Type: array of string

Catalogs to include. Required for most Trino deployments.

 No Additional Items

Each item of this array must be:

root connections additionalProperties trino catalogs catalogs items
Type: string

root connections additionalProperties databricks
Type: object

DatabricksConf contains Databricks connection parameters.

 No Additional Properties

root connections additionalProperties databricks workspace_url
Type: string

Databricks workspace URL.

root connections additionalProperties databricks auth_token
Type: string

Personal access token for authentication.

root connections additionalProperties databricks auth_client
Type: string

OAuth client ID (M2M authentication).

root connections additionalProperties databricks auth_secret
Type: string

OAuth client secret (M2M authentication).

root connections additionalProperties databricks warehouse
Type: string

SQL warehouse ID to use for queries.

root connections additionalProperties mssql
Type: object

MSSQLConf contains Microsoft SQL Server / Azure SQL Database connection parameters.

 No Additional Properties

root connections additionalProperties mssql port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties mssql trust_cert
Type: boolean

Trust the server certificate without validation.

root connections additionalProperties mssql encrypt
Type: string

Encryption mode (e.g. "true", "false", "strict").

root connections additionalProperties mssql fed_auth
Type: string

Federated authentication method (e.g. "ActiveDirectoryDefault").

root connections additionalProperties mssql access_token
Type: string

Pre-acquired access token for Azure AD authentication.

root connections additionalProperties mssql application_client_id
Type: string

Azure AD application client ID for service principal auth.

root connections additionalProperties oracle
Type: object

OracleConf contains Oracle Database connection parameters.

 No Additional Properties

root connections additionalProperties oracle port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root connections additionalProperties oracle service_name
Type: string

Oracle service name.

root connections additionalProperties oracle ssl
Type: boolean

Enable SSL/TLS for the connection.

root connections additionalProperties oracle ssl_verify
Type: boolean

Verify the server's SSL certificate.

root connections additionalProperties oracle wallet_path
Type: string

Path to Oracle Wallet directory for authentication.

root connections additionalProperties oracle use_diagnostics_pack
Type: boolean

Enable Oracle Diagnostics Pack features (AWR, ASH).

root connections additionalProperties duckdb
Type: object

DuckDBConf contains DuckDB / MotherDuck connection parameters.

 No Additional Properties

root connections additionalProperties duckdb database
Type: string

File path, ':memory:' for in-memory, or MotherDuck database name.

root connections additionalProperties duckdb motherduck_account
Type: string

MotherDuck organization/account name (for cloud mode).

root connections additionalProperties duckdb motherduck_token
Type: string

MotherDuck authentication token (required for cloud MotherDuck).