Extract Parameters

ARCHIVE_LOG_DIR

ARCHIVE_LOG_DIR specifies the directory where the archive logs are stored. It must be specified as an absolute path.

Parameter Format

Property
Description

Parameter type

path

Default Value

""

Class

Mandatory, Static

Range

ARCHIVE_LOG_FORMAT

ARCHIVE_LOG_FORMAT specifies the archived log file format. Supported formats are %r:RESETLOGS_CHANGE#, %s:SEQUENCE#, %S:8byte SEQUENCE# padded with 0, and %t:THREAD#.

Parameter Format

Property
Description

Parameter type

String

Default Value

"log-t%t-r%r-s%s.arc"

Class

Mandatory, Static

Range

BINLOG_INIT_POSITION

BINLOG_INIT_POSITION specifies the starting position of mysql binlog.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

120

Class

Optional, Static

Range

1 - INT32_MAX

CLIENT_DRIVER

CLIENT_DRIVER specifies a path to the client library used to access a database. An absolute path must be specified. For Tibero, set a path to the libtbclnt.so file. And for Oracle, enter a path to the libclntsh.so file.

Parameter Format

Property
Description

Parameter type

path

Default Value

""

Class

Optional, Static

Range

COL_SAM_TEMPLATE

The COL_SAM_TEMPLATE parameter sets the path to the user-defined template file to be used when outputting column content for DML statements. It works when SQL_REDO_MODE is set to N. When logging DML statements, if column definitions are present in the COL_SAM_TEMPLATE, ProSync logs the column information to the SAM file according to that template format.

Parameter Format

Property
Description

Parameter type

path

Default Value

"/"

Class

Optional, Static

Range

CONNECT_TO_APPLY_CHECK_INTERVAL

CONNECT_TO_APPLY_CHECK_INTERVAL specifies the interval at which the connection is attempted when the connection between ext and apply is lost.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

0

Class

Optional, Static

Range

0 - 3600

CONN_MAX

CONN_MAX specifies the max number of connections between processes.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

128

Class

Optional, Static

Range

32 - 1024

DICT_FILE_DIR

DICT_FILE_DIR specifies the directory where user wants to make dictfile while using oracle logminer version.

Parameter Format

Property
Description

Parameter type

path

Default Value

"/"

Class

Optional, Static

Range

DSN_DIR

DSN_DIR specifies the directory where the dsn file located. It must be specified as an absolute path.

Parameter Format

Property
Description

Parameter type

path

Default Value

""

Class

Optional, Static

Range

DSN_FILE

DSN_FILE specifies name of dsn file.

Parameter Format

Property
Description

Parameter type

String

Default Value

""

Class

Optional, Static

Range

DUMMY_LOG_SEND_INTERVAL_COMMIT_TSN

DUMMY_LOG_SEND_INTERVAL_COMMIT_TSN specifies the interval of sending dummy tx to prevent synchronization delay in TAC and RAC.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

1000

Class

Optional, Static

Range

10 - UINT64_MAX

DUMMY_TX_INTERVAL

DUMMY_TX_INTERVAL specifies instance status check interval (in seconds) in a cluster database environment. The extract process does not perform status checks at each interval. The check occurs at the set interval from the time when there are no more redo or archive logs to read (no new logs are generated).

Parameter Format

Property
Description

Parameter type

Integer

Default Value

5

Class

Optional, Static

Range

1 - 1000

ENABLE_NETWORK_COMPRESS

ENABLE_NETWORK_COMPRESS specifies whether to compress data when sending data from the extract process to the apply process. If set to 'Y', performance may be affected due to the compress/decompress process when sending/receiving data. This is useful when sending large amounts of data across a large network.

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

N

Class

Optional, Dynamic

Range

ENABLE_NETWORK_ENCRYPT

ENABLE_NETWORK_ENCRYPT specifies whether to encrypt data when sending data from the extract process to the apply process. If set to 'Y', data is sent using the SSL protocol.

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

N

Class

Optional, Static

Range

