SYNQ Recon Configuration

Type: object

Configuration file format for synq-recon database reconciliation tool

root description
Type: string

Human-readable description of the configuration suite

root connections
Type: object

Database connection definitions

Each additional property must conform to the following schema

root connections connection
Type: object

A database connection. Exactly one database type key must be present.

root connections additionalProperties name
Type: string

Optional display name

root connections additionalProperties parallelism
Type: integer Default: 8

Max parallel queries

Value must be greater or equal to 1

root connections additionalProperties disabled
Type: boolean Default: false

root connections additionalProperties postgres
Type: object

root connections additionalProperties postgres port
Type: integer Default: 5432

root connections additionalProperties postgres allow_insecure
Type: boolean Default: false

root connections additionalProperties snowflake
Type: object

root connections additionalProperties snowflake databases
Type: array of string
No Additional Items

Each item of this array must be:

root connections additionalProperties snowflake databases databases items
Type: string

root connections additionalProperties bigquery
Type: object

root connections additionalProperties bigquery credentials
Type: string

JSON credentials content

root connections additionalProperties bigquery credentials_file
Type: string

Path to credentials file

root connections additionalProperties mysql
Type: object

root connections additionalProperties mysql port
Type: integer Default: 3306

root connections additionalProperties clickhouse
Type: object

root connections additionalProperties clickhouse port
Type: integer Default: 9000

root connections additionalProperties clickhouse secure
Type: boolean Default: false

root connections additionalProperties duckdb
Type: object

root connections additionalProperties duckdb database
Type: string

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

root connections additionalProperties duckdb motherduck_token
Type: string

MotherDuck authentication token (required for cloud MotherDuck)

root connections additionalProperties redshift
Type: object

root connections additionalProperties redshift port
Type: integer Default: 5439

root connections additionalProperties trino
Type: object

root connections additionalProperties trino port
Type: integer Default: 8080

root reconciliations
Type: object

Reconciliation scenario definitions

Each additional property must conform to the following schema

root reconciliations reconciliation
Type: object

root reconciliations additionalProperties source
Type: object

root reconciliations additionalProperties source connection
Type: string

Connection name (must exist in connections map)

root reconciliations additionalProperties source query
Type: string

Base SQL query for this dataset

root reconciliations additionalProperties key_column
Type: string

Column used for bisection split points and aggregate grouping

root reconciliations additionalProperties mode
Type: enum (of string) Default: "full"

Reconciliation mode

Must be one of:

  • "row_count"
  • "full"
  • "aggregate"

root reconciliations additionalProperties hash_algorithm
Type: enum (of string) Default: "auto"

Hash algorithm for row checksums

Must be one of:

  • "auto"
  • "md5"
  • "farm_fingerprint"
  • "xxhash64"

root reconciliations additionalProperties column_mapping

Column name mapping between source and target datasets

root reconciliations additionalProperties column_mapping oneOf item 0
Type: object

Map source column names to target column names (object format)

Each additional property must conform to the following schema

root reconciliations additionalProperties column_mapping oneOf item 0 additionalProperties
Type: string
root reconciliations additionalProperties column_mapping oneOf item 1
Type: array

Map source column names to target column names (array format)

 No Additional Items

Each item of this array must be:

root reconciliations additionalProperties column_mapping oneOf item 1 column_mapping_entry
Type: object

root reconciliations additionalProperties case_insensitive
Type: boolean Default: true

Automatically match columns case-insensitively (e.g., userid matches USERID)

root reconciliations additionalProperties bisection
Type: object

root reconciliations additionalProperties bisection enabled
Type: boolean Default: true

root reconciliations additionalProperties bisection factor
Type: integer Default: 32

Number of segments to split into per bisection level

Value must be greater or equal to 2

root reconciliations additionalProperties bisection threshold
Type: integer Default: 16384

Stop drilling when segment row count falls below this

Value must be greater or equal to 1

root reconciliations additionalProperties reporting
Type: object

root reconciliations additionalProperties reporting level
Type: enum (of string) Default: "count_only"

Must be one of:

  • "count_only"
  • "with_keys"
  • "detailed"

root reconciliations additionalProperties reporting sample_limit
Type: integer

Maximum number of sample rows to report

Value must be greater or equal to 0

root reconciliations additionalProperties aggregate
Type: object

root reconciliations additionalProperties aggregate measures
Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root reconciliations additionalProperties aggregate measures measure_config
Type: object

root reconciliations additionalProperties aggregate measures measures items function
Type: enum (of string)

Must be one of:

  • "SUM"
  • "COUNT"
  • "AVG"
  • "MIN"
  • "MAX"

root reconciliations additionalProperties aggregate thresholds
Type: object

root reconciliations additionalProperties aggregate thresholds absolute
Type: number

Maximum absolute difference per measure

Value must be greater or equal to 0

root reconciliations additionalProperties aggregate thresholds percentage
Type: number

Maximum percentage difference (0.1 = 10%)

Value must be greater or equal to 0