API and Internal Commands

All keywords are case-insensitive.

These internal commands form part of the regular Dbvisit Replicate commands. Regular Dbvisit Replicate commands maybe made up of several internal commands.

Use these internal commands with caution. 

If the command works directly with an MINE, APPLY or FETCHER process (not by process name), choose the process by using the “choose” command.
The word ENGINE and PROCESS can be used interchangeably.


CommandDescription
CREATE SERVICE process_name
Create Windows service for the process. (must be run as an administrator)
DELETE SERVICE process_name
Delete Windows service for the process. (must be run as an administrator)
ENGINE CLEAR SCN
Forget the SCN remembered for single-scn. Finish the instantiation (some operations on dictionary are done in batches instead for each table, this command finishes all pending work needed).
ENGINE DDL_CHECK ddlopid ddltext
Check whether the given DDL text would be replicated with DDL replication. Ddlopid is Oracle DDL operation id.
ENGINE DUMP ALL
Runs both ENGINE DUMP MESSAGES and ENGINE DUMP MEMORY_ACCOUNTING commands. This command can be also invoked by sending SIGUSR2 (kill -12) to the process (not available on Windows).  This command should NOT be run from the console. This is an internal only command. Users should use the DUMP MINE/APPLY ALL command instead.
ENGINE DUMP MEMORY_ACCOUNTING
Dumps memory accounting info – number of allocations, memory used, etc.

Each allocation point (=malloc call in C code) has it’s own id and this is equal to error code that is raised if the malloc fails – so refer to error code list to find out where is the memory allocated. This command should not be used. Users should use the DUMP MINE/APPLY MEMORY_ACCOUNTING command.

ENGINE DUMP MESSAGES

Dumps buffer of debug messages that were suppressed by DEBUG_LEVEL setting. (Dumps about last 400kb.) This command should not be used. Users should use the DUMP MINE/APPLY MESSSAGES command.
ENGINE ENCRYPT string

Encrypts/decrypts given string. To be used when setting passwords.
ENGINE LOCK RELEASE ALL
 Runs both ENGINE LOCK RELEASE LOCKS and ENGINE CLEAR SCN. This is kept for compatibility only (used before 2.3.14, when the locks were released only after PREPARE statements were executed and no caching of PREPARE statements was used).
ENGINE LOCK RELEASE LOCKS
 Release the locks held.
ENGINE LOCK {TABLES|SCHEMAS} list of tables
Lock the listed tables/schemas in share exclusive mode and remember the SCN. This is used for single-scn instantiation.
ENGINE MINE RESET TO PLOG sequence
Force MINE to forget generated PLOGS (after sequence or all of them). MINE will thus on next start go back in history to parse the redo logs again. Run when MINE is stopped.
ENGINE PREPARE_DP SETUP CLEAR
Forget all tables for next instantiation script.
DIRECTORY directory FILE file 
USERID user/pass@db
Write data load script for network import (data pump).
ENGINE PREPARE_DP WRITE DP_EXP
DIRECTORY directory FILE file 
MINE_USERID user/pass@db APPLY_USERID user/pass@db
Write data load script for file export/import (data pump).
ENGINE PREPARE_DP WRITE EXP FILE file MINE_USERID
user/pass@db APPLY_USERID user/pass@db
Write data load script for file export/import (pre-10g export/import).
ENGINE PREPARE_DP WRITE DDL_FILE FILE file USERID user/pass@db
example: ENGINE PREPARE_DP WRITE DDL_FILE FILE test_ddl.sql USERID demo/demo@demosrc

Write data load script – ddl create (just DDL, so it actually does not load the data).

  • file will be the name of the file created.
  • user/pass@db (source database schema/password@sourcedb)
