Configuration Examples by Data Source and Target
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 a regular Oracle instance to multiple instances of Kafka using single SharePlex instance
Datasource:o.SID | ||
src_owner.src_table | target_owner.target_table | source_host:export_queue*target_host:post1_queue@x.kafka |
src_owner.src_table | target_owner.target_table | source_host:export_queue*target_host:post2_queue@x.kafka |
Or
Datasource:o.SID | ||
src_owner.src_table | target_owner.target_table | source_host:export_queue*target_host:post1_queue@x.kafka + source_host:export_queue*target_host:post2_queue@x.kafka |
Example
The following example replicates table SCOTT.EMP from Oracle instance oraA to multiple Kafka instances using single SharePlex target system sysprod2.
Datasource:o.oraA | |
SCOTT.SCOTT.EMP | sysprod:EXP_Q*sysprod2:POST_Q1@x.kafka |
SCOTT.EMP SCOTT.EMP | sysprod:EXP_Q*sysprod2:POST_Q2@x.kafka |
or
Datasource:o.oraA | |
SCOTT.SCOTT.EMP | sysprod:EXP_Q*sysprod2:POST_Q1@x.kafka+sysprod:EXP_Q*sysprod2:POST_Q2@x.kafka |
Target configurations on sysprod2:
Configure the Kafka target with the following parameters to post data to multiple instances of Kafka using single SharePlex instance:
-
sp_ctrl target x.kafka POST_Q1 set kafka broker= host1:9092,host2:9092,host3:9092
-
sp_ctrl target x.kafka POST_Q2 set kafka broker= host4:9092,host5:9092,host6:9092
Note: Hosts 1, 2, and 3 are part of the first Kafka instance, while hosts 4, 5, and 6 are part of the second Kafka instance.
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
Notes:
|
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
-
sp_ctrl target x.kafka set kafka ssl.endpoint.identification.algorithm = none
-
sp_ctrl target x.kafka set kafka enable.ssl.certificate.verification = false
Notes:
|
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 |
NOTE: The "Host" value should be the IP address or hostname of the Kafka server (target). Make sure the Kafka server entry is updated in the /etc/hosts file.
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>
Note: The {broker.name} property is no longer supported for the sp_ctrl target x.kafka set kafka sasl.kerberos.kinit.cmd = <kerberos-kinit-cmd> parameter.
- 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
-
sp_ctrl target x.kafka set kafka security.protocol = SASL_PLAINTEXT
-
sp_ctrl target x.kafka set enable.ssl.certificate.verification = false
Notes:
|
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 |
NOTE: The "Host" value should be the hostname of the Kafka server (target). Make sure the Kafka server entry is updated in the /etc/hosts file.
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>
Notes:
|
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 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 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 MariaDB
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 MariaDB 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
Replicate data from Oracle to Snowflake
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_schema.table | dst_schema.table | dst_hostname |
Example:
The following example replicates table scott.emp from Oracle instance oraA to the Snowflake on host sysprod
Datasource:o.oraA "scott"."emp" "SCOTT"."EMP" sysprod@r.dbname
Replicate data from PostgreSQL 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:r.dbname | ||
src_schema.table | dst_schema.table | dst_hostname |
Example:
The following example replicates table SCOTT.EMP from a PostgreSQL instance dbnameA to a PostgreSQL target server on host hostB:
Datasource:r.dbnameA scott.emp scott.emp hostb@r.mydb
Replicate data from PostgreSQL to Oracle 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:r.dbname | ||
src_schema.table | dst_owner.table | dst_hostname |
Example:
The following example replicates table SCOTT.EMP from a PostgreSQL instance dbnameA to an Oracle target server on host hostB:
Datasource:r.dbnameA "scott"."emp" "scott"."emp" hostB@o.mydb
Replicate from a PostgreSQL instance to a Kafka topic
Datasource:r.dbname | ||
src_schema.table | !kafka | host |
Example
The following example replicates table SCOTT.EMP from PostgreSQL instance testdbA to a Kafka topic using SharePlex target system targetHost.
Datasource:r.testdbA scott.emp !kafka targetHost
Replicate data from PostgreSQL to 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:r.dbname | ||
src_schema.table | dst_owner.table | dst_hostname |
Example:
The following example replicates table SCOTT.EMP from PostgreSQL instance testdbA to MS SQL Server on host sysprod
Datasource: r.testdbA SCOTT.EMP SCOTT.EMP sysprod@r.dbname
Replicate data from PostgreSQL to Snowflake
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:r.dbname | ||
src_schema.table | dst_schema.table | dst_hostname |
Example:
The following example replicates table scott.emp from PostgreSQL instance testdbA to Snowflake on host sysprod
Datasource: r.testdbA "scott"."emp" "SCOTT"."EMP" sysprod@r.dbname