Configuration Variable Reference
Per-process setting
Usually, variables are set globally, for all processes. This is done by specifying no process name, or *.
SET LOG_FILE=/home/oracle/log/%N.%E SET *.APPLY.INSTANTIATE_SCN NOW
If the variable value needs to be set differently for a process, use SET with a process name, e.g.
SET APPLY.LOG_FILE=/home/oracle/log/%N.%E SET APPLY.INSTANTIATE_SCN NOW
If the variable needs to be set back to the global "*" setting, use RESET command.
LOG_FILE_SIZENote that if both global "*" and per-process values of the given variable are set then the per-process value has higher priority, e.g.
*.MAILCFG_FROM = john@dbvisit.com
MINE.MAILCFG_FROM = george@dbvisit.com
With this settings MINE process uses email george@dbvisit.com while APPLY and FETCHER processes use john@dbvisit.com.
Variables can also be set with MEMORY_SET, which only sets it in memory and not the DDC file. After a restart of the process the setting will no longer take affect (unless MEMORY_SET is specified in the DDC file).
To clarify:
The MEMORY_SET command sets the value locally, for that one process only and is NOT written to the DDC file. The value is lost upon restart.
The SET command sets the value locally, AND writes into the repository in the database so it will not be lose when the process is restarted.
In the event where a parameter can be adjusted without a process restart (as mentioned in the table below). It is possible to also make use of the following command syntax to set the value for the running process:
ENGINE [MINE|APPLY] SEND SET <VARIABLE_NAME> = <VALUE>
Example:
dbvrep> engine mine send set NOTIFY_INCIDENT_LIMIT = 2
Variable reference
Internal Variable | Description |
---|---|
APPLY_CASE_CONVERT | When a table is prepared, should the name from MINE be kept as-is, made uppercase, or lowercase? This is honored for case-sensitive databases only (MySQL and MSSQL). Parameter change needs a process restart: No |
APPLY_COLUMN_NAMES_MAP | Allows global rename of columns. Translates column names on source database to new column names on target database. This is handy if replicating from one database to another type of database (eg MySQL) where a specific column cannot be used because it is a reserved word. Example: set APPLY_COLUMN_NAMES_MAP PRIMARY=PRIMARY_VALUE This will rename the column PRIMARY to PRIMARY_VALUE on the target database. Multiple columns pairs can be separated with commas: set APPLY_COLUMN_NAMES_MAP PRIMARY=PRIMARY_VALUE, ALTER=ALT Default is an empty string. Parameter change needs a process restart: APPLY |
APPLY_DATABASE | Connection definition for the APPLY database. This is TNS connection string for Oracle, connection string for MySQL or DSN (Data Source Name) for MS SQL. Should not be changed once replication is configured. |
APPLY_DATABASE_DBID | DBID (see v$database) of databases where apply connects. The default is empty and the variable is optional; however, it's always set by setup wizard. This helps to check that the connection strings resolve to correct databases as the apply server. Default: (empty) Should not be changed once replication is configured. |
APPLY_DATE_FORMAT | The output format for dates, timestamps and intervals when using flatfiles. YMD is human-readable like YYYY.MM.DD (+time portion, time zones) or Oracle-like for intervals (+3-2 for year-day). ISO8601 is Java-like 2014-12-05T12:34:56 or P12Y2M.
Parameter change needs a process restart: APPLY |
APPLY_DBI_ARRAY_BIND |
LOAD feature uses array binding if this variable is set to YES. Parameter change needs a process restart: No |
APPLY_DBI_ARRAY_BIND_ROWS | The size of Array Bind when it is switched on for LOAD feature. Default: 500 Parameter change needs a process restart: No |
APPLY_DBI_CACHE_STATEMENTS |
Parameter change needs a process restart: No |
APPLY_DBI_PIPELINE | The number of rows sent to parallel threads at once, to minimize Perl thread copy overhead when using LOAD feature. Default: 25 Parameter change needs a process restart: No |
APPLY_FILEOUT_FILE_BATCH_SIZE | This parameter governs the total size of intermediary files in the APPLY_FILEOUT_STAGING_DIR BEFORE they are flushed to final CSV output, and delivered to APPLY_FILEOUT_TARGET_DIR. This work is done in batches, rather than writing new CSV files for each operation which would be inefficient, and can be tuned according to your requirements. If only a single table is replicated then this value would correlate closely to the file size for the actual output file. The file will be closed then this size is reached and the transaction is completed. Values: integer Default: 10485760 (10mb) Parameter change needs a process restart: APPLY |
APPLY_FILEOUT_FILE_CSV_COMMA | The field separator for CSV output files. Default: (empty) Value: string, with support for escaped chars: \0 \a \b \t \n \v \f \r \x00 (arbitrary hex number ) \\ (backslash) Parameter change needs a process restart: APPLY |
APPLY_FILEOUT_FILE_CSV_NEWLINE | The row separator for CSV output files. Default: (empty) Value: string, with support for escaped chars: \0 \a \b \t \n \v \f \r \x00 (arbitrary hex number ) \\ (backslash) Parameter change needs a process restart: APPLY |
APPLY_FILEOUT_FILE_FORMAT | The file type for the output file.
Parameter change needs a process restart: APPLY |
APPLY_FILEOUT_FILESYSTEM | The type of filesystem to be written to.
Parameter change needs a process restart: APPLY |
APPLY_FILEOUT_HDFS_NAMENODE | The namenode of the Hadoop HDFS. This is the standard protocol how HDFS clients connect. Default: localhost:9000 Values: host:port Parameter change needs a process restart: APPLY |
APPLY_FILEOUT_STAGING_DIR | The directory where output files are stored while they are in progress. Default: OFF Value: directory + file mask. Wildcards: %O table owner %A table name %C transaction start SCN %I object=table id %X transaction id %N apply process name %T process type (=APPLY) %H thread id %S plog id %D ddc name %E file type (csv/avro) Note that one file can contain multiple transactions. So %C/%X/%H/%S are determined based on first transaction in the file. We recommend to use %C to order the output files and add %X for cases when %C is non-unique. Parameter change needs a process restart: APPLY |
APPLY_FILEOUT_TARGET_DIR | The directory where output files are stored when they are completed. Default: OFF Value: directory + file mask. Wildcards: %O table owner %A table name %C transaction start SCN %I object=table id %X transaction id %N apply process name %T process type (=APPLY) %H thread id %S plog id %D ddc name %E file type (csv/avro) Note that one file can contain multiple transactions. So %C/%X/%H/%S are determined based on first transaction in the file. We recommend to use %C to order the output files and add %X for cases when %C is non-unique. Parameter change needs a process restart: APPLY |
APPLY_IGNORE_ERROR_CODES | Automatically ignore specified Oracle errors (ORA- ). Values: string (delimited by :) Default: (empty) (Internally ORA-10655 is pre set) For example, if there is a parent-child relationship and only the parent table is being replicated because the child table does not exist on target, any foreign key constraints being created on the parent-child relationship will be replicated and will result in an ORA-942 table or view does not exist error because the add constraint command doesn't find child table it wants to reference to. Example: APPLY_IGNORE_ERROR_CODES 942 This will make Apply ignore all ORA-00942 error codes. Multiple error codes can be delimited by : Example: APPLY_IGNORE_ERROR_CODES 942:955 Parameter change needs a process restart: No |
APPLY_LISTEN_INTERFACE | Network interface on which APPLY listens for commands (hostname:port). Parameter change needs a process restart: No |
APPLY_LOOP_PREVENTION | If set to YES apply process checks originating dbid of the transaction (on which db it was first mined). If it's same as dbid of apply database, apply skips the change. This is useful for two way replications.
Parameter change needs a process restart: APPLY |
APPLY_MSSQL_USER_DB | Deprecated. Values: string Default: (empty) |
APPLY_PARALLEL_LOAD_DBI | Enables parallel load for LOAD feature.
Parameter change needs a process restart: No |
APPLY_PASSWORD | Encrypted APPLY database password. (Use ENCRYPT command to get encrypted password from the plain text password.) Parameter change needs a process restart: APPLY |
APPLY_PEER | What is the corresponding APPLY for this process? If SIMPLE_CONFIG = YES, this is simply set to APPLY. Parameter change needs a process restart: MINE |
APPLY_POSTPONE_LAST_LCR |
If set to YES, then APPLY will postponing the last LCR or SQL until the next SQL for the same object is found. This can sometimes help with (deadlock) locking issues or "APPLY hung" issues. This can also assist if there are killed sessions on the source database and the APPLY is waiting on the detection of the killed process to rollback (or commit). By setting to YES it means that APPLY is always one SQL behind. This means APPLY always keeps one SQL in each open transaction unapplied. It processes the changes it gets from MINE, but stops short of the last one available so far. As soon as APPLY receives the commit, it applies even the last SQL. So there is never any data loss, although it can be noticed that APPLY lags behind MINE until the commit arrives. But this is probably most visible for manual test cases (like insert 10.000 rows and see that 9.999 has been applied) because in production systems there is always some activity from the source (and with commits), so this situation is rarely seen. Parameter change needs a process restart: APPLY |
APPLY_RDBMS | APPLY database type:
Default will depend on what was entered in the Setup Wizard. Parameter change needs a process restart: No |
APPLY_REMOTE_INTERFACE | Where to connect to reach this APPLY process. This is usually same as APPLY_LISTEN_INTERFACE, but may be changed if the name resolution works differently among the machines, listen binds to selected interfaces only, etc. Note that this settings is used by the console, too. Parameter change needs a process restart: No |
APPLY_SET_TRIGGER_FIRE_ONCE | How to make triggers to not fire in APPLY sessions (YES/NO/AUTO).
Parameter change needs a process restart: APPLY |
APPLY_SCHEMA | APPLY database schema (Oracle, usually same as APPLY_USER), schema=database (MySQL), database (MS SQL). Should not be changed once replication is configured. |
APPLY_SCHEMA2 | APPLY database schema (SQL Server only). Default empty string unless MS SQL is the target. Then it will depend on what was setup in the Setup Wizard. Should not be changed once replication is configured. |
APPLY_STAGING_DIR | Directory to store received PLOGS on APPLY server. Default is the directory set up in the Setup Wizard and then a subfolder of /apply. Parameter change needs a process restart: No |
APPLY_TRACE | The trace file contains all SQL applied as well as further debugging info. Wildcards: %N apply process name %S plog sequence %E file type extension Example: APPLY_TRACE=/home/oracle/d112f/log/trace/%N_%S.%E
Parameter change needs a process restart: APPLY |
APPLY_USE_PK_ONLY | If set to YES the APPLY process will only use the primary key in the WHERE clause. If NO, the APPLY process will also use all supplemental columns in the WHERE clause.
Parameter change needs a process restart: APPLY |
APPLY_USER | APPLY database login username. Default will depend on what was setup in the Setup Wizard. Should not be changed once replication is configured. |
CHECKVARS | Disable/enable checking of variable values.
Parameter change needs a process restart: No |
DDC_DATABASE_DBID | DBID is the Oracle Database ID that is storing the DDC metadata tables for Dbvisit Replicate. This is checked to make sure that Dbvisit connects to the correct database. Values: string (something that a user would not normally set) Should not be changed once replication is configured. |
DDC_BACKUP_DIR | If DDC DB, on every startup of a process a backup of all DDC settings is made into this directory as a backup, e.g. for use with CREATE DDCDB FROM DDCFILE, or just for reference. Parameter change needs a process restart: No |
DDC_DATABASE | TNS identifier for the database when the DDC DB is stored. (Setup wizard sets it to MINE database for this by default.) Note that just setting this variable will not create the DDC DB tables, these are contained in every dictionary. Change to the variable doesn't affect an already configured replication. |
DDC_ID | Unique id of the DDC. This must not change after configuration is complete. Default: 1. |
DDC_NAME | Name of the configuration (%d in filemask). This can change as you want, as internally only the DDC_ID matters, but beware of all %d references. Parameter change needs a process restart: No |
DDC_PASSWORD | Encrypted ddc db database password. (Use ENCRYPT command to get encrypted password from the plain text password.) Default will depend on what was setup in the Setup Wizard. Parameter change needs a process restart: No |
DDC_SCHEMA | DDC database schema, usually same as DDC_USER. Default will depend on what was setup in the Setup Wizard. Change to the variable doesn't affect an already configured replication. |
DDC_USER | DDC DB database login username. Default will depend on what was setup in the Setup Wizard. Change to the variable doesn't affect an already configured replication. |
DDL_IGNORE_USER | Any DDL issued by this user will be ignored. Users are separated by colons. Default: empty. Parameter change needs a process restart: No |
DDL_REPLICATE_GRANTS | If set to YES all grants on the prepared tables will be replicated to the target database. Note that dbvrep user on the target database needs to have sufficient privileges to replicate grants, e.g. GRANT ANY OBJECT PRIVILEGE.
Parameter change needs a process restart: No |
DEBUG_LEVEL | Controls the extent of the debugging level in the Replicate C code. DEBUG_READ 1 DEBUG_ERRORS 0x200 /*apply*/ /*error messages, should not be supressed*/ Example: DEBUG_LEVEL = 0x4000 (16384) . Then all messages up to DEBUG_SQL_COMMANDS will be printed. Default: 0 ( As a default it is always set 0x200 even when DEBUG_LEVEL is set to 0x00 ) Parameter change needs a process restart: APPLY/MINE depending of this setting in the process specific *.ddc file |
DELETE_OBSOLETE_PLOGS_AGE | When PLOGS are applied and no longer needed even after APPLY restart, they are eligible for deletion. In addition, they must be at least DELETE_OBSOLETE_PLOGS_AGE days old. DELETE_OBSOLETE_PLOGS_SIZE_MB takes precedence over this age setting. Delete PLOGS after specific time period. Time period can be days (d) or hours(h). Default: 3d Parameter change needs a process restart: APPLY/MINE |
DELETE_OBSOLETE_PLOGS_SIZE_MB | When PLOGS are applied and no longer needed even after APPLY restart, they are eligible for deletion. Dbvisit Replicate deletes PLOGS exceeding this size in MB. Default: 1024 Parameter change needs a process restart: APPLY/MINE |
DELETE_OBSOLETE_PLOGS_GZIP | Compress the PLOGS as soon as they are not needed by Dbvisit Replicate anymore. Default: Yes Parameter change needs a process restart: APPLY/MINE |
DELETE_OBSOLETE_RLOGS_AGE | When redo logs are mined and no longer needed even after mine restart, they are eligible for deletion. In addition, they must be at least DELETE_OBSOLETE_RLOGS_AGE days old. NOTE: this applies only for redolog copies shipped to mine from fetcher. If mine reads them directly, they are left to be managed by database administrator, using RMAN, backup scripts etc. DELETE_OBSOLETE_RLOGS_SIZE_MB takes precedence over this age setting. Format: specify number of days, hours, minutes and seconds, e.g. 1d20h30m40s (each component is Default: 3d Parameter change needs a process restart: MINE |
DELETE_OBSOLETE_RLOGS_SIZE_MB | When redologs are parsed and no longer needed even after mine restart, they are eligible for deletion. Dbvisit Replicate deletes RLOGS exceeding this size in MB. This applies only to the copies of redologs sent from fetcher to mine. Default: 1024 Parameter change needs a process restart: MINE |
DELETE_OBSOLETE_RLOGS_GZIP | Compress the redo logs transferred from FETCHER as soon as they are not needed by Dbvisit Replicate anymore. Default: Yes Parameter change needs a process restart: MINE |
DISKSPACE_CHECK_BYTE_LIMIT | Sends a email notification as well as a warning message in the log file when free space on the filesystem goes below this threshold. Values: integer Default: 1073741824 (1GB) Parameter change needs a process restart: APPLY/MINE |
DISPLAY_ALL_OBJECTS_IN_LIST_PROGRESS | Show all objects. By default only tables will be shown.
Parameter change needs a process restart: No |
DISPLAY_TABLE_NAME_IN_LIST_PROGRESS | What table name to show when rename is used. The valid values are:
Parameter change needs a process restart: No |
DML_IGNORE_USER | Colon-separated list of users whose DML operations should not be replicated. Use to filter out transactions. Default (empty) Parameter change needs a process restart: APPLY/MINE |
DPUMP_EXCLUDE_STATS | When generating the scripts for export this parameter allows the option to exclude or include statistics.
Parameter change needs a process restart: No |
DROP_SUPPLEMENTAL_LOG_DATA | Supplemental logging is dropped by default when UNPREPARING tables. If the parameter is set to NO then supplemental logging will remain on the table after the table is unprepared.
Parameter change needs a process restart: No |
FETCHER_DATABASE | MINE database TNS (when connecting from FETCHER). Parameter change needs a process restart: FETCHER |
FETCHER_DATABASE_DBID | DBID (see v$database) of databases where fetcher connects. The default is empty and the variable is optional; however, it's always set by setup wizard. This helps to check that the connection strings resolve to correct databases = the same ones as the fetcher server. Default will depend on what was setup in the Setup Wizard. Will be an empty string if FETCHER is not used. Parameter change needs a process restart: FETCHER |
FETCHER_DICTIONARY_DATABASE | Mine dictionary database TNS (when connecting from fetcher). Default (empty) Parameter change needs a process restart: FETCHER |
FETCHER_DICTIONARY_DATABASE_DBID | Optional DBID for the mine dictionary database. Checks that fetcher connects to the correct database. Default (empty) Parameter change needs a process restart: FETCHER |
FETCHER_DICTIONARY_PASSWORD | Encrypted fetcher dictionary database password. (Use " ENCRYPT " command to get encrypted password from the plain text password.) Default (empty) Parameter change needs a process restart: FETCHER |
FETCHER_DICTIONARY_SCHEMA | Schema of mine dictionary repository (when connecting from fetcher). Virtually always same as MINE_DICTIONARY_SCHEMA . Default (empty) Parameter change needs a process restart: FETCHER |
FETCHER_DICTIONARY_USER | Mine dictionary database login username (when connecting from fetcher). Default (empty) Parameter change needs a process restart: FETCHER |
FETCHER_ENABLED | FETCHER (downstream capture) enabled, this means MINE waits for redo logs from FETCHER.
Parameter change needs a process restart: FETCHER/MINE |
FETCHER_LISTEN_INTERFACE | Network interface on which FETCHER listens for commands (hostname:port). Default will depend on what was setup in the Setup Wizard. Parameter change needs a process restart: FETCHER |
FETCHER_PASSWORD | Encrypted FETCHER database password. (Use ENCRYPT command to get encrypted password from the plain text password.) Default will depend on what was setup in the Setup Wizard. Will be an empty string if FETCHER is not used. Parameter change needs a process restart: FETCHER |
FETCHER_PEER | What is the corresponding FETCHER for this process? If SIMPLE_CONFIG = YES, this is simply set to FETCHER. Parameter change needs a process restart: No |
FETCHER_REMOTE_INTERFACE | Where to connect to reach this FETCHER process. This is usually same as FETCHER_LISTEN_INTERFACE, but may be changed if the name resolution works differently among the machines, listen binds to selected interfaces only, etc. Note that this settings is used by the console, too. Parameter change needs a process restart: FETCHER |
FETCHER_SCHEMA | Schema of MINE repository (when connecting from FETCHER). Virtually always same as MINE_SCHEMA. Default will depend on what was setup in the Setup Wizard. Will be an empty string if FETCHER is not used. Parameter change needs a process restart: FETCHER |
FETCHER_THREADS | On RAC, specify a subset of redo log threads that a particular FETCHER should handle; it is necessary to send all threads to MINE, but it is possible to use multiple FETCHERS. Use "ALL" (default) or colon-separated list of threads (e.g. "1:3:5"). Default: ALL Parameter change needs a process restart: FETCHER |
FETCHER_USER | MINE database login username (when connecting from FETCHER). Default will depend on what was setup in the Setup Wizard. Will be an empty string if FETCHER is not used. Parameter change needs a process restart: FETCHER |
FILE_MASK_ALLOW_VARIANTS | If set to YES plog names can use placeholders that can generate different filenames on every mine run when using Java Plog Extractor. Allowed placeholders are %Z (seconds since epoch) and %Q (process uuid (changes after restart)) and must be the last in the filename and must follow %E (extension).
Parameter change needs a process restart: APPLY/MINE |
IGNORE_APPLY_DDL_DIFFERENCES | Will ignore differences in the table definition (or if it is missing) between source and target during the prepare phase.
Parameter change needs a process restart: No |
INSTANTIATE_SCN | Determines where to initiate the replication from. The valid values are:
Parameter change needs a process restart: APPLY |
LICENSE_BAR | Show license info and product version in console
Parameter change needs a process restart: No |
LICENSE_KEY | License key, as obtained by your purchase. Default: Your license key or a random trial license good for 30 days. Parameter change needs a process restart: No |
LOG_FILE | General process log file location template. Default will depend on what was setup in the Setup Wizard. Generally it is 'home'/log Parameter change needs a process restart: APPLY/MINE/FETCHER depending on the process specific setting (e.g. APPLY.LOG_FILE) |
LOG_FILE_TRACE | General trace file location template. Default will depend on what was setup in the Setup Wizard. Generally it is 'home'/log/trace Parameter change needs a process restart: APPLY/MINE/FETCHER depending on the process specific setting (e.g. APPLY.LOG_FILE_TRACE) |
LOG_FILE_COUNT | The number of copies of the log that should be kept. The active log will always be called *.log. Once the file is full (see LOG_FILE_SIZE parameter) then a copy of the log will be rotated and saved as *log.1. Any contents saved in *log.1 will be saved as *log.2. The process will continue determined by the value that this parameter is set to. When the default number is reached the last one will be rotated off. Parameter change needs a process restart: APPLY/MINE/FETCHER depending on the process specific setting (e.g. APPLY.LOG_FILE_COUNT) |
LOG_FILE_DATE_ROTATE | If not OFF (default), specifies how often rotate the general log files. Allowed values:
Note: The values provided above are CASE SENSITIVE, so make sure you provide the values same as above. Parameter change needs a process restart: APPLY/MINE/FETCHER depending on the process specific setting (e.g. APPLY.LOG_FILE_ROTATE) |
LOG_FILE_SIZE | Approximate maximum log size in bytes. Once the log exceeds this size the log file will rotate. Parameter change needs a process restart: APPLY/MINE/FETCHER depending on the process specific setting (e.g. APPLY.LOG_FILE_SIZE) |
LOG_OBSOLETE_AGE_PLOG | Obsolete, don’t use Values: integer (days) Default: 0 Parameter change needs a process restart: APPLY/MINE |
LOG_OBSOLETE_AGE_RLOG | Obsolete, don’t use. Values: integer (days) Default: 0 Parameter change needs a process restart: MINE |
LOG_PACKAGE_CSV_MAX_AGE | Limits the amount of data from metadata tables for the support package. Data older than (N) days will not be included. Values: integer (days) Default: 10 Parameter change needs a process restart: No |
LOG_PACKAGE_TRC_MAX_AGE | Limits the amount of data from trace files for the support package. Trace files older than (N) days will not be included. Values: integer (days) Default: 30 Parameter change needs a process restart: No |
MAILCFG_AUTH_PASSWD | The password to be used if the SMTP server requires authentication. Values: Any string with at least one character. Default: OFF Parameter change needs a process restart: No |
MAILCFG_AUTH_USER | The username to be used if the SMTP server requires authentication. Values: Any string with at least one character. Default: OFF Parameter change needs a process restart: No |
MAILCFG_FROM | The From address to be used in outgoing emails. Values: String, that represents one valid email address. Default: nobody@example.com Parameter change needs a process restart: No |
MAILCFG_PORT | The SMTP port to be used (for SMTP server it is usually 25; however, the usual value for SSL-enabled SMTP server is 465). Values: Any integer number greater or equal to zero. Default: 25 Parameter change needs a process restart: No |
MAILCFG_SMTP_SERVER | Sets SMTP mail server to be used for sending emails. Values: Any string with at least one character. Default: localhost Parameter change needs a process restart: No |
MAILCFG_USE_SSL | Use SSL protocol for the SMTP server Values: YES/NO/TLS. (case insensitive) Default: NO Parameter change needs a process restart: No |
MEMORY_LIMIT_MINE_MB | Memory limit for MINE, specified in megabytes. Note that these figures do not include overhead of Perl and of system malloc(), thus do not set it to consume all of your available memory. It does not use ulimit or other OS-based limits. Settings this too low will cause MINE to abort. Values: Any integer number greater or equal to zero. Default: 2048 Parameter change needs a process restart: MINE |
MEMORY_LIMIT_APPLY_MB | Memory limits for APPLY, specified in megabytes. Note that these figures do not include overhead of Perl and of system malloc(), thus do not set it to consume all of your available memory. It does not use ulimit or other OS-based limits. Setting this low may cause performance degradation, setting it too low will cause APPLY to abort. Values: Any integer number greater or equal to zero. Default: 2048 Parameter change needs a process restart: APPLY |
MINE_ARCH_DEST | MINE will ONLY look in this directory for archivelogs. This parameter will be used in conjunction with the REDO_READ_METHOD set to ARCHONLY. Values: Any string (even empty one). Default: "" (empty string). Parameter change needs a process restart: No |
MINE_ARCH_DEST_FORMAT | This parameter is used together with MINE_ARCH_DEST. Available options: %T_%S_%R %E for standby. Values: Any string (even empty one). Default: "" (empty string). Parameter change needs a process restart: No |
MINE_ASM | SID for ASM (usually +ASM). Note that on RAC, this must be set to the local ASM node name (e.g. +ASM2). Values: "", "AUTO", "OFF", SOME_OTHER_STRING Value "" meaning: This instructs Dbvisit Replicate to detect if there is ASM of there is no ASM. If ASM was detected → detect SID for ASM automatically and use it, if ASM was not detected → use redo logs on the filesystem. Value "AUTO" meaning: This instructs Dbvisit Replicate to use ASM, but it should detect the SID for ASM automatically and use it. Value "OFF" meaning: This instructs Dbvisit Replicate to ignore redo logs in ASM and uses the redo logs on the file system (when they are multiplexed). This is useful when using older versions of ASM such as 10.1 as Dbvisit Replicate only supports ASM version 10.2 and higher. Value SOME_OTHER_STRING meaning: This instructs Dbvisit Replicate to use ASM, and use SOME_OTHER_STRING as SID. Default: "" (empty string). Parameter change needs a process restart: MINE/FETCHER |
MINE_CONVERT_TZ_TO_UTC | Converts the Timezone to UTC time. For use with the Kahiti project. Used in Conjunction with MINE.SOURCE_TIMEZONE parameter that is set automatically with the Setup Wizard. If you are using with regular APPLY, you have to set APPLY.SOURCE_TIMEZONE=UTC (so APPLY does not recalculate the TZ with LTZ values once again). Values: NO/YES Default: NO Parameter change needs a process restart: MINE |
MINE_DATABASE | MINE database TNS connection string. Parameter change needs a process restart: MINE |
MINE_DATABASE_DBID | DBID (see v$database) of databases where mine connects. It always set by setup wizard. This helps to check that the connection strings resolve to correct databases = the same ones from mine server. Default is an empty string. Parameter change needs a process restart: MINE |
MINE_DICTIONARY_DATABASE | Mine dictionary database TNS connection string. Default (empty) Parameter change needs a process restart: MINE |
MINE_DICTIONARY_DATABASE_DBID | Optional DBID for the mine dictionary database. Checks that mine connects to the correct database. Default (empty) Parameter change needs a process restart: MINE |
MINE_DICTIONARY_PASSWORD | Encrypted fetcher dictionary database password. (Use ENCRYPT command to get encrypted password from the plain text password.) Default (empty) Parameter change needs a process restart: MINE |
MINE_DICTIONARY_SCHEMA | Database schema containing the repository tables (usually same as MINE_DICTIONARY_USER) Default (empty) Parameter change needs a process restart: MINE |
MINE_DICTIONARY_USER | Mine dictionary database login username. Default (empty) Parameter change needs a process restart: MINE |
MINE_DISK_USAGE_LIMIT_MB | Mine pauses if PLOGs + REDOlogs take more disk space than is the limit set by this variable. The default value 0 disables the feature. Default: 0 Parameter change needs a process restart: No |
MINE_HEARTBEAT_TIME | This parameter determines the frequency of how often an update happens to the DBRSCOMMON_HEARTBEAT table in the dbvrep schema. This table can be used to monitor the state of replication. Value is in seconds. If you want to disable this feature set to 0. Values: Any integer number equal or greater than zero. Default: 10 (seconds) Parameter change needs a process restart: No |
MINE_LISTEN_INTERFACE | Network interface on which MINE listens for commands (hostname:port). Default will depend on what was setup in the Setup Wizard. Parameter change needs a process restart: MINE |
MINE_LOOP_PREVENTION | If set to YES mine skips all changes done by apply process. It does not care about which ddc it was, which dbvrep user etc. This is useful for two way replication.
Parameter change needs a process restart: MINE/APPLY |
MINE_PASSWORD | Encrypted FETCHER database password. (Use ENCRYPT command to get encrypted password from the plain text password.) Default will depend on what was setup in the Setup Wizard Parameter change needs a process restart: MINE |
MINE_PEER | What is the corresponding MINE for this process? If SIMPLE_CONFIG = YES, this is simply set to MINE. Parameter change needs a process restart: FETCHER |
MINE_PLOG | Template for PLOG files generated on MINE. %S.%E is the default in the Setup Wizard (list of all possible placeholders see at the end of this page) and the directory is usually /install/mine/ Parameter change needs a process restart: MINE |
MINE_REMOTE_INTERFACE | Where to connect to reach this MINE process. This is usually same as MINE_LISTEN_INTERFACE, but may be changed if the name resolution works differently among the machines, listen binds to selected interfaces only, etc. Note that this settings is used by the console, too. Default will depend on what was setup in the Setup Wizard Parameter change needs a process restart: MINE |
MINE_REWRITE_TRUNCATE | A TRUNCATE TABLE statement is replicated to target rewritten as simple "TRUNCATE TABLE schema.table", dropping any Oracle-specific options. This enables Replicate to replicate to non-Oracle targets and thus support this command, although it's formally a DDL statement. Default: YES Parameter change needs a process restart: No |
MINE_SCHEMA | Database schema containing the repository tables (usually same as MINE_USER). Default will depend on what was setup in the Setup Wizard Parameter change needs a process restart: MINE |
MINE_STAGING_DIR | Directory where to store redo logs received from FETCHER. Parameter change needs a process restart: No |
MINE_TRACE | Trace file can be compared with trace file generated by Oracle alter system dump logfile.
Parameter change needs a process restart: No |
MINE_TRUNCATE_WITHOUT_DDL | If set to YES mine will replicate TRUNCATE operations even when DDL replication is off.
Parameter change needs a process restart: MINE |
MINE_UNIQUE_ID | Unique ID of MINE, regenerated every time the MINE dictionary is recreated, e.g. when scripts created by setup wizard are re-run. This ID uniquely identifies the PLOGS, so they do not get mixed up between different replications. |
MINE_USER | MINE database login username. Parameter change needs a process restart: MINE |
NCHARSET | This is the national character set of the source database. This is relevant only for NCHAR/NVARCHAR2 columns. Only UTF8 and AL16UTF16 values are supported; Oracle expects Unicode values to be specified in UTF16, so if the source database is using UTF8 (specified by this setting), APPLY does the necessary conversion to UTF16. Any other (legacy) mutlibyte character sets are currently not supported. Parameter change needs a process restart: MINE |
NETWORK_QUALITY | Configure Network Timeouts, Compression, Transfer block size, etc. to suit slow or fast network. Values of LAN/WAN are Deprecated for this version.
_NETWORK_CHUNKSIZE 10000000 (app. 10MB) |
NETWORK_TRAFFIC_KEY | Common key for network authorization among FETCHER, MINE, APPLY and console. Parameter change needs a process restart: MINE/APPLY/FETCHER/CONSOLE |
NLS_LANG | The NLS_LANG variable is set at the APPLY environment and behaves like the NLS_LANG environment does: it sets the language, territory and character set of the APPLY session. The language and territory are not very important (they affect things like Oracle error messages shown), the character set must be set to the source database character set, so the any character strings applied are treated correctly according the character set they are in. Apart from setting the NLS_LANG to a character set. The values of NLS_LANG can also be:
Note: These above 2 settings should be set using the "memory_set" and not the "set" command. Example: memory_set MINE.NLS_LANG=KEEP_UNDEF This can be set in the MINE ddc file. Also see NLS Considerations. Default will depend on NLS settings of the environment the dbvrep executable was run on. Parameter change needs a process restart: MINE/APPLY |
NOTIFY_ALERT_EMAIL | The error notification emails (=all except list progress and heartbeat) are sent to these addresses. Separate multiple addresses by comma. Parameter change needs a process restart: Yes |
NOTIFY_ALL_EMAIL | All notifications emails are sent to these addresses. Separate multiple addresses by comma. Default = OFF Parameter change needs a process restart: No |
NOTIFY_CONFLICT_THRESHOLD | If the number of conflicts on APPLY equals or exceeds this threshold, an SNMP trap and/or email is sent. This setting only applies to the number of conflicts since the last restart of the Apply process. Restarting the Apply process resets the number of conflicts to 0. Example: Before restarting the Apply process the number of conflicts is 250 Conflicts:250/250 After restarting of the Apply process, the number of conflicts is 0 Conflicts:250/0 Value 0 is turning that notification off. Default 100 Parameter change needs a process restart: No |
NOTIFY_CONFLICT_CURRENT_PAUSE | If APPLY is waiting on conflict (PAUSE handler), should a notification be sent?
Parameter change needs a process restart: No |
NOTIFY_CONFLICT_CURRENT_RETRY | If APPLY is waiting on conflict (RETRY handler), after how many retries should a notification be sent? Values: Integer Default: 2 Parameter change needs a process restart: No |
NOTIFY_DAILY_LIST_PROGRESS_TIME24 | Times when the overall progress email should be sent. Use 24-hour time format, separate multiple times by colon, e.g. 0700 or 0800:2000. Note that times near to midnight may be skipped, if no check gets scheduled till midnight (see also NOTIFY_INTERVAL_BETWEEN_CHECK). Default: 0700 Parameter change needs a process restart: No |
NOTIFY_EXCEEDED_CYCLE_NUM | How many times must be a notification condition be met before the SNMP trap / email is actually sent. (\ Values: Integer Default: 2 Parameter change needs a process restart: No |
NOTIFY_INCIDENT_LIMIT | How many times a notification will be sent out via email for a given incident. |
NOTIFY_INTERVAL_BETWEEN_CHECK | How often the notification checks are performed. (Specify seconds, minutes, hours, days, as needed, e.g. 5m or 1h20m30s). Value: Integer (plus s:m:h:d) Default: 5m Parameter change needs a process restart: No |
NOTIFY_ON_DDL | Sends an email when apply replicates a DDL statement.
Parameter change needs a process restart: Apply |
NOTIFY_PEER_DOWN | ALL or colon-separated list. If the specified peer is down, sends an SNMP trap and/or email. Example: MINE:APPLY:APPLY1 Default: ALL Parameter change needs a process restart: No |
NOTIFY_PROGRESS_DIFFERENCE_PERC | If the lag between APPLY and MINE for any table exceeds this threshold, an SNMP trap and/or email is sent. (This checks the percentage as shown by the LIST PROGRESS command.) |
NOTIFY_SCN_DIFFERENCE | SCN difference: if the lag between APPLY and MINE exceeds this threshold, an SNMP trap and/or email is sent. Values: Integer Default is 10000 Parameter change needs a process restart: Yes |
NOTIFY_SEND_HEARTBEAT_TIME24 | Times when the overall heartbeat email should be sent. Use 24-hour time format, separate multiple times by colon, e.g. 0700 or 0800:2000. Note that times near to midnight may be skipped, if no check gets scheduled till midnight (see also NOTIFY_INTERVAL_BETWEEN_CHECK). Default: 0800:1300 Parameter change needs a process restart: No |
NOTIFY_SEQUENCE_DIFFERENCE | Number of redo logs / PLOGS: if the lag between APPLY and MINE or MINE and FETCHER exceeds this threshold, an SNMP trap and/or email is sent. Values: Integer Default: 10 Parameter change needs a process restart: No |
NOTIFY_SUCCESS_EMAIL | The list progress and heartbeat emails are sent to these addresses. Separate multiple addresses by comma. Default: OFF Parameter change needs a process restart: No |
NOTIFY_TIME_DIFFERENCE | The time, in seconds, between MINE and APPLY. If the lag between APPLY and MINE or MINE and FETCHER exceeds this threshold, an SNMP trap and/or email is sent. Values: Integer Default: 300 Parameter change needs a process restart: No |
OCI_COMMIT_MODE | Commit options for APPLY sessions (target). Can be either
The default value is DEFAULT, which is the usual behaviour of commit on Oracle. DEFAULT is the only valid option for Oracle 9i. Option is ignored for non-Oracle databases. Consult with support before setting, as some of the non-default values may lead to data loss in some special cases such as RAC. Setting to NOWAIT BATCH means APPLY will not wait for commit redo to be written to disk. This may improve performance of APPLY, but is not recommended for RAC target systems because during a crash of one of the nodes not all the SCN information of the replication will be up to date. And this may cause data loss in the replication. For RAC target systems set to WAIT IMMEDIATE which means commit wait. For Oracle current versions, DEFAULT is the same as WAIT IMMEDIATE. Parameter change needs a process restart: APPLY |
ON_ERROR | Should errors be treated fatal? Usually used in DDC file so that failed variable checks are clearly pointed out.
Parameter change needs a process restart: No |
ON_WARNING | Should warnings be treated fatal?
Parameter change needs a process restart: No |
ORACLE_HOME | Set this variable for Dbvisit Replicate with the same affect as setting them in the shell environment. Note that ASM connection use bequeath connection and thus need same ORACLE_HOME as that when ASM actually resides. Default: empty string Parameter change needs a process restart: MINE |
ORACLE_SID | Set this variable for Dbvisit Replicate with the same affect as setting them in the shell environment for any Oracle client. Default: empty string Parameter change needs a process restart: MINE |
PLOG_TRACE_SQL_FORMAT | Format of SQL in conflict log table:
BIND = show SQL statements with bind variables NOBIND = show SQL statements with literals BOTH = show both Parameter change needs a process restart: APPLY |
PREPARE_CHECK_APPLY | Should PREPARE command check that the table exists on target database?
Parameter change needs a process restart: No |
PREPARE_CHECK_MINE | Should PREPARE command check that the table exists on target? Default: YES. Note that both mine and apply checks also include supported datatypes, for apply we check that the datatypes match with source.
Parameter change needs a process restart: No |
PREPARE_CHECK_MINE_TABLE_TYPE | Global Temporary Tables will be checked when the PREPARE command is run. Global Temporary Tables will be ignored. If you have a large number of tables you may wish to set the parameter to NO to speed up the PREPARE command, however this may mean that Global Temporary Tables are replicated.
Parameter change needs a process restart: No |
PREPARE_SCHEMA_EXCEPTIONS | The list of schema.tables to be skipped in PREPARE SCHEMA. This is part of Step 3 in the Setup Wizard if you specify exceptions. Values: string Default: (empty) Parameter change needs a process restart: No |
PROCESS_TYPE | Set type of process to MINE/FETCHER/APPLY (this must be set per-process). With SIMPLE_CONFIG, APPLY process is set to APPLY, MINE to MINE and if FETCHER is enabled, FETCHER to FETCHER. Default: APPLY.PROCESS_TYPE = APPLY MINE.PROCESS_TYPE = MINE This parameter is not supposed to be changeable (The only situation which comes to mind is that value changed to OFF in order to switch off one of the apply processes). Parameter change needs a process restart: APPLY |
PROFILER | OFF / profiler file name. Use only as instructed by support. This will generate extra trace files with profiling information that can be used by support to further diagnose issues. This can be turned on for the MINE or APPLY process or both. Example: Restart the process and wait for a few log switches, then zip and upload the resulting files to support. The specified path can be arbitrary but ensure to include %S in the name so a new file is generated for each log switch. Please see Dbvisit Replicate Profile Performance Statistics for more information. Default: OFF Parameter change needs a process restart: MINE/APPLY |
REDO_READ_METHOD | Specify if both online redo logs and archive logs should be used or archive log only (archivelogs only) files exclusively.
Set this in the *MINE.ddc only. Parameter change needs a process restart: MINE |
REPLICATE_INTERNAL_TABLES | Determines whether Replicate internal tables (DBRSOBJ$, DBRSUSER$, DBRSCOMMON_HEARTBEAT and for CSV output also DBRSCOL$) are replicated to target. Do not change to NO unless instructed by Dbvisit support, as apply depends on this to work correctly.
Parameter change needs a process restart: MINE |
RETRY_TIME | Seconds between retries if conflict handling is RETRY. Default: 5 seconds Parameter change needs a process restart: no |
SETUP_SCRIPT_PATH | Path to setup scripts. Used when packing scripts for support. This path is set as part of the Setup Wizard. Parameter change needs a process restart: no |
SIMPLE_CONFIG | If set to YES, configures processes MINE, FETCHER (if fetcher_enabled) and APPLY. Use for a single one-way configuration. Default: YES Parameter change needs a process restart: no |
SNMP_INDEX | Disables/enables SNMP subagent. Also sets the index in the process table presented by the SNMP agent. (Set to 0 to disable SNMP, set to 1 if there is just one process of that particular type on the machine, set to unique values for each process type if there are multiple processes of the same type) Default: 0 Parameter change needs a process restart: FETCHER/MINE/APPLY |
SNMP_TRAP_COMMUNITY | Sets community (=password) for sending of SNMP traps. Default: public Parameter change needs a process restart: FETCHER/MINE/APPLY |
SNMP_TRAP_DESTINATION | Sets destination for SNMP traps (notifications).
Parameter change needs a process restart: FETCHER/MINE/APPLY |
SOURCE_OS_TIMEZONE | Determines the source database timezone so that "TIMESTAMP WITH LOCAL TIME ZONE" datatype is handled properly. The default is UNKNOWN, meaning we autodetect it. If this autodetection is wrong, set this variable manually to an Oracle-known timezone. Values: UNKNOWN/time zone (can be both +HH:MM or a name like Africa/Johanesburg). Parameter change needs a process restart: MINE |
SOURCE_TIMEZONE | Setup Wizard sets this parameter based on your local timezone. This parameter is used to convert timestamp with local time zone. Default depends per configuration. Parameter change needs a process restart: MINE/APPLY |
SQL_QUOTE_IDENTIFIERS | Quote owner/table/column name in apply SQL. Uses "" for Oracle, [] for MSSQL.
Parameter change needs a process restart: APPLY |
SQL_TRACE | Enable Oracle sql trace (aka 10046) on all Replicate Oracle sessions.
Parameter change needs a process restart: no |
STATUS_BAR | Show status bar in console
Parameter change needs a process restart: CONSOLE |
STATUS_BAR_ACTIVE_TABLES | This is set to a number to limit the number of active tables shown in the status bar. Example: STATUS_BAR_ACTIVE_TABLES = 20 Default: AUTO Parameter change needs a process restart: no |
STATUS_BEAT_LCR | How often should be a log message written to log showing number of processed LCRs (in LCR count) (use 0 to disable). Changes on log switch. Default: 10000 Parameter change needs a process restart: no |
STATUS_BEAT_TIME | How often should be a log message written to log showing number of processed LCRs (in seconds) (use 0 to disable). Changes on log switch. Values: Integer Default: 120 Parameter change needs a process restart: no |
STATUS_SHOW_PAST_CONFLICTS | If set to YES, then the APPLY status line in the status bar will show the number of past conflicts even when they are resolved. This is the default. YES (default) NO Example: If set to No, then the APPLY status line in the status bar will only show the current conflict. When they are resolved it will not show past conflicts. Example: Parameter change needs a process restart: no |
STATUS_SORT | Set for each process to specify sort order in status bar. Simple config does this automatically, setting the order FETCHER.STATUS_SORT=01, MINE.STATUS_SORT=02, APPLY.STATUS_SORT=03. Default: APPLY.STATUS_SORT = 01 MINE.STATUS_SORT = 00 Parameter change needs a process restart: no |
THREAD_MEMORY_DUMP_ON_PLOG_SWITCH | Controls whether the apply process dumps memory info on every log switch.
Parameter change needs a process restart: APPLY |
THREAD_PROFILER_ENABLED | Enables the profiler.
Parameter change needs a process restart: MINE |
THREAD_PROFILER_DUMP_ON_PLOG_SWITCH | Determines whether profiler information should be printed to the log file on every redo log switch. Change of the parameter is applied on log switch.
Parameter change needs a process restart: no |
THREAD_PROFILER_DUMP_ON_PLOG_SWITCH_ENTRIES | Determines how many top events will be printed to the log for each plog that is processed. Change of the parameter is applied on log switch.
Parameter change needs a process restart: no |
THREAD_PROFILER_HISTORY | When profiling information is printed to the log, it determines how many of the lastest plogs, should have the statistics calculated and printed.
Parameter change needs a process restart: MINE |
TNS_ADMIN | Mandatory parameter that is set in the wizard. Points to tnsnames.ora/sqlnet.ora to be used to resolve connection strings. Default: TNS value set during the Setup Wizard. Parameter change needs a process restart: FETCHER/MINE/APPLY |
TWO_TASK | Set this variable for Dbvisit Replicate with the same affect as setting them in the shell environment for any Oracle client. Default: empty string Parameter change needs a process restart: FETCHER/MINE/APPLY |
WATCHDOG_NOBIND_SQL | Watchdog will show SQL with actual values instead of just bind variables.
Parameter change needs a process restart: APPLY |
WATCHDOG_TIMEOUT | Timeout for waiting on lock to be released when applying (most notably for TM/TX locks, i.e. waiting for other sessions modifying the same rows). (Waits ½ of this time before aborting due to internal deadlocks etc., waits full time for other users.) Values: Integer (seconds) Parameter change needs a process restart: no |
File templates
Where a template is required, specify a full filename including path, utilizing following placeholders:
- %D – DDC_NAME
- %E – extension (hardcoded per file type – PLOG, log, ...)
- %F – original filename without extension
- %I – process ID (PID)
- %M – value of the variable MINE_UNIQUE_ID
- %N – process name
- %P – process type (MINE, APPLY, FETCHER)
- %Q – a unique id (UUID) of the current process (changes with every restart)
- %R – current database incarnation id (also known as resetlogs id)
- %S – sequence
- %T – thread
- %U – six random characters (letters, numbers, underscore)
- %Z – the number of non-leap seconds since whatever time the system considers to be the epoch