EXCLUDE_USER

EXCLUDE_USER specifies the name of a user to be excluded from extract operations. If bi-directional synchronization is used, enter a ProSync user name that uses reverse directional synchronization.

Parameter Format

Property
Description

Parameter type

String

Default Value

""

Class

Optional, Static

Range

EXTRACT_ARCHIVE_LOG_ONLY

EXTRACT_ARCHIVE_LOG_ONLY specifies to only extract archived log. If set to 'Y', redo log is archived and cannot be extracted until a new archived log is created.

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

N

Class

Optional, Static

Range

EXTRACT_NUM

EXTRACT_NUM specifies the instance number of the source database. It must be greater than or equal to 1. For a database cluster, each extract process must be assigned a different number in sequential order (1, 2, 3...).

Parameter Format

Property
Description

Parameter type

Integer

Default Value

1

Class

Mandatory, Static

Range

1 - 1024

EXT_TO_APPLY

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

Y

Class

Optional, Static

Range

EXT_TO_SAM

This parameter sets whether to log statements that are passed from the EXT process to the APPLY process into the SAM file. (Y/N)

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

N

Class

Optional, Dynamic

Range

INSTANCE_FAILURE_CHECK_INTERVAL

INSTANCE_FAILURE_CHECK_INTERVAL specifies instance status check interval (in seconds) in a cluster database environment. The extract process does not perform status checks at each interval. The check occurs at the set interval from the time when there are no more redo or archive logs to read (no new logs are generated).

Parameter Format

Property
Description

Parameter type

Integer

Default Value

5

Class

Optional, Static

Range

5 - 3600

LOG_BACKUP_DIR

LOG_BACKUP_DIR specifies the directory where the ProSync log files are backed up. It must be specified as an absolute path.

Parameter Format

Property
Description

Parameter type

path

Default Value

""

Class

Mandatory, Static

Range

LOG_BACKUP_SIZE

LOG_BACKUP_SIZE specifies the maximum size of all backup files in the process. If this limit is exceeded, the oldest log files in the directory are deleted.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

0

Class

Optional, Dynamic

Range

0 - 128G

LOG_DIR

LOG_DIR specifies the directory where the ProSync log files are stored. It must be specified as an absolute path.

Parameter Format

Property
Description

Parameter type

path

Default Value

""

Class

Mandatory, Static

Range

LOG_FILE_SIZE

LOG_FILE_SIZE specifies the maximum log file size. If a log file exceeds this limit, it is moved to the backup directory and a new log file is created.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

104857600

Class

Optional, Dynamic

Range

1M - 1G

LOG_LEVEL

LOG_LEVEL specifies the log level of the process. A higher log-level produces more detailed logs.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

3

Class

Mandatory, Dynamic

Range

1 - 5

LOG_SWITCH_INTERVAL

LOG_SWITCH_INTERVAL specifies interval of log switch.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

0

Class

Optional, Static

Range

0 - INT32_MAX

LR_TRACE_LVL

LR_TRACE_LVL specifies the logging level of the log reader. A higher log-level produces more detailed logs.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

2

Class

Optional, Dynamic

Range

1 - 5

MYSQLBINLOG_RETRY_CNT

Parameter Format

Property
Description

Parameter type

Integer

Default Value

3

Class

Optional, Static

Range

0 - 10000

MYSQLBINLOG_RETRY_INTERVAL

Parameter Format

Property
Description

Parameter type

Integer

Default Value

3

Class

Optional, Static

Range

1 - 120

MYSQL_BINLOG_PREFIX

MYSQL_BINLOG_PREFIX specifies the prefix of mysql binlog file name.

Parameter Format

Property
Description

Parameter type

String

Default Value

"bin"

Class

Optional, Static

Range

NETWORK_COMPRESS_LEVEL

Parameter Format

Property
Description

Parameter type

Integer

Default Value

1

Class

Optional, Static

Range

0 - 9

OCI_DRIVER

