Chat now with support
Chat with Support

SharePlex 11.4 - Reference Guide

About this guide Conventions used in this guide Revision History SharePlex Commands for Oracle SharePlex parameters SharePlex Commands for PostgreSQL SharePlex Parameters for PostgreSQL General SharePlex utilities Oracle Cloud Infrastructure SharePlex environment variables

SharePlex commands at a glance

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.

 

Alphabetical reference for SharePlex commands

Alphabetical Reference for SharePlex Commands

This starts the detailed reference documentation for SharePlex commands in alphabetical order.

abort config

Use the abort config command to deactivate a configuration instantly and delete all associated queues and replication processes at the same time. This command stops all replication activity for the configured datasource on the source and target systems, whether or not data in the queues has been posted. It is a forceful deactivation.

The abort config command is effective when there has been a system, configuration, or data problem and you need to prevent posting to the target system(s). Because you are deleting whatever data remains in the pipeline, the source and target instances will go out of synchronization after this command takes effect.

If any SharePlex replication process stops before or during the abort config command, the command also stops. When the process starts again, the command resumes working. This allows abort config to work even if the network is temporarily down — it remains in the queues until the connection is restored.

If there are multiple active configurations on the same source system, use the abort config command only if there are named export queues that separate the replication streams for each one. Without named export queues, SharePlex funnels all replicated data through one export queue, and an abort config command for one configuration deletes the data for all of them. To create named queues, see Chapter 5 of the SharePlex Administrator’s Guide.

Usage

Supported sources:

Oracle

Supported targets: All
Authorization level: Administrator
Issues for: source system
Related commands: deactivate config, purge config

Syntax

Basic command Remote options
abort config filename

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description
Component Description
filename 

The name of the configuration that you want to abort. Configuration names are case-sensitive.

Example:

sp_ctrl(sysA)> abort config sales

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Option Description
on host

Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA

on host:portnumber

Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA:8304

on login/password@host

Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax.

Example:sp_ctrl(sysB)>status on john/spot5489@SysA

on login/password@host:portnumber

Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

abort service

Use the abort service command to terminate a SharePlex replication process (service) immediately, whether or not that process has finished reading from, or writing to, its queues. This command is effective when you cannot wait for a process to stop gracefully, or in unusual circumstances when a process will not shut down when you issue the stop command.

This command does not affect replicated data. The data remains safely in the queues, and SharePlex resumes normal processing when the process is started again.

A process aborted with the abort service command remains stopped even if SharePlex is shut down and re-started. Only the start command can start it again.

The abort service command provides options with which you can abort a process for any (or all) systems, or for a named queue, without affecting replication for other routes.

Usage

Supported sources:

Oracle

Supported targets: All
Authorization level: Operator (2); Administrator (1) to abort Capture
Issues for:

abort service for Capture, Read and Export are issued for the source system.

abort service for Import and Post are issued for the target system.

Related commands: start, stop

Syntax

Basic command Command options Remote options
abort service service

[to host]

[from host]

[for datasource]

[for datasource-datadest]

[queue queuename]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description
Component Description
service

Required. The SharePlex replication process you want to abort. Valid values are:

capture

read

export

import

post

to host

This option aborts Export to a designated system, while allowing Export to other systems to continue.

  • host is the name of the target system.

Example:

sp_ctrl(sysA)> abort service export to sysB

In this example, Export is aborted from sysA to sysB, but other Export processes from sysA to other target systems will continue.

from host

This option aborts Import from a designated system, while allowing Import from other systems to continue.

• host is the name of the source system.

Example:

sp_ctrl(sysD)> abort service import from sysC

In this example, Import from sys C is aborted on sysD, but other Import processes on sysD from other source systems will continue.

for datasource

This option aborts Capture or Read for a designated datasource, but other replicating datasources on the same system are unaffected.

  • datasource is expressed as o.SID, where SID is the ORACLE_SID of the source Oracle instance.

Example:

sp_ctrl(sysA)> abort service read for o.oraA

In this example, Read is aborted on sysA for instance oraA, but other Read processes for other instances on sysA will continue.

for datasource-datadest

This option aborts Post for a designated source SID-target SID data stream, while allowing other Post activities to continue.

  • datasource is expressed as o.SID, where SID is the ORACLE_SID of the source Oracle instance.
  • datadest is expressed as o.SID, where SID is the ORACLE_SID of the target Oracle instance.

Example:

sp_ctrl(sysC)> abort service post for o.oraA-o.oraC

In this example, Post is aborted on sysC for instance oraA replicating to oraC, but other Post processes on sysC will continue.

queue queuename

This option aborts the Export, Import or Post process associated with a named queue, while allowing replication through other named queues to continue.

  • queuename is the name of the queue.

Example:

sp_ctrl(sysA)> abort service export queue QA

In this example, Export of data through named export queue QA is aborted on sysA, but Export will continue for data assigned to all other named queues.

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Option Description
on host

Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA

on host:portnumber

Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA:8304

on login/password@host

Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax.

Example:sp_ctrl(sysB)>status on john/spot5489@SysA

on login/password@host:portnumber

Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating