DBTimes

Home

Products

Frameworks

Contact us

Source Comparer Configuration v1

Type: object

Defines required fields for the application that uses DW Source Comparer library. The application configuration can have other root level fields.

Type: object

Configuration for source compare

Type: const

Version of a Source Comparer json configuration

Specific value: "1"

Type: array of object

Specifications for comparing sources

No Additional Items

Each item of this array must be:

Type: object

Type: string

A name of the compare scenario to differentiate multiple scenarios. Names must be unique.

Type: boolean

If the value of isActive is false, the compare scenario will not be processed.

Type: boolean

If the value is true, there will be some dataframe related output sent to the standard output from the library causing slowdown in job execution.

Type: number

When comparing two floating point values, they will be considered equal if the absolute value of a difference is less than floatThreshold.

Type: string

When comparing two timestamp fields they will be truncated using defined unit prior to being compared.

Must match regular expression: ^(?i)(year|yyyy|yy|month|mon|mm|day|dd|microsecond|millisecond|second|minute|hour|week|quarter)$

Type: string

When comparing two date fields they will be truncated using defined unit prior to being compared.

Must match regular expression: ^(?i)(year|yyyy|yy|month|mon|mm|week|quarter)$

Type: number

When defined, the number of reported differences for each column will not exceed the specified value. That will reduce the size of resulting differences file.

Type: object

Specification for the result of the comparison

Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

Type: array of object

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

Type: boolean

At least one column must have this property set to true.
Multiple columns can be designated as unique key to create a compound unique key.
By default the unique key is included unless isInclude value is set to false

Type: boolean

By default all columns are compared and included in comparison result, unless at least one column has explicit isInclude flag set (to true or false).
If that's the case only columns with isInclude flag set to true will be compared and included into comparison result.
If columns are listed that do not have isInclude flag, they will be ignored, unless they are keys.
For keys (isUniqueKey is set to true) the default for isInclude is true

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

At least one of the items must be:

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

Type: object

First or left source to compare. Both left and right sections are identical in terms of structure, but they can have different types of sources. For example, one can be DBMS and another a file. The sets being compared must have common columns matched compareResult.schema.

Type: object


Type: object

Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

Type: object


Type: object

Type: object

Options for SQL Server jdbc connection.

Must not be:

Type: object

"partitionColumn" is excluded from the list of options for jdbc source since this column has to be defined in "schema" with "isPartitionColumn" flag

The following properties are required:

  • partitionColumn

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

Type: object

Type: object

Properties for mongoDb can be any of the options supported by MongoDb Spark connector in batch mode. Schema must be defined

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^partitioner\.options\.
Type: string

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

Type: string

A meaningful name of the source to show in compare results. If none defined – the default is “left” or “right”

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

Type: object

If "isPartitionColumn" attribute of a column is set to true, colType must be defined (needed to determine the type of upper and lower bounds.

The following properties are required:

  • colType

Type: boolean

For DBMS source one column can be defined as partition column to read data on multiple connections in parallel. isPartitionColumn must be defined if numPartitions is defined.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.


Query to create a subset of columns and/or rows to compare. It can be any valid select statement using Spark SQL syntax to be executed on a data loaded from the Source. Source table must be desinated by three underscores, e.g., SELECT CAST(id AS INT) AS id FROM ___ .If not defined all fields and all rows from the source will be used

Type: string
Must match regular expression: ^.*___.*$
Type: array of string
No Additional Items

Each item of this array must be:

At least one of the items must be:

Type: object
Must match regular expression: ^.*___.*$

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

Type: object

Second or right source to compare. Both left and right sections are identical in terms of structure, but they can have different types of sources. For example, one can be DBMS and another a file. The sets being compared must have common columns matched compareResult.schema.

Same definition as leftSource

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^__
Type: string, number, integer, boolean, object, array or null

Comment field begins with two underscores. There can be any number of comment fields.