ENGINE SETUP {MINE|APPLY} CREATE DICTIONARY
Create MINE|APPLY dictionary in database (structure only).
ENGINE SETUP {MINE|APPLY} LOAD DICTIONARY
Create MINE|APPLY dictionary in database (data only).
ENGINE SETUP {MINE|APPLY} DROP DICTIONARY
Drops MINE|APPLY dictionary in database.
ENGINE SETUP MINE DELETE DICTIONARY
Delete data in dictionary in database, just for current DDC_ID.
ENGINE SETUP MINE SCHEMA schema MINE_DDL
Enables DDL replication for the given schema.
  • YES
  • NO 
ENGINE SETUP MINE TABLE schema.table MINE_DDL
Enables DDL replication for the given table.
  • YES
  • NO 
ENGINE SETUP MINE SCHEMA schema MINE_PLSQL
Enables PL/SQL for the given schema. PL/SQL does not have a table option.
  • YES
  • NO 
ENGINE SETUP PAIR MINE AND APPLY
Register target database in MINE metadata, must be executed after you load/create MINE and APPLY dictionary.
ENGINE SUPPLEMENTAL LOGGING SCHEMA 
schema {ENABLE|DISABLE} PRIMARY KEY

Enables/disables supplemental logging on all table in the schema for their primary key. This is mandatory on source for replicate tables. (This is done automatically by PREPARE commands.)

It is also mandatory to enable supplemental logging at database level. This is done automatically during ENGINE SETUP MINE LOAD DICTIONARY.

ENGINE SUPPLEMENTAL LOGGING TABLE  schema.table_name {ENABLE|DISABLE} PRIMARY KEY

Enables/disables supplemental logging on table for its primary key. This is mandatory on source for replicate tables. (This is done automatically by PREPARE commands.)

It is also mandatory to enable supplemental logging at database level. This is done automatically during ENGINE SETUP MINE LOAD DICTIONARY.

ENGINE SWITCH_REDOLOG
Performs a log switch on the source database. This command will not work if you are using a FETCHER process.
ENGINE TEST_CONNECTION_ORACLE
user/pass@db 
Tests to make sure you have a valid connection. See Verifying Oracle connection for more details.
ENGINE TEST_CONNECTION_ORACLE_AS_SYSDBA
user/pass@db as SYSDBA
Tests to make sure you have a valid connection as SYSDBA
ENGINE RESYNC COUNTERS FOR TABLE schema.table {OFFLINE}
Sets the counters on the given tables so that they are the same.
START SERVICE process_name
Start Windows service for the process (=equal to pressing the start button in Windows Services console).
PROCESS CLEAR SCN
Forget the SCN remembered for single-scn. Finish the instantiation (some operations on dictionary are done in batches instead for each table, this command finishes all pending work needed).
PROCESS DDL_CHECK ddlopid ddltext
Check whether the given DDL text would be replicated with DDL replication. Ddlopid is Oracle DDL operation id.
PROCESS DUMP ALL
run as:
DUMP FETCHER|MINE|APPLY ALL
 Runs both PROCESS DUMP MESSAGES and PROCESS DUMP MEMORY_ACCOUNTING commands. This command can be also invoked by sending SIGUSR2 (kill -12) to the process (not available on Windows). 
PROCESS DUMP MEMORY_ACCOUNTING
run as:
DUMP FETCHER|MINE|APPLY MEMORY_ACCOUNTING
Dumps memory accounting info – number of allocations, memory used, etc.

Each allocation point (=malloc call in C code) has it’s own id and this is equal to error code that is raised if the malloc fails – so refer to error code list to find out where is the memory allocated.

PROCESS DUMP MESSAGES
run as:
DUMP FETCHER|MINE|APPLY MESSAGES

Dumps buffer of debug messages that were suppressed by DEBUG_LEVEL setting. (Dumps about last 400kB.)
PROCESS ENCRYPT string

Encrypts/decrypts given string. To be used when setting passwords.
PROCESS LOCK RELEASE ALL
 Runs both PROCESS LOCK RELEASE LOCKS and PROCESS CLEAR SCN. This is kept for compatibility only (used before 2.3.14, when the locks were released only after PREPARE statements were executed and no caching of PREPARE statements was used).
