SharePlex Commands at a Glance

This section provides an overview of all SharePlex commands, grouped according to the processes or functions they control.

For more information about SharePlex command authorization levels and security groups, see the SharePlex Administration Guide.

Configuration Commands

The configuration commands control all aspects of managing SharePlex configuration files.

List of configuration commands

Command	Auth. Level	Supported targets	Description
Abort config	1	All	Immediately terminates replication for the designated configuration file whether or not data has posted. Deactivates the configuration and deletes queues and processes.
Activate config	1	All	Begins replication of the data specified in a configuration.
Copy config	2	All	Duplicates a configuration to edit and save as a new file.
Create config	2	All	Creates a new configuration file in which you enter information about objects to be replicated.
Deactivate config	1	All	Gracefully terminates replication of the data specified in a configuration, allowing data in the queues to be posted to the target database before the queues are deleted.
Edit config	2	All	Modifies an existing configuration file using the default text editor.
List config	3	All	Displays all of the configuration files on a source system, both active and inactive.
Purge config	1	All	Removes data from queues generated by an active configuration, but does not deactivate the configuration or remove the queues themselves.
Remove config	2	All	Deletes a configuration file from the system permanently.
Rename config	2	All	Assigns a different name to a configuration file.
Verify Config	3	All	Verifies that the objects in a configuration are valid and that the configuration is structured properly to ensure successful activation and replication.
View Config	3	All	Displays the contents of a configuration file.

Connect commands

The connect commands control connections made to replication systems through the sp_ctrl interface.

List of connect commands

Command	Auth. level	Supported targets	Description
Connection	2	All	Specifies connection settings to connect to a source or target database.
Exit command	3	All	Exits the sp_ctrl command-line session and disconnects the TCP/IP link. (Used interchangeably with quit.)
Host command	3	All	sets a default machine for the current sp_ctrl connection.
Port command	3	All	Sets a default sp_cop port number for the current sp_ctrl session.
Quit command	3	All	Exits the sp_ctrl command-line session and disconnects the TCP/IP link. (Used interchangeably with exit.)

Encryption commands

The encryption commands enable you to encrypt data that is being sent across the network.

List of encryption commands

Command	Auth. level	Supported targets	Description
Create encryption key	2	All	Creates an encryption key to encrypt data across the network.
Reset encryption key	2	All	Removes an encryption key.
Set encryption key	2	All	Sets an encryption key for an Export-Import pair.

Information commands

The information commands provide information about the replication environment. Use these commands when you are trying to resolve a replication problem or you want to view certain process conditions.

List of information commands

Command	Auth. level	Description
Append status	3	Displays status and results of the append using and append commands.
Copy status	3	Displays status and results of the copy using and copy commands.
Compare status	3	Displays the status and results of the compare using and compare commands.
lstatus command	3	Displays detailed information about the state of SharePlex replication.
Job status command	3	Displays current status and history for append, compare, copy and repair commands.
Orainfo command	3	Displays the Oracle database information.
Qstatus command	3	Displays the state of the capture, export and post queues.
Repair status	2	Disaplys the status and results of the repair and repair using commands.
Report	3	Displays append, compare, copy and/or repair history for a table.
Show command	3	Displays the source and destination of the data being processed by each replication process on a system, and displays the status of each process.
Use of Show Capture	3	Displays brief or detailed statistics for the Capture process for use in tuning and problem solving.
Show Config	3	Displays properties of the active configuration.
Show Export	3	Displays the number of messages sent to the target system(s).
Show Import	3	Displays the number of messages received from the source system(s).
Show Log	3	Displays the Even Log, Command Log, Verify Log, Trace Log, or a process log.
Show Post	3	Displays brief or detailed statistics for the Post process for use in tuning and problem solving.
Show Read	3	Displays brief or detailed statistics for the Read process for use in tuning and problem solving.
Show SQL	3	Displays the current or last SQL statement processed by the Post process.
Show Statusdb	3	Displays the Status Database, which contains records of important replication events.
Show Sync	3	Displays information about out-of-sync conditions.
Status	3	Displays an overview of the state of SharePlex replication.

 

 

Maintenance commands

The maintenance commands control command displays and files.

List of maintenance commands

Command	Auth. level	Supported targets	Description
Clear history	2	Oracle	Removes the job information and source logs for runs of the compare, compare using, repair, copy and append commands.
Clear status	2	All	Removes warning messages from the Status Database.
Remove log	3	Oracle	Removes old compare reports and logs from the system.
Set log	3	All	Sets the default values for the show log command.
Truncate Log	1	All	Clears the records from the Event Log, with the exception of logged commands.

