Online Documentation for Data Generator for InterBase/Firebird

Configuration file format


The configuration (template) file used by Data Generator 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

 

 

[#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 Generator for Interbase/Firebird

Line1=Template file

Line2=Data generation #1

 

 

[CONNECTION]

This section stores connection parameters to Interbase/Firebird. 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 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 database file

Login

Interbase/Firebird login

Password

password to identify the login (encrypted)

Charset

client character set specified for the connection

Major

major version used to encrypt the passwords (the value must not be changed)

Minor

minor version used to encrypt the passwords (the value must not be changed)

SSLCert

path to SSL certificate file

SSLKey

path to SSL private key file

SSLCA

name of the Certificate Authority file

SSLCAPath

path to the Certificate Authority file

SSLPassphrase

SSL passphrase

 

 

[TUNNELING]

The section contains parameters required for connection with SSH tunneling used; the values correspond to the settings for connection via SSH Tunnel (if used).

 

Parameter

Description

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

PassPhrase

passphrase for Private key (if SSHUseKeyFile = True)

 

 

[ADDITIONAL]

The section contains additional settings specified at Step 2 and Step 4 of the Wizard application.

 

Parameter

Description

TablesCount

number of tables selected for data generation

SqlExecute

corresponds to the Execute statements option of the Action radio group available at Step 4:

1 = enabled

0 = disabled

SqlSave

corresponds to the Save data generation script to file option of the Action radio group available at Step 4:

1 = enabled

0 = disabled

SaveFile

path to the script file (if SqlSave = 1)

BlobFile

path to the file where the array fields will be stored (if ExportBlobType = 2)

ExportBlobType

corresponds to the Array/BLOB options radio group available at Step 4:

0 = array/BLOB fields are not processed

1 = array/BLOB fields are extracted as strings

2 = array/BLOB fields are extracted to file (BlobFile)

 

 

 

[TABLE_XX]

The section is repeated for all tables; the settings are specified at Step 3 of the Wizard application.

 

Parameter

Description

Database

indicates the name of the database where the table is located

TableName

indicates the name of the table to generate data into

RecordCount

number of records to be generated

ClearBeforeGeneration

1 leads to emptying table

0 leaves the table as it was before data generation

 

[TABLE_XX_FIELD_YY]

The section is created for each field of each table.

 

Parameter

Description

DoGenerate

0 indicates that the field is excluded

1 indicates that the field is included

IncludeNulls

1 specifies that the NULL values are set for certain percent of cases

0 disables this option

NumNulls

the percentage of field values to be set to NULL

GenMethod

defines Data generation mode:

0 stands for incremental data generation

1 = random data generation

2 refers to Get data from list / SQL query option

3 = from another field

GenFromSQL

0 = the direct list of values is taken for data generation

1 = SQL query is used

SQL

text of the SQL query from which a list of values is taken for generation (as the result of the SQL query execution)

UsingMask

0 = no mask is used for string field values

1 = generation of string field values by mask

Mask

mask for string field values generation

MinInt

minimal value for integer fields

MaxInt

maximal value for integer fields

UseFormula

0 = no formula

1 = a formula is applied for data generation

Formula

formula for data generation, e.g. x*2+1

Digits

digits quantity for float fields

Precision

precision value for float fields

MinDate

minimum value for date fields

MaxDate

maximum value for date fields

IncludeTime

indicates whether time is added (for DATETIME fields)

MinTime

minimum value for time fields

MaxTime

maximum value for time fields

MinLength

minimum length for string fields

MaxLength

maximum length for string fields

StartChar

first char code for generating strings

EndChar

last char code for generating strings

Charset

field character set

InitialValue

the initial value for data generation into the field

IncrementStep

specifies the step to increment values (for GenMethod = 0)

UseNewLine

1 = a line feed is used for a new line

0 = no line feeds used

WinNewLineStyle

style to be applied to line feeds:

1 = Windows style

0 = Unix style

SampleText

sample text to be generated for a string field