All keywords are case-insensitive.
If a command works directly with mineMINE/applyAPPLY/fetcher FETCHER (not by process name), you have to choose your process by "CHOOSE" command. (This is not needed in simple configurations with only one mineMINE/apply APPLY as this happens automatically).
The syntax diagrams in this document use a variation of Backus-Nauer Form (BNF), a convention familiar to any reader of Oracle documentation and many other documents. Emphasis and symbols have the following meaning in this version of BNF syntax.
- Keywords are shown in UPPERCASE.
- Placeholders for which you must substitute an actual value are shown in lowercase. These can include clauses and other expressions.xxxdatafile249
- Vertical (|) bars separate multiple choices. They indicate "or".
- Square brackets ( [] ) are not typed. They indicate that the enclosed syntax is optional.
- Curly braces ( {} ) usually are not typed. They indicate that you must specify one of the enclosed choices. (The choices are separated by vertical bars.)
- Loops or repetitions are indicated by a second, bracketed appearance of the term, set of terms, or expression, followed by ellipsis points. The brackets indicate that the repetition is optional (all repetitions are optional). The ellipsis points indicate that multiple repetitions are allowed. The bracketed appearance of the term begins with a comma if the repetitions are comma delimited.
- All other punctuation (quotation marks, commas, semicolons, and so on) must be typed as shown.
- Some commands require a restart of the Mine MINE or Apply APPLY processes.
HELP
Shows general help, help for specific command or help for a variable.
...
Execute command in a new shell.
HEALTHCHECK
Connects to mine MINE and apply APPLY (and fetcher FETCHER if configured). Checks that they see each other.
...
Sets configuration variable in memory only. Use for variables that cannot be set in the DDC DB or if you want the value to be valid for short time only. After restart of the process the setting will no longer apply APPLY (unless MEMORY_SET is specified in the DDC file).
...
Displays the current status of mineMINE, apply APPLY and fetcher FETCHER processes.
Connects to database and lists registered redologs / plogsPLOGS.
LIST PROGRESS. Show tabular overview of mineMINE/apply APPLY records processed and conflicts. You can optionally specify a schema to filter the results to a particular database schema (this is source schema if renaming is used). Use ALL to see everything including Dbvisit Replicate internal tables.
...
LIST CONFLICT. List the current conflict(s). This information is obtained from Dbvisit Replicate internal table DBRSAPPLY_CONFLICT_LOG on the apply APPLY side.
LIST STATS. Display statistics for number of rows processed/minute and/or lag between mine MINE and applyAPPLY. The lag can be displayed in terms of time or SCN difference; the number of rows per minute can be shown globally or for specified table.
By default, the number of rows processed/minute represents APPLY performance; use LIST STATS TOTAL MINE to see mine MINE statistics.
LIST TRANSACTIONS. This command lists opened uncommitted transactions on applyAPPLY. The Transaction ID is the hex value of the combined columns XIDUSN, XIDSLOT, XIDSQN from v$transaction on the target database. The Transaction ID is also set in columns MODULE and ACTION from V$SESSION on the target database.
...
Use APPLY COMMIT TRANSACTION to force commit of the specified transactions on applyAPPLY, however contact Dbvisit support before issuing the APPLY COMMIT TRANSACTIONS command.
...
APPLY COMMIT TRANSACTION. Force commit of the specified transaction on applyAPPLY. Use LIST TRANSACTIONS first to see what transactions are currenlty pending on applyAPPLY.
Contact Dbvisit support before using this command; it should never be needed under normal circumstances. Please see http://support.dbvisit.com/entries/24825508-Committing-uncommitted-transactions for an example of how to use this command.
...
FILE: Parses given online/archive redo, generates plog PLOG and parses the plogPLOG. (Note that to generate traces etc. during query mode, you still have to set the corresponding configuration variables.)
In query mode, incomplete plog PLOG will generate only an error, not a fatal error.
Note that this is a local API command, so you have to see the redo log on local filesystem.
No changes are actually applied to apply APPLY database.
PLOG: Parses selected plog PLOG (usually a conflict error plogPLOG) – either by specifying a filename, or by conflict id.
In query mode, incomplete plog PLOG will generate only an error, not a fatal error.
Note that this is a local API command, so you have to see the error-log on local filesystem, and have to be able to connect to apply APPLY database to query metadata if using conflict id.
No changes are actually applied to apply APPLY database.
CONFLICT: If error plogs PLOGS are enabled (disabled by default), tries to get error plog PLOG for given conflict id and run QUERYMODE PLOG on that file.
...
| Align |
|---|
Used for adding tables or schemas to the replication. Prepares a schema/table for replication and declares that their content is in sync as of now. If a schema is prepared and DDL replication is enabled, new tables created in this schema in future will be also prepared and replicated. By default, this command connects to running apply APPLY and mine MINE and instructs them to replicate the schema/table. If OFFLINE is used, applyAPPLY/mine MINE will pick the new tables on the next start. Use OFFLINE if the apply APPLY and mine MINE are not running, as some network configurations may cause long timeouts while PREPARE tries to connect to the applyAPPLY/mineMINE. By default, DDL replication is enabled. Use NODDL to disable it (mandatory for non-Oracle databases). RENAME clause makes the replication to apply APPLY the changes to the given schema/table at applyAPPLY. Note that the RENAME TO clause requires the NODDL option. PREPARE will lock the table to ensure no inflight transactions are missed. During initial setup in the *.dbvrep script, the PREPARE command is often preceded with the ENGINE LOCK TABLES, or ENGINE LOCK SCHEMAS command (followed by the RELEASE LOCK). Prepare recognizes that the ENGINE LOCK command has run and use the SCN from the lock. So when multiple tables are prepared, only a single SCN is used for all tables. When an ENGINE LOCK command has been issued in the same session, then the PREPARE command will no longer lock the tables. To clear the session, restart the console. |
...
Unprepares a schema/table for replication and declares that this object should no longer be replicated.
If OFFLINE is used, applyAPPLY/mine MINE will pick the change on the next start. Use OFFLINE if the apply APPLY and mine MINE are not running, as some network configurations may cause long timeouts while PREPARE tries to connect to the applyAPPLY/mineMINE.
REPREPARE
Used for adding tables or schemas to the replication.
...
Entering this command in the console requires a restart of the Mine MINE process.
INCLUDE COLUMN
This command relates to the EXCLUDE COLUMN command and can be used to:
...
This command requires a restart of the Mine MINE process.
EXCLUDE CREATE TABLE
...
The commands add a new rule; if an existing rule of opposite meaning already exists, it is deleted instead. The matching starts with the oldest one and goes on till the newest rule added; if a reordering is needed, clear the list and start again. The SHOW option lists the existing rules using the very same syntax, so the list can be easily edited and then executed to apply APPLY the changes.
The Mine MINE process has to be restarted for this to take effect.
...
- Remove and already existing EXCLUDE CREATE TABLE rule
- Add an exception to the EXCLUDE CREATE TABLE rule. For example, EXCLUDE CREATE TABLE SCOTT.TEMP%, but INCLUDE CREATE TABLE SCOTT.TEMP_REPL
The Mine MINE process has to be restarted for this to take effect.
...
Set filtering rules for an already prepared table/schema. The usual way how to configure filtering is using Setup wizard (which in turn uses this very command).
If OFFLINE is used, applyAPPLY/mine MINE will pick the change on the next start. Use OFFLINE if the apply APPLY and mine MINE are not running, as some network configurations may cause long timeouts while PREPARE tries to connect to the applyAPPLY/mineMINE.
CDCAUDIT
...
SHUTDOWN process_name
Connect to mineMINE/applyAPPLY/fetcher FETCHER and request it to shut down.
ALL means requesting all processes defined in DDC to shut down.
DUMP
Request mineMINE/apply APPLY to dump debug information to log.
DUMP ALL is invoked automatically when exiting due to a untrapped fatal error.
DUMP ALL can be also invoked by sending SIGUSR2 (kill -12) to the process (not available on Windows).
...
Gets object id as of current mine MINE progress and sets conflict handlers for this table (schema.name refers to current table name at mineMINE).
The DEFAULT conflict handler will not be applied to existing prepared (replicated) tables. The DEFAULT conflict handler will only be applied to tables that are prepared after the DEFAULT conflict handler is set. To change the conflict handler for existing prepared tables, each table has to be individually set using FOR TABLE conflict handler.
SHOW_CONFLICT_HANDLERS
Shows current setting of conflict handlers for given table (schema.name refers to table at mineMINE).
RESOLVE
Contacts apply APPLY and resolves current conflict.
...