This starts the detailed reference documentation for SharePlex commands in alphabetical order.
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: |
PostgreSQL |
| Supported targets: | PostgreSQL, Oracle, SQL Server, and Kafka |
| 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 |
Use the activate config command to activate a configuration. Replication begins immediately as soon as the activation process is complete.
The activation process reads the configuration file, from which it gets all of the information needed for SharePlex to:
The process that sp_cop calls to activate a configuration is sp_tconf.
Before you activate a configuration, use the verify config command to confirm that basic requirements for successful activation and replication have been satisfied. The command alerts you to potential problems that can cause the activation to fail.
SharePlex activates objects according to their object ID, not their order in the configuration file, so there is no way to predict the order of activation.
To view the results of activation:
Issue the show config command
Many things can cause the activation of a table or the entire configuration to fail. For example, if one or more components in the configuration file were entered incorrectly, activation of the affected objects fails.
If you did not issue the verify config command before you activated, run it now, and correct any problems that it finds. Then, try activating again.
| Supported sources: | PostgreSQL (all options) |
| Supported targets: | PostgreSQL, Oracle, SQL Server, and Kafka |
| Authorization level: | Administrator (1) |
| Issues for: | source system |
| Related commands: | list config, verify config |
| Basic command |
|---|
| activate config filename |
| Component | Description |
|---|---|
| filename |
Required. The name of the configuration that you want to activate. Configuration names are case-sensitive. Example: sp_ctrl(sysA)>activate config sales |
|
Important! Steps to follow when performing the alter table, add/drop column, or add/drop partitionoperations which is part of ongoing replication. Cautions:
Follow the below steps:
|
Use the add partition command to add a row partition to a partition scheme when configuring horizontally partitioned replication. Issue an add partition command for each row partition that you want to create.
This command captures all of the information required to create the partition, including the following required components:
Reactivate the configuration file if the command affects a table that is already being replicated. SharePlex will only lock tables for which there are configuration changes.
For more information about how to configure horizontally partitioned replication, see the SharePlex Administration Guide.
| Supported sources: | PostgreSQL |
| Supported targets: | PostgreSQL, Oracle, SQL Server, and Kafka |
| Issues on: | source system |
| Related commands: | modify partition, drop partition, drop partition scheme, view partitions |
| Basic command | Command options |
|---|---|
|
add partition toscheme_name set {condition = column_condition | route = routing_map |
[and name =partition_name] [and tablename =target_table] [and description =description] |
| Component | Description |
|---|---|
| to scheme_name |
to is a required keyword indicating the row partition is being added to scheme_name. scheme_name is the name of the partition scheme. The partition scheme is created by the first add partition command that you issue, which will also specify the first set of rows to partition. If you are making heavy use of horizontal partitioning, it may help to establish naming conventions for your partition schemes. |
|
set |
Required keyword that starts the definition of the row partition. |
| condition = column_condition |
Creates a row partition based on a column condition. The condition must be in quotes. Use standard WHERE conditional syntax such as ((region_id = West) and region_id is not null). |
| route = routing_map |
The route for this partition. This can be one of the following: Partition based on a column condition: Specify any standard SharePlex routing map, for example: sysB@r.dbname or sysB:q1@r.dbname or sysB@r.testdb+sysC@r.testdb (compound routing map). To route a partition to multiple target tables that have different names, do the following:
|
| name = name |
(Recommended) A short name for this partition. This option is only useful for partitions based on column conditions. A name eliminates the need to type out long column conditions in the event that you need to modify or drop the partition in the future. |
| tablename = owner.table |
(Optional) Use this option when there are multiple target tables and one or more have different names. Issue a separate add partition command for each name. The table name must be fully qualified. If case-sensitive, the name must be specified in quotes. Example: add partition to scheme1 set name = p1 and condition = "C1 > 200" and route = sysb:p1@r.dbname and tablename = myschema.mytable |
| description = description | (Optional) Description of this partition. |
Route different sets of rows through different post queues:
sp_ctrl> add partition to scheme1 set name = q1 and condition = "C1 >= 200" and route = sysb:q1@r.dbname
sp_ctrl> add partition to scheme1 set name = q2 and condition = "C1 < 200" and route = sysb:q2@r.dbname
Route different sets of rows to different target systems and different table names from the source:
sp_ctrl> add partition to scheme1 set name = east and condition = "area = east" and route = sys1e@r.dbname and tablename = schema1.targ
sp_ctrl> add partition to scheme1 set name = west and condition = "area = west" and route = sys2w@r.dbname and tablename = schema2.targ
© ALL RIGHTS RESERVED. Feedback 使用条款 隐私 Cookie Preference Center