All keywords are case-insensitive.
...
Shows general help, help for specific command or help for a variable.
READ
Reads the designated file like it would be entered at command prompt. As with SQL*Plus, both "@file" and "@ file" work.
READDDC
Read the specified DDC file. Same as command line option "--ddcfile file", which is preferred, as READDDC is from interactive prompt sets some variables too late to be effective (e.g. STATUSBAR).
EXEC
Execute command in a new shell.
HEALTHCHECK
Connects to MINE and APPLY (and FETCHER if configured). Checks that they see each other.
SET
Sets configuration variable in memory and DDC DB. This setting will be permanent. See memory_set for setting in memory only and which are not permanent.
RESET
Unsets variable for a specified process, falling back to general non-process-specific setting.
To clear the counters, see clear.
MEMORY_SET
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 (unless MEMORY_SET is specified in the DDC file).
MEMORY_RESET
Unsets variable, in memory only.
SHOW
With no parameter or with ALL, shows all configuration variables, as they are seen by current process. It does not reread DDC file nor DDC DB to update the settings.
With variable, shows variable value. (For * and also for all processes.)
LIST
Displays the current status of MINE, APPLY and FETCHER processes.
...
Connects to database and lists registered redologs REDOLOGS / PLOGS.
LIST PROGRESS. Show tabular overview of MINE/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.
...
Use APPLY COMMIT TRANSACTION to force commit of the specified transactions on APPLY, or APPLY ROLLBACK TRANSACTION to force rollback of the transaction on APPLY. Ensure you fully understand the implication before running the COMMIT or ROLLBACK commands.
APPLY
APPLY COMMIT TRANSACTION. Force commit of the specified transaction on APPLY. Use List transactions first to see what transactions are currently pending on APPLY.
...
Ensure you fully understand the implication before running this command.
EXIT, QUIT
Exits dbvrep.
WAIT
Waits until killed.
QUERYMODE
FILE: Parses given online/archive redo, generates PLOG and parses the PLOG. (Note that to generate traces etc. during query mode, you still have to set the corresponding configuration variables.)
In query mode, incomplete 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 database.
PLOG: Parses selected PLOG (usually a conflict error PLOG) – either by specifying a filename, or by conflict id.
In query mode, incomplete 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 database to query metadata if using conflict id.
No changes are actually applied to APPLY database.
CONFLICT: If error PLOGS are enabled (disabled by default), tries to get error PLOG for given conflict id and run QUERYMODE PLOG on that file.
COMMENT
Ignored. Just a comment, useful in scripts.
...
If the # character is used, it must be |
...
preceded by a space (" #"). If there is no space, it is considered part of the command, thus tables with # in their name can be used (e.g. "PREPARE TABLE SCOTT.TEST#"). |
SETUP WIZARD
Starts the setup wizard.
VERSION
Shows Dbvisit Replicate version. Can be also invoked by --V switch.
PREPARE
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 and MINE and instructs them to replicate the schema/table. If OFFLINE is used, APPLY/MINE will pick the new tables on the next start. Use OFFLINE if the APPLY and MINE are not running, as some network configurations may cause long timeouts while PREPARE tries to connect to the APPLY/MINE. By default, DDL replication is enabled. Use NODDL to disable it (mandatory for non-Oracle databases). RENAME clause makes the replication to APPLY the changes to the given schema/table at APPLY. 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. |
UNPREPARE
Used for removing tables or schemas from the replication.
...
If OFFLINE is used, APPLY/MINE will pick the change on the next start. Use OFFLINE if the APPLY and MINE are not running, as some network configurations may cause long timeouts while PREPARE tries to connect to the APPLY/MINE.
REPREPARE
Used for adding tables or schemas to the replication.
Reprepare does UNPREPARE and PREPARE in a single step to save typing. It also understands that there is no need to drop supplemental logging in the unprepare phase as prepare would create it again.
Anchor |
---|
| EXCLUDE COLUMN |
---|
| EXCLUDE COLUMN |
---|
|
EXCLUDE COLUMN
Set a column to be excluded in mining. Use this if you don't want to replicate a specific column(s) in a table. Use the % character as a wildcard. Underscore (_) is not treated as a special character.
Note that PREPARE automatically includes all columns and EXCLUDE thus must follow the prepare. The table must already be PREPARED for the column to be excluded.
...
Entering this command in the console requires a restart of the MINE process.
Anchor |
---|
| INCLUDE COLUMN |
---|
| INCLUDE COLUMN |
---|
|
INCLUDE COLUMN
This command relates to the EXCLUDE COLUMN command and can be used to:
...
This command requires a restart of the MINE process.
Anchor |
---|
| EXCLUDE CREATE TABLE |
---|
| EXCLUDE CREATE TABLE |
---|
|
EXCLUDE CREATE TABLE
Maintain the list of tables/table name patters that should not be automatically prepared when created on source, although DDL is enabled and whole schema is prepared. The main use case for this feature is to skip various temporary tables that should not be replicated. Use the % character as a wildcard. Underscore (_) is not treated as a special character.
...
The MINE process has to be restarted for this to take effect.
Anchor |
---|
| INCLUDE CREATE TABLE |
---|
| INCLUDE CREATE TABLE |
---|
|
INCLUDE CREATE TABLE
This command relates to the EXCLUDE CREATE TABLE command and can be used in two ways:
...
The MINE process has to be restarted for this to take effect.
FILTER
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, APPLY/MINE will pick the change on the next start. Use OFFLINE if the APPLY and MINE are not running, as some network configurations may cause long timeouts while PREPARE tries to connect to the APPLY/MINE.
CDCAUDITConfigure CDC/Aduit for an already prepared table/schema. The usual way how to configure this is using Setup wizard (which in turn uses this very command).
This command sets this feature for insert/update/delete operations, sets the prefix for new/old value columns and configures additionall added columns (operation type, transaction, session audit information).
LICENSE
Shows current license, as set by LICENSE_KEY variable.
The optional FULL keyword specifies the verbosity of the command:
No Format |
---|
|
dbvrep> license show
Licensed for , 30-day license (trial license). dbvrep> *license show full
Product: Dbvisit Replicate
Allowed versions:1.0-2.63
Key-version: 1
License type: RS1S
Customer id: 1.0 (trial license)
Production: yes
License-type: server
Name: *
Expiry: 30 days
CPU count mine: 0
CPU count apply: 0
Row-count limit: unlimited
Enabled options: rac, fetcher, partitions, onetomany, cascade, 2way, ddl, asm, mysql, mssql, oracle, snmp, mail_notify
Licensed for *, 30-day license (trial license). |
CHOOSE
Choose process to work with when issuing commands or displaying settings. This can be done by specifying the process name or by means of source and target databases.
By default all commands work with the default processes MINE and APPLY. This command is useful when working with 2-way replication where there are multiple processes such as MINE, APPLY, MINE1 and APPLY1.
Note |
---|
Note that the CHOOSE REPLICATON command selects all processes for the indicated replication. |
Example:
No Format |
---|
CHOOSE REPLICATION MINE1 |
The above command will choose the replication pair that is associated with MINE1. Typically this is MINE1->APPLY1
In contrast, CHOOSE PROCESS selects only the selected process (not the pair) and is generally not recommended. It can be used in special cases such as one to many replications to specify a specific process.
PAUSE
Asks the given process to pause.
Anchor |
---|
| RESUME process |
---|
| RESUME process |
---|
|
RESUME process_name
Asks the given process to resume.
Anchor |
---|
| START process |
---|
| START process |
---|
|
START process_name
Starts process.
Anchor |
---|
| SHUTDOWN process |
---|
| SHUTDOWN process |
---|
|
SHUTDOWN process_name
Connect to MINE/APPLY/FETCHER and request it to shut down.
ALL means requesting all processes defined in DDC to shut down.
DUMP
Request MINE/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).
CLEAR
PROGRESS: Asks APPLY to reset conflict counters.
CONFLICT: Asks MINE and APPLY to reset progress counters.
Anchor |
---|
| SET_CONFLICT_HANDLERS |
---|
| SET_CONFLICT_HANDLERS |
---|
|
SET_CONFLICT_HANDLERS
Gets object id as of current MINE progress and sets conflict handlers for this table (schema.name refers to current table name at MINE).
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.
Anchor |
---|
| SHOW_CONFLICT_HANDLERS |
---|
| SHOW_CONFLICT_HANDLERS |
---|
|
SHOW_CONFLICT_HANDLERS
Shows current setting of conflict handlers for given table (schema.name refers to table at MINE).
RESOLVE
Contacts APPLY and resolves current conflict.
CLEAR SCREEN, CLS
Clear console screen.
DDL
Create DDL for create or drop given table or all tables in a given schema. The output can be to screen (print), to file (spool) or directly executed (replicate). This is used if ddl_run is used as instantiation type in setup wizard.
NOTIFY
Sends sample email/SNMP trap – use to test your SMTP/SNMP configuration.
Anchor |
---|
| CREATE SERVICE process |
---|
| CREATE SERVICE process |
---|
|
CREATE SERVICE process
Create Windows service for given process.
Anchor |
---|
| DELETE SERVICE process |
---|
| DELETE SERVICE process |
---|
|
DELETE SERVICE process
Delete Windows service for given process.
Anchor |
---|
| START_SERVICE process |
---|
| START_SERVICE process |
---|
|
START_SERVICE process
Start Windows service for given process. Same as Windows command NET START.
Anchor |
---|
| CREATE WINDOWS SHORTCUT |
---|
| CREATE WINDOWS SHORTCUT |
---|
|
CREATE WINDOWS SHORTCUT
Create a shortcut to start-console.bat and place it on the Desktop. (Windows only.)
Anchor |
---|
| CREATE DDCDB/DDCFILE |
---|
| CREATE DDCDB/DDCFILE |
---|
|
CREATE DDCDB/DDCFILE
Load DDC from file to database or vice versa. This is done automatically during *-all.sh/.bat (from file to database) and then on every process start (from database to ddc_backup directory).
Anchor |
---|
| ENCRYPT password |
---|
| ENCRYPT password |
---|
|
ENCRYPT password
Encrypts the password, so the value can be used in the DDC file, where all passwords are stored encrypted.
Anchor |
---|
| UPGRADE REPOSITORY |
---|
| UPGRADE REPOSITORY |
---|
|
UPGRADE REPOSITORY Upgrade the Dbvisit Replicate repository to a newer version.
Anchor |
---|
| DOWNGRADE REPOSITORY |
---|
| DOWNGRADE REPOSITORY |
---|
|
DOWNGRADE REPOSITORY Downgrade the Dbvisit Replicate repository to an older version.