OCI_DRIVER specifies a path to the client library used to access a database. An absolute path must be specified. for Oracle, enter a path to the libclntsh.so file.

Parameter Format

Property
Description

Parameter type

path

Default Value

"/"

Class

Optional, Static

Range

ODBC_DRIVER

ODBC_DRIVER specifies a path to the client library used to access a database. An absolute path must be specified. Set a path to the proper library file.

Parameter Format

Property
Description

Parameter type

path

Default Value

"/"

Class

Optional, Static

Range

ORACLE10G_LOG_FILE_BLOCKSIZE

Parameter Format

Property
Description

Parameter type

Integer

Default Value

512

Class

Optional, Static

Range

512, 1024, 4096

PQ_DRIVER

PQ_DRIVER specifies a path to the pq library used to access a database. An absolute path must be specified. For Tibero, set a path to the libpq.so file.

Parameter Format

Property
Description

Parameter type

path

Default Value

""

Class

Optional, Static

Range

PQ_PUBLISH_NAME

PQ_PUBLISH_NAME specifies the publish name.

Parameter Format

Property
Description

Parameter type

String

Default Value

""

Class

Optional, Static

Range

PQ_REP_CONN_NAME

PQ_REP_CONN_NAME specifies the repliucation connection name.

Parameter Format

Property
Description

Parameter type

String

Default Value

""

Class

Optional, Static

Range

PQ_SLOT_NAME

PQ_SLOT_NAME specifies the replication slot name.

Parameter Format

Property
Description

Parameter type

String

Default Value

""

Class

Optional, Static

Range

PREFETCH_SIZE

PREFETCH_SIZE specifies the number of rows to fetch for each oci fetch call. This parameter is used only in oracle logminer version.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

1

Class

Optional, Static

Range

1 - UINT32_MAX

PRS_PROC_AGENT_CONNECTION_TIMEOUT

connection timeout from process to agent. if a process cannot connect to agent while this timeout, kill itself

Parameter Format

Property
Description

Parameter type

Integer

Default Value

180

Class

Optional, Static

Range

0 - 86400

PRS_PWD

PRS_PWD specifies the database user password. If the password is encrypted, append the string '#encrypted'.

Parameter Format

Property
Description

Parameter type

String

Default Value

"#encrypted"

Class

Mandatory, Static

Range

PRS_USER

PRS_USER specifies the database user.

Parameter Format

Property
Description

Parameter type

String

Default Value

""

Class

Mandatory, Static

Range

REPO_RESOURCE_INSERT_INTERVAL

This parameter decides how often to insert resource data into repoDB.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

60

Class

Optional, Static

Range

60 - 3600

RESUME_WAIT_TIME

Parameter Format

Property
Description

Parameter type

Integer

Default Value

3

Class

Optional, Static

Range

1 - 120

SAM_BACKUP_DIR

SAM_BACKUP_DIR specifies the directory where the SAM files of ext process are backed up. It must be specified as an absolute path.

Parameter Format

Property
Description

Parameter type

path

Default Value

"/"

Class

Optional, Static

Range

SAM_BACKUP_SIZE

SAM_BACKUP_SIZE specifies the maximum size of SAM backup files of ext process. If this limit is exceeded, the oldest SAM files in the directory are deleted.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

0

Class

Optional, Dynamic

Range

0 - 128G

SAM_BIND_VALUE

SAM_BIND_VALUE

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

Y

Class

Optional, Dynamic

Range

SAM_BIND_VALUE specifies whether to retain the values of the query in SAM files. If set to 'Y', the specific values of the query are retained. If set to 'N', every value in the query is replaced with '?'.

SAM_DIR

SAM_DIR specifies the directory where the sam files are stored. It must be specified as an absolute path.

Parameter Format

Property
Description

Parameter type

path

Default Value

"/"

Class

Optional, Static

Range

SAM_FILE_SIZE

SAM_FILE_SIZE specifies the maximum SAM file size of ext process. If a SAM file exceeds this limit, it is moved to the backup directory and a new SAM file is created.

Parameter Format

Property
Description

