The SharePlex commands configure, start, stop, control, and monitor the replication process. SharePlex commands are issued through the sp_ctrl interface.
The SharePlex commands configure, start, stop, control, and monitor the replication process. SharePlex commands are issued through the sp_ctrl interface.
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.
The configuration commands control all aspects of managing SharePlex configuration files.
| 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. |
| 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. |
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.
| Command | Auth. level | Description |
|---|---|---|
| 3 | Displays brief or detailed statistics for the Capture process for use in tuning and problem solving. | |
| 3 | Displays brief or detailed statistics for the Post process for use in tuning and problem solving. | |
| 3 | Displays current status and history for compare and repair commands. | |
| 3 | Displays the status and results of the compare using and compare commands. | |
| 2 | Disaplys the status and results of the repair and repair using commands. |
The partitioning commands create, manage, and display the partition schemes and row partitions that are being used for horizontally partitioned replication.
| 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. |
The synchronization commands control aspects of data synchronization.
List of synchronization commands
| Command | Authorization level | Supported targets | Description |
|---|---|---|---|
| Compare / compare using | 2 | PostgreSQL | Compares the contents of source and target tables to verify synchronization. |
| Cancel | 2 | PostgreSQL | Cancels a running compare or repair command job. |
| Repair / repair using | 2 | PostgreSQL | Repairs out-of-sync rows in target tables to bring source and targets back into synchronization. |
| flush | 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 | 1 | All | Synchronizes the results of a backup or copy applied to the target system with user transactions from the source system. |
The maintenance commands control command displays and files.
| Command | Authorization level | Supported targets | Description |
|---|---|---|---|
| Clear History | 2 | PostgreSQL | Removes the job information and source logs for runs of the compare, compare using, and repair commands. |
| Clear Status | 2 | PostgreSQL | Removes warning messages from the Status Database. |
This starts the detailed reference documentation for SharePlex commands in alphabetical order.
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.
| Supported source: |
|
| Supported targets: | PostgreSQL, Oracle, SQL Server, Kafka, Amazon RDS for PostgreSQL, Amazon Aurora for PostgreSQL, Azure Database for PostgreSQL Flexible Server, and Google Cloud SQL for PostgreSQL |
| Issues for: | source and target systems |
| Related commands: | deactivate config, purge config |
| Basic command |
|---|
| abort config filename |
| 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 |
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. 利用規約 プライバシー Cookie Preference Center