Parameter commands

The parameter commands control the environment parameters that define how SharePlex operates.

List of parameter commands

Command	Auth. level	Supported targets	Description
List param	3	All	Displays a list of SharePlex parameters withcurrent and default values and set-at points.
Reset param	1	All	Restores the value of a SharePlex parameter to the default setting.
Set param	1	All	Changes the value of a SharePlex parameter on a global basis or for a specified replication process.

Partitioning commands

The partitioning commands create, manage, and display the partition schemes and row partitions that are being used for horizontally partitioned replication.

List of partitioning commands

Command	Auth. level	Supported targets	Description
Add partition	2	All	Creates partition schemes and row partitions.
Drop partition	2	All	Removes a row partition from a partition scheme.
Drop partition scheme	2	All	Removes a partition scheme.
Modify partition	2	All	Modifies a row partition of a partition scheme.
View Partitions	3	All	Shows existing partition schemes and their row partition specifications.

Properties commands

The properties commands display information about a user’s authorization level, the local system, and the local SharePlex installation.

List of properties commands

Command	Auth. level	Supported targets	Description
Authlevel	3	All	Displays the SharePlex authorization level of a user who logs into sp_ctl.
Hostinfo command	3	All	Displays a machine's name and operating system.
Version	3	All	Displays the version of SharePlex installed on a machine.

Route commands

The route commands enable you to delete a queue or process left over from a deprecated replication route.

Command	Auth. level	Supported targets	Description
Delete capture queue	2	All	Deletes a capture queue.
Delete export process	2	All	Deletes an export process.
Delete export queue	2	All	Deletes an export queue.
Delete post queue	2	All	Deletes a post queue.

Run commands

The run commands control the operation of SharePlex with options for starting and stopping processes, starting and shutting down replication, re-synchronizing data, and enabling/disabling confirmation messages.

List of run commands

Command	Auth. level	Supported targets	Description
Abort service	2 or 1	All	Stops one or all replication processes immediately, without finishing processing. (Level 1 required for Capture.)
Clear status	3	All	Removes warning messages from the Status Database.
Shutdown	1	All	Shuts down sp_cop and all replication processes.
Start	2 or 1	All	Starts a replication process. (Level 1 required for Capture.)
Startup	1	All	Use the startup command to start all processes at once.
Stop	2 or 1	All	Stops a replication process gracefully after it is finished reading from or writing to its queues. (Level 1 required for Capture.)

Synchronization commands

The synchronization commands control aspects of data synchronization.

List of synchronization commands

Command	Auth. level	Supported targets	Description
Cancel	2	Oracle	Cancels a running compare, repair, copy or append command job.
Compare / compare using	2	Oracle	Compares the contents of source and target tables to verify synchronization.
Copy / append	2	Oracle	Uses the Oracle Export/Import utility to allow users to set-up replication and/or (re)synchronize tables already in replication.
Disable jobs / enable jobs	2	Oracle	Control whether the synchronization commands are allowed to run on a secondary system in a high-availability or peer-to-peer configuration.
Flush command	2	All	Puts a marker in the data stream to establish a point of synchronization between the source and target data, then stops the Post process at that point.
Reconcile command	1	All	Synchronizes the results of a backup or copy applied to the target system with user transactions from the source system.
Repair / repair using	2	Oracle	Repairs out-of-sync rows in target tables to bring source and targets back into synchronization.

Target configuration command

The target configuration commands configure the Post process to support heterogeneous replication.

Target command

Command	Auth. level	Supported targets	Description
Target	2	All	The properties stored in the target configuration control how Post processes, formats, and outputs replicated data.
Typemap	2	All	Shows how source data types are mapped to the target database.

Miscellaneous commands

These miscellaneous commands provide additional controls for using SharePlex.

List of miscellaneous commands

Command	Auth. level	Supported targets	Description
Target	2	All	The properties stored in the target configuration control how Post processes, formats, and outputs replicated data.
Typemap	2	All	Shows how source data types are mapped to the target database.
Command	Auth. level	Supported targets	Description
Target	2	All	The properties stored in the target configuration control how Post processes, formats, and outputs replicated data.
Typemap	2	All	Shows how source data types are mapped to the target database.
Command	Auth. level	Supported targets	Description
Target	2	All	The properties stored in the target configuration control how Post processes, formats, and outputs replicated data.