The following instructions show you how to build a routing map based on where you want to send the source data. A routing map sends replicated data to the correct target on the correct target system, or systems.
For details about the components of these configurations, see:
Database specifications in a configuration file
Target specifications in a configuration file
Routing to one target
A simple routing map sends replicated data from one source object to one target object.
| datasource_specification |
| src_owner.table |
tgt_owner.table2 |
host2[@database_specification] |
| src_owner.table |
tgt_owner.table3 |
host3[@database_specification] |
Routing to a cloud service
There are special routing requirements for database targets that are hosted by a cloud service such as EC2 and RDS on Amazon AWS, Azure SQL in Microsoft Azure, and Compute Virtual Machines in Oracle Cloud Infrastructure. Whether the service is Infrastructure as a Service (IaaS) or Platform as a Service (PaaS) makes a difference in how you install and configure SharePlex. The following explains these requirements.
IaaS targets
If replicating to a database target hosted in an IaaS cloud service, specify the full endpoint URL as the target host in the routing map.
| datasource_specification |
| src_owner.table |
tgt_owner.table2 |
endpointURL@database_specification |
| src_owner.table |
tgt_owner.table3 |
endpointURL@database_specification |
For example, the following routing map routes to a cloud database on Amazon EC2:
ec2-12-345-678-910.compute-1.amazonaws.com@o.myora
Alternately, you can map the private IP address of the cloud service to a short name in the local hosts file, and then specify that name as the host in the routing map, for example:
shortname@o.myora
PaaS targets
If replicating to a database target hosted in a PaaS cloud service, there are special installation, setup, and routing requirements. Because SharePlex cannot be installed directly on a PaaS cloud server, you must install SharePlex on either the source server or an intermediary server, from which Post connects to the target cloud database. For more information, see Installation and setup for cloud-hosted databases in the SharePlex Installation and Setup Guide.
Routing to multiple targets
A compound routing map sends replicated data from one source object to multiple target objects. It enables you to specify the source and target objects once for all routes, rather than type a separate configuration entry for each route. Only one target specification can be used in a compound routing map, so all of the target objects must be identical as follows:
NoteS:
| datasource_specification |
| src_owner.table |
tgt_owner.table |
host1[@database_specification]+host2[@database_specification][...] |
Routing between objects on the same system
You can replicate between the following:
- For Oracle, you can replicate between objects that are in the same database or in different databases on the same system. You can replicate between objects that have the same name, so long as their owners are different.
When SharePlex replicates between objects on the same system, it does not create Import and Export processes. You can force SharePlex to create Import and Export processes by using the following routing map. If you do not need the Import or Export processes, omit the host* portion of the routing map.
Configuration with replication to objects in the same or different database on the same system
| datasource_specification |
| src_owner.table |
tgt_owner.table |
host*host[@database_specification] |
Routing Limitations
- By default, SharePlex supports replication to a maximum of 19 direct target systems. That is the maximum number of processes that can read the export queue. To replicate to more than 19 targets, use named export queues. With each additional queue that you add, you can replicate to 19 additional targets. For more information, see Configure named export queues.
- Each instance of sp_cop on a system permits a maximum of 1024 different routes. This limitation includes each route that uses a different named post queue (see Configure named post queues.) If your replication strategy requires more than 1024 routes, consider using one or more intermediary systems to divide the routes among multiple sp_cop instances. For more information, see Configure replication to share or distribute data.
- By default, each sp_cop instance allows a total of 25 queues on a system. There will always be one capture queue on a source system and one post queue on a target. Therefore, you can have as many as 24 named export queues on a source system and 24 named post queues on a target system. If a system serves as both a source and target, you will have both a capture queue and a post queue. That allows you to create up to 23 named queues of either type (or a mix of both). If system memory permits, you can change the number of allowed queues by setting the SP_QUE_MAX_QUEUES parameter. See the SharePlex Reference Guide for more information about this parameter.
These are examples of basic configuration files according to each possible datasource type and target type.
Replicate from a regular Oracle Instance to a Regular Oracle Instance
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
tgt_owner.table |
host@o.SID |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to target table SCOTT.EMP2 in Oracle instance oraB on target system sysprod.
Datasource:o.oraA
SCOTT.EMP SCOTT.EMP2 sysprod@o.oraB
Replicate from Oracle to target Oracle in PaaS cloud
To replicate from an on-premises or IaaS-based Oracle source to a target Oracle database hosted in a PaaS cloud, the SharePlex target components (Import and Post) must run on the source server or on an intermediary server. Post connects through a remote connection using a TNS alias. To set up this topology, see Installation and setup for cloud-hosted databases in the SharePlex Installation and Setup Guide.
| Datasource:o.SID |
| src_owner.table |
tgt_owner.table |
source_or_intermediary_host@o.SID |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to target table SCOTT.EMP2 in the PaaS cloud Oracle instance oraB. Post runs on intermediary target system sysprod2.
datasource:o.oraA
SCOTT.EMP SCOTT.EMP2 sysprod2@o.oraB
Replicate from a regular Oracle instance to an Open Target database
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
tgt_owner.table |
host@r.database_name |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to target table Scott2.Emp2 in Open Target database mydb on target system sys2. The target table is case-sensitive.
Datasource:o.oraA
SCOTT.EMP "Scott2"."Emp2" sys2@r.mydb
Replicate from a regular Oracle instance to a file in XML or SQL format
| Datasource:o.SID |
| src_owner.table |
!file |
host |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to a file on target system sysprod.
Datasource:o.oraA
SCOTT.EMP !file sysprod
Replicate from a regular Oracle instance to a JMS queue or topic
| Datasource:o.SID |
| src_owner.table |
!jms |
host |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to a JMS queue on target system sysprod.
Datasource:o.oraA
SCOTT.EMP !jms sysprod
Replicate from a regular Oracle instance to a Kafka topic
| Datasource:o.SID |
| src_owner.table |
!kafka |
host |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to a Kafka topic using SharePlex target system sysprod.
Datasource:o.oraA
SCOTT.EMP !kafka sysprod
Replicate from Oracle to Kafka using SSL encryption
This configuration is applicable for the Kafka target.
Pre-requisites:
Configure the Kafka target with the following parameters to post data onto Kafka before starting the replication with SSL encryption
- sp_ctrl target x.kafka set kafka broker = <kafka-server-hostname>:<Kafka-server-port>
- sp_ctrl target x.kafka set kafka security.protocol = SSL
- sp_ctrl target x.kafka set kafka ssl.ca.location = <ca-cert-file-path>
- sp_ctrl target x.kafka set kafka ssl.certificate.location = <.pem-file-path>
- sp_ctrl target x.kafka set kafka ssl.key.location = <ssl-key-file-path>
- sp_ctrl target x.kafka set kafka ssl.key.password = <key-password>
- sp_ctrl target x.kafka set kafka sasl.mechanisms = PLAIN
- sp_ctrl target x.kafka set kafka api.version.request = true
Note: All the values in the <> need to be replaced with actual parameters from the Kafka producer.
Note: Before setting the target Kafka replication parameters, you need to first stop Poster, set the parameters, and then start the Poster.
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
!kafka |
host |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to the Kafka server using SharePlex target system sysprod
Datasource:o.oraA
SCOTT.EMP !kafka sysprod
Replicate from Oracle to Kafka using SASL authentication
This configuration is applicable for the Kafka target.
Pre-requisites:
Configure the Kafka target with the following parameters to post data onto Kafka before starting the replication with SASL authentication
- sp_ctrl target x.kafka set kafka api.version.request=true
- sp_ctrl target x.kafka set kafka sasl.mechanisms=PLAIN
- sp_ctrl target x.kafka set kafka sasl.username=<username>
- sp_ctrl target x.kafka set kafka sasl.password=<password>
- sp_ctrl target x.kafka set kafka security.protocol=SASL_PLAINTEXT
Note: All the values in the <> need to be replaced with actual parameters from the Kafka producer.
Note: Before setting the target Kafka replication parameters, you need to first stop Poster, set the parameters, and then start the Poster.
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
!kafka |
host |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to the Kafka server using SharePlex target system sysprod.
Datasource:o.oraA
SCOTT.EMP !kafka sysprod
Replicate from Oracle to Kafka using Kerberos authentication
This configuration is applicable for the Kafka target.
Pre-requisites:
Configure the Kafka target with the following parameters to post data onto Kafka before starting the replication with kerberos authentication
- sp_ctrl target x.kafka set kafka sasl.kerberos.keytab = <kerberos-keytab-file>
- sp_ctrl target x.kafka set kafka sasl.kerberos.kinit.cmd = <kerberos-kinit-cmd>
- sp_ctrl target x.kafka set kafka sasl.kerberos.min.time.before.relogin = <relogin-time>
- sp_ctrl target x.kafka set kafka sasl.kerberos.principal = <kerberos-principal>
- sp_ctrl target x.kafka set kafka sasl.kerberos.service.name = <kerberos-service-name>
- sp_ctrl target x.kafka set kafka sasl.mechanisms = GSSAPI
Note: All the values in the <> need to be replaced with actual parameters from the Kafka producer.
Note: Before setting the target Kafka replication parameters, you need to first stop Poster, set the parameters, and then start the Poster.
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
!kafka |
host |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to the Kafka server using SharePlex target system sysprod
Datasource:o.oraA
SCOTT.EMP !kafka sysprod
Replicate from Oracle to Kafka using mTLS Authentication
This configuration is applicable for the Kafka target.
Note: Before setting the target Kafka replication parameters, you need to first stop Poster, set the parameters, and then start the Poster.
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
!kafka |
host |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to the Kafka server using SharePlex target system sysprod
Datasource:o.oraA
SCOTT.EMP !kafka sysprod
Replicate data from Oracle to Azure Event Hubs
These configurations need to be done for replicating data from source to Azure Event Hubs. SharePlex for Kafka is used to communicate with Azure Event Hubs through the Kafka Event Hubs connectors.
Pre-requisites:
Configure the SharePlex source machine with the following Kafka parameters to post data onto Azure Event Hubs before starting the replication.
- sp_ctrl Target x.kafka set kafka api.version.request = true
- sp_ctrl target x.kafka set kafka broker = <Azure Event Hubs namespace>:<Kafka-server-port>
- sp_ctrl Target x.kafka set kafka sasl.mechanisms = PLAIN
- sp_ctrl Target x.kafka set kafka sasl.username = $ConnectionString
- sp_ctrl Target x.kafka set kafka sasl.password =<Primary key generated in Event Hubs namespace>
- sp_ctrl Target x.kafka set kafka security.protocol = SASL_SSL
- sp_ctrl Target x.kafka set kafka topic = <Kafka Event Hubs topic generated inside Event Hubs namespace>
Note: All the values in the <> need to be replaced with actual parameters from Azure Event Hubs.
Note: Before setting the target Kafka replication parameters, you need to first stop Poster, set the parameters, and then restart the Poster.
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
!kafka |
src_hostname |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to the Azure Event Hub using SharePlex target system sysprod.
Datasource:o.oraA
SCOTT.EMP !kafka sysprod
Replicate data from Oracle to Microsoft SQL Server
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
dst_owner.table |
dst_hostname |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to the MS SQL Server on host sysprod
Datasource:o.oraA
SCOTT.EMP SCOTT.EMP sysprod@r.sp_ss
Replicate data from Oracle to the Azure SQL database
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
dst_owner.table |
dst_hostname |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to the Azure SQL database on host sysprod
Datasource:o.oraA
SCOTT.EMP SCOTT.EMP sysprod@r.azuresqldb
Replicate data from Oracle to PostgreSQL database
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
dst_owner.table |
dst_hostname |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to PostgreSQL target server on host sysprod:
Datasource:o.oraA
SCOTT.EMP SCOTT.EMP sysprod@r.sp_ss
Replicate data from Oracle to MySQL database
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
dst_owner.table |
dst_hostname |
Example:
The following example replicates table SCOTT.EMP from Oracle instance oraA to MySQL target server on host sysprod:
Datasource:o.oraA
SCOTT.EMP SCOTT.EMP sysprod@r.sp_ss
Replicate from and to an Oracle pluggable database (PDB) in a container database (CDB)*
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.PDBalias |
| src_owner.table |
tgt_owner.table |
host@o.PDBalias |
Example
This example replicates table SCOTT.EMP from an Oracle PDB that uses the TNS alias of aliasA to target table SCOTT.EMP in an Oracle PDB that uses the TNS alias of aliasB on target system sysprod.
Datasource:o.aliasA
SSCOTT.EMP SCOTT.EMP sysprod@o.aliasB
* You can also replicate data from an Oracle PDB to any other supported target. For more information, see Configure capture and delivery.
Replicate to maintain a change history target
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource: o.SID |
|
src_owner.table |
!cdc:tgt_owner.table |
host@c.SID |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to change-history target table SCOTT.EMP2 in Oracle instance oraB on target system sysprod.
Datasource:o.oraA
SCOTT.EMP !cdc:SCOTT.EMP2 sysprod@c.oraB
For more information, see Configure replication to a change history target.
Replicate Data from Oracle to Oracle using Extended Data Types
These configurations need to be done for replicating data from Oracle to Oracle using extended data types.
Pre-requisite:
Your Oracle database should be supporting the Extended Data Type.
Limitation:
SharePlex does not replicate data with Extended Data Type when target type is SQL, JMS, File, or Kafka.
This configuration applies to on-premises and IaaS cloud deployments. See the System Requirements in the SharePlex Installation and Setup Guide for supported database versions and platforms.
| Datasource:o.SID |
| src_owner.table |
tgt_owner.table |
host@o.SID |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to target table SCOTT.EMP2 in Oracle instance oraB on target system sysprod.
Datasource:o.oraA
SCOTT.EMP SCOTT.EMP2 sysprod@o.oraB
