Online Documentation for Data Comparer for InterBase/Firebird

Configuration file format


The configuration (template) file used by Data Comparer for Interbase/Firebird is divided into several sections, each corresponding to a particular group of settings specified at different steps of the GUI application wizard.

 

[#General#]

This section stores general information about the utility:

 

Parameter

Description

Product

internal product name

Version

major version

 

[#SourceDB#]

This section stores connection parameters for the source database. The parameters correspond to the values entered at Step 1 of the Wizard application and are obligatory.

 

Parameter

Description

ClientLibrary

path to the Interbase/Firebird client library

Role

Interbase/Firebird role

Host

host where the source database resides (if Remote = 1)

Port

the port on which Interbase/Firebird is listening

Remote

0 = local connection

1 = remote connection

DBFile

path to the source database file

Login

Interbase/Firebird login

Password

password to identify the login (encrypted)

Charset

client character set specified for the connection

TunnelType

indicates whether SSH tunneling is used for connection or not (TunnelType = ttNotUse)

SSHHostName

name of the host where SSH server is running

SSHPort

port on which SSH server is activated

SSHUserName

user on the machine where SSH server is running

SSHPassword

password to identify SSH server user (encrypted)

SSHKeyFile

path to the Private Key used for the SSH connection (if SSHUseKeyFile = True)

SSHUseKeyFile

True = SSH Private Key is used

False = SSH Private Key is not used

 

 

 

[#TargetDB#]

This section stores connection parameters for the target database. The parameters correspond to the values entered at Step 1 of the Wizard application and are obligatory. The set of parameters is the same as for the source database ([#SourceDB#]).

 

 

[#Options#]

This section stores comparison options. The parameters correspond to the values specified at Step 2 and Step 3 of the Wizard application.

 

Parameter

Description

Blobs

0 = BLOB fields are not specified for comparison

1 = BLOB fields are specified for comparison

IgnoreCase

0 = case is considered when comparing strings

1 = case is ignored when comparing strings

FillIdentical

0 = identical records are not displayed at Step 3 of the wizard

1 = identical records are displayed at Step 3 of the wizard

ViewRecordsCount

number of records displayed on one page at Step 3 of the wizard

ThreadCount

number of comparison threads

SavePassword

0 = Password is not saved in template file

1 = Password is saved in template file

PasswordEncripted

0 = Password is not encrypted in template file

1 = Password is encrypted in template file

TrimCharFields

0 = CHAR fields are trimmed on synchronization

1 = CHAR fields are not trimmed on synchronization

CompareOnServerSide

0 = comparison is performed on the client

1 = comparison is performed on the server

 

 

[#SyncOptions#]

This section stores synchronization options. The parameters correspond to the values specified at Step 4 and Step 7 of the Wizard application.

Parameter

Description

TargetToSource

0 = synchronization from source to target

1 = synchronization from target to source

TablePostfix

postfix added to the synchronization table name (if SyncInNewTable = 1), by default _sync

SaveScript

0 = synchronization script is saved to an external file upon saving template

1 = synchronization script is not saved

DisableTriggers

0 = table triggers are not considered

1 = table triggers are disabled during synchronization (if SyncInNewTable = 0)

ScriptFileName

path to the file into which the synchronization script is saved (if SaveScript = 0)

InsertMissRecs

0 = missing records are ignored during synchronization

1 = missing records are inserted during synchronization

DeleteAddRecs

0 = additional records are ignored during synchronization

1 = additional records are deleted during synchronization

UpdateDiffRecs

0 = different records are ignored during synchronization

1 = different records are updated during synchronization

SyncInNewTable

0 = synchronization is performed in the source (if TargetToSource = 1) or in the target (if TargetToSource = 0) table

1 = a new table is created and the synchronized data are inserted into the table

CreateComputed

0 = computed and read-only fields are excluded from the synchronization process

1 = computed and read-only fields are included into the synchronization process

LoadToScriptEditor

0 = synchronization script is not loaded to Script Editor

1 = synchronization script is loaded to Script Editor and displayed at Step 5 of the wizard

AbortExecuteOnError

0 = synchronization process is not stopped if an error occurs

1 = synchronization process is stopped upon any execution error

DetailErrors

0 = detailed error log is not displayed

1 = detailed error log is displayed on the screen at Step 7 of the wizard

ExecuteScript

0 = synchronization script is not executed automatically

1 = synchronization script is executed automatically by the console version after template creation

DropIndexes

0 = table indexes are not considered

1 = table indexes are dropped and then recreated in the synchronization script

CommitAlter

number of committed records in the synchronization script

Autofill

0 = tables correspondence set at Step 2, will not be set automatically

1 = tables correspondence will be set automatically

 

 

 

[#Comment#]

This section stores the template file comment as specified optionally in the Save template options dialog:

 

Parameter

Description

Line<N>

comment text

where N stands for the comment line identifier

 

Example:

Line0=Data Comparer for Interbase/Firebird

Line1=Template file

Line2=Data synchronization #1

 

 

[#SrcAfterScript#]

This section stores the text of the script executed for the source database after data synchronization, as specified at Step 6 of the Wizard application.

 

Parameter

Description

Item_Count

number of lines

Line<N>

script text

where N stands for the script line identifier

 

Example:

Item_Count=2

Line0=/*AFTER synchronization*/

Line1=/*script to be executed for the source database*/

 

 

[#TrgAfterScript#]

This section stores the text of the script executed for the target database after data synchronization, as specified at Step 6 of the Wizard application.

 

Parameter

Description

Item_Count

number of lines

Line<N>

script text

where N stands for the script line identifier

 

Example:

Item_Count=2

Line0=/*AFTER synchronization*/

Line1=/*script to be executed for the target database*/

 

 

[#SrcBeforeScript#]

This section stores the text of the script executed for the source database before data synchronization, as specified at Step 6 of the Wizard application.

 

Parameter

Description

Item_Count

number of lines

Line<N>

script text

where N stands for the script line identifier

 

Example:

Item_Count=2

Line0=/*BEFORE synchronization*/

Line1=/*script to be executed for the source database*/

 

 

[#TrgBeforeScript#]

This section stores the text of the script executed for the target database before data synchronization, as specified at Step 6 of the Wizard application.

 

Parameter

Description

Item_Count

number of lines

Line<N>

script text

where N stands for the script line identifier

 

Example:

Item_Count=2

Line0=/*BEFORE synchronization*/

Line1=/*script to be executed for the target database*/

 

[SrcSchemas]

This section is not used by Data Comparer for Interbase/Firebird.

 

 

[TrgSchemas]

This section is not used by Data Comparer for Interbase/Firebird.

 

 

[Table<N>]

Sections of this type contain table/field correspondences (N stands for the correspondence identifier), as specified at Step 2 of the Wizard application.

Parameter

Description

#SourceTable#

source table name

#TargetTable#

target table name

Synchronize

0 = tables will not be synchronized

1 = tables #SourceTable# and #TargetTable# are specified for synchronization

<field_name>

corresponding target table field

<field_name>_CompareKey

0 = the field is not used as key column for data comparison

1 = the field is used as key column for data comparison

 

Example:

[Table0]

#SourceTable#=EMPLOYEE

#TargetTable#=EMPLOYEE_UPD

Synchronize=1

EMP_ID=EMP_NO

EMP_ID_CompareKey=1

FIRST_NAME=FIRST_NAME

FIRST_NAME_CompareKey=0

LAST_NAME=LAST_NAME

LAST_NAME_CompareKey=0