Parameter type

Integer

Default Value

17179869184

Class

Optional, Dynamic

Range

1M - 16G

SAM_LOG_PREFIX

SAM_LOG_PREFIX specifies whether to include timestamp and thread information for each query in the SAM files, similar to how prosync logging works. If set to 'Y', this information is prepended to each row in the SAM files. If set to 'N', the timestamp and thread information is not included on each row.

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

Y

Class

Optional, Dynamic

Range

SQL_REDO_MODE

The SQL_REDO_MODE parameter specifies whether to log the full DML/DDL statements into the SAM files. Y: The DML statements are logged row-by-row into the SAM files. (This is the default setting). N: The DML statements are not logged row-by-row into the SAM files.

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

Y

Class

Optional, Static

Range

SRC_DB_IP

SRC_DB_IP specifies the database IP Address.

Parameter Format

Property
Description

Parameter type

String

Default Value

"localhost"

Class

Optional, Static

Range

SRC_DB_NAME

SRC_DB_NAME specifies the name(Alias) of the source database. For TIBERO, UPDB, or K-DB, use the value specified in the dsn file. For ORACLE, use the value specified in the tnsname file.

Parameter Format

Property
Description

Parameter type

String

Default Value

""

Class

Mandatory, Static

Range

SRC_DB_PORT

SRC_DB_PORT specifies the database port.

Parameter Format

Property
Description

Parameter type

String

Default Value

"7600"

Class

Optional, Static

Range

SRC_DB_TYPE

SRC_DB_TYPE specifies the type of the source database to extract data from. Options are TIBERO, UPDB, KDB, or ORACLE.

Parameter Format

Property
Description

Parameter type

String

Default Value

"TIBERO"

Class

Mandatory, Static

Range

SRC_LOCAL_SID

SRC_LOCAL_SID indicates specified instance name of the source database in RAC or TAC.

Parameter Format

Property
Description

Parameter type

String

Default Value

""

Class

Optional, Static

Range

STMT_SAM_TEMPLATE

The STMT_SAM_TEMPLATE parameter sets the path to the user-defined template file to be used when logging statement (DML/DDL) content to the SAM file. It works when SQL_REDO_MODE is set to N. ProSync reads the template from the specified path and logs the DDL and DML content to the SAM file according to that template format.

Parameter Format

Property
Description

Parameter type

path

Default Value

"/"

Class

Optional, Static

Range

TDE_FOR_EXT

TDE_FOR_EXT specifiese whether use data decryption from source database

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

N

Class

Optional, Static

Range

TDE_FOR_TABLESPACE

TDE_FOR_TABLESPACE specifiese whether use tablespace decryption from source database

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

N

Class

Optional, Static

Range

TDE_WALLET_FILE

TDE_WALLET_FILE specifies the wallet file name of source db including absolute path

Parameter Format

Property
Description

Parameter type

String

Default Value

"/"

Class

Optional, Static

Range

TDE_WALLET_PWD

TDE_WALLET_PWD specifies the password of wallet file for tde

Parameter Format

Property
Description

Parameter type

String

Default Value

"#encrypted"

Class

Optional, Static

Range

TX_FILTER_KEY

Parameter Format

Property
Description

Parameter type

desc

Default Value

"(FILTER DEFAULT)"

Class

Optional, Static

Range

TX_SAM_TEMPLATE

The TX_SAM_TEMPLATE parameter sets the path to the user-defined template file to be used when outputting transactions to the SAM file. It works when SQL_REDO_MODE is set to N. ProSync reads the template from the specified path whenever a transaction encounters a commit, and logs the transaction content to the SAM file according to that template format.

Parameter Format

Property
Description

Parameter type

path

Default Value

"/"

Class

Optional, Static

Range

USE_LOGMNR

USE_LOGMNR specifies whether to use oracle logminer or to use oracle log reader, when analyzing redo logs.

Parameter Format

Property
Description

Parameter type

Boolean

Default Value

N

Class

Optional, Static

Range

Last updated