PROCESS LOCK RELEASE LOCKS
 Release the locks held.
PROCESS LOCK {TABLES|SCHEMAS} list of tables
Lock the listed tables/schemas in share exclusive mode and remember the SCN. This is used for single-scn instantiation.
PROCESS MINE RESET TO PLOG sequence
Force MINE to forget generated PLOGS (after sequence or all of them). MINE will thus on next start go back in history to parse the redo logs again. Run when MINE is stopped.
PROCESS PREPARE_DP SETUP CLEAR
Forget all tables for next instantiation script.
DIRECTORY directory FILE file 
DBLINK dblink 
USERID user/pass@db
Write data load script for network import (data pump).
PROCESS PREPARE_DP WRITE DP_EXP
DIRECTORY directory FILE file 
MINE_USERID user/pass@db APPLY_USERID user/pass@db
Write data load script for file export/import (data pump).
PROCESS PREPARE_DP WRITE EXP FILE file MINE_USERID
user/pass@db APPLY_USERID user/pass@db
Write data load script for file export/import (pre-10g export/import).
PROCESS PREPARE_DP WRITE DDL_FILE FILE file USERID user/pass@db
Write data load script – ddl create (just DDL, so it actually does not load the data).
PROCESS SETUP {MINE|APPLY} CREATE DICTIONARY
Create MINE|APPLY dictionary in database (structure only).
PROCESS SETUP {MINE|APPLY} LOAD DICTIONARY
Create MINE|APPLY dictionary in database (data only).
PROCESS SETUP {MINE|APPLY} DROP DICTIONARY
Drops MINE|APPLY dictionary in database.
PROCESS SETUP MINE DELETE DICTIONARY
Delete data in dictionary in database, just for current DDC_ID.
PROCESS SETUP MINE SCHEMA schema MINE_DDL
Enables DDL replication for the given schema.
  • YES
  • NO 
 
PROCESS SETUP MINE TABLE schema.table MINE_DDL
 Enables DDL replication for the given table.
  • YES
  • NO 
PROCESS SETUP MINE SCHEMA schema MINE_PLSQL
Enables PL/SQL for the given schema. PL/SQL does not have a table option.
  • YES
  • NO 
PROCESS SETUP PAIR MINE AND APPLY
Register target database in MINE metadata, must be executed after you load/create MINE and APPLY dictionary.
PROCESS SUPPLEMENTAL LOGGING SCHEMA 
schema {ENABLE|DISABLE} PRIMARY KEY

Enables/disables supplemental logging on all table in the schema for their primary key. This is mandatory on source for replicate tables. (This is done automatically by PREPARE commands.)

It is also mandatory to enable supplemental logging at database level. This is done automatically during PROCESS SETUP MINE LOAD DICTIONARY.

PROCESS SUPPLEMENTAL LOGGING TABLE  schema.table_name {ENABLE|DISABLE} PRIMARY KEY

Enables/disables supplemental logging on table for its primary key. This is mandatory on source for replicate tables. (This is done automatically by PREPARE commands.)

It is also mandatory to enable supplemental logging at database level. This is done automatically during PROCESS SETUP MINE LOAD DICTIONARY.

PROCESS SWITCH_REDOLOG
Performs a log switch on the source database. This command will not work if you are using a FETCHER process.
PROCESS TEST_CONNECTION_ORACLE
user/pass@db 
Tests to make sure you have a valid connection.
PROCESS TEST_CONNECTION_ORACLE_AS_SYSDBA
user/pass@db AS SYSDBA
Tests to make sure you have a valid connection as SYSDBA
PROCESS RESYNC COUNTERS FOR TABLE schema.table {OFFLINE}
Sets the counters on the given tables so that they are the same. This ensures that the Mine counter matches the Apply counter for the given table.