Oracle RDS snapshot

A high-level look at Stitch's Oracle RDS integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status

Released

Supported By

Stitch

Stitch Plan

Enterprise

Supported Versions

n/a

Singer GitHub Repository

Oracle Repository

CONNECTION METHODS
SSH Connections

Supported

SSL Connections

Supported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Table-level Reset

Supported

Configurable Replication Methods

Supported

REPLICATION METHODS
Log-based Replication

Supported

Key-based Replication

Unsupported

Full Table Replication

Supported

DATA SELECTION
Table Selection

Supported

Column Selection

Supported

View Replication

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Oracle RDS

Oracle RDS setup requirements

To set up Oracle RDS in Stitch, you need:

  • An Enterprise Stitch plan. Oracle RDS integrations can be added on as part of an Enterprise plan. Reach out to Stitch support for more info.
  • Privileges in Amazon Web Services (AWS) that allow you to:

    • Create/manage Security Groups. This is required to whitelist Stitch’s IP addresses.
    • Modify database instances. This is required to enable settings required for incremental replication.
    • View database details. This is required to retrieve the database’s connection details.
  • Privileges in the Oracle RDS database that allow you to:

    • Access the V$DATABASE and V_$THREAD performance views. These are required to verify setting configuration while setting up your Oracle RDS database and to retrieve the database’s Oracle System ID. Refer to Oracle RDS’s documentation for more info on performance views.

    • Create users and grant privileges. The CREATE USER and GRANT privileges are required to create a database user for Stitch and grant the necessary privileges to the user.

    • GRANT access to the objects you want to replicate. This is necessary to grant the privileges necessary for selecting data to the Stitch database user. Refer to Oracle RDS’s documentation for more info.


Step 1: Whitelist Stitch's IP addresses

For Stitch to successfully connect with your RDS instance, you’ll need to add our IP addresses to the appropriate database security group via the AWS management console. To do this, an inbound security rule must be created for each of our IP addresses.

The IP addresses can be added to an existing group or you can create a new one. The important thing is that the group is authorized to access the instance you want to connect to Stitch.

  1. Log into your AWS account.
  2. Navigate to the Security Group Management page, typically Services > Compute > EC2.
  3. Click the Security Groups option, under Network & Security in the menu on the left side of the page.
  4. Click Create Security Group.
  5. In the window that displays, fill in the fields as follows:
    • Security group name: Enter a unique name for the security group. For example: Stitch
    • Description: Enter a description for the security group.
    • VPC: Verify that the selected VPC is the same VPC your database is in.
  6. In the Inbound tab, click Add Rule.
  7. Fill in the fields as follows:
    • Type: Select Custom TCP Rule
    • Port Range: Enter the port your database uses. (1521 by default)
    • CIDR, IP or Security Group, enter one of the IP addresses listed below:

      • 52.23.137.21/32

      • 52.204.223.208/32

      • 52.204.228.32/32

      • 52.204.230.227/32

  8. Add another rule by clicking the Add Rule button.
  9. Repeat steps 6-8 until all the IP addresses above have been added:

  10. When finished, click Create.

Step 2: Enable Log-based Incremental Replication with LogMiner

Log-based Incremental Replication is the most efficient way to replicate Oracle RDS data. Stitch uses Oracle’s LogMiner package to query Oracle’s archive logs and retrieve all inserts, updates, and deletes to your database.

Step 2.1: Enable AWS automated backups

The backup retention period setting defines the number of days for which automated backups are retained. This ensures that data can still be replicated even if a job is interrupted, there’s database or Stitch downtime, etc.

  1. Sign into your AWS account.
  2. Once you’re signed into the AWS console, click the Services menu located in the top-left corner of the page.
  3. Locate the RDS option. This should be in the Database section.
  4. From the RDS Dashboard, click Databases on the left side of the page.

  5. Select the instance you’re connecting to Stitch.
  6. Click the Modify button.
  7. On the Modify DB Instance page, scroll down to the Backup section.

  8. Set Backup retention period to anything greater than 1 day:

    A backup retention period setting of 1 day for an RDS instance in the AWS console

  9. Scroll to the bottom of the page and click Continue.
  10. The next page will display a summary of the modifications made to the database.

    In the Scheduling of Modifications section, select the Apply Immediately option.

  11. Click Modify DB Instance to apply the changes.
  12. Navigate to the Instance Details page and locate the Parameter group. Initially, the Parameter group should say applying.

    When it changes to pending-reboot, you can reboot the database and apply the changes.

  13. Scroll up to the top of the page and locate the Instance actions menu.
  14. In this menu, click Reboot.
  15. On the next page, click Reboot to confirm you want to reboot the instance.

Rebooting the instance will take a few minutes. When the status of the parameter group changes to in-sync and the DB instance status (located at the top of the Instance Details page) changes to available, the reboot will be complete:

An "Available" DB instance status for an RDS instance in the AWS console

Step 2.2: Define ARCHIVELOG retention hours

In addition to the backup retention period, you also need to define the archivelog retention hours setting. This parameter specifies the number of hours the database server should retain archive logs.

To specify the number of hours, use the rdsadmin.rdsadmin_util.set_configuration procedure when logged into the Oracle RDS master instance.

In this example, archive logs will be retained for seven days (24 hours x 7 days = 168 hours):

exec rdsadmin.rdsadmin_util.set_configuration('archivelog retention hours',168);

Stitch recommends a minimum of three days for the retention period, but strongly recommends seven.

Step 2.3: Enable supplemental logging

In this step, you’ll enable supplemental logging for the database. This ensures that columns are logged in redo log files when changes are made to the database, which is required by Oracle RDS to use LogMiner. Refer to Oracle RDS’s documentation for more info about supplemental logging.

To enable supplemental logging, run:

exec rdsadmin.rdsadmin_util.alter_supplemental_logging('ADD','ALL');

The result should be PL/SQL procedure successfully completed.

Next, verify that supplemental logging was successfully enabled by running the following query:

SELECT SUPPLEMENTAL_LOG_DATA_MIN FROM V$DATABASE

If the result is YES, supplemental logging was successfully enabled.


Step 3: Create a Stitch Oracle RDS database user

Next, you’ll create a dedicated database user for Stitch. This will ensure Stitch is visible in any logs or audits and allow you to maintain your privilege hierarchy.

  1. If you aren’t already, log into your database as a user with CREATE USER and GRANT privileges.
  2. Run the following command to create the Stitch database user, replacing <password> with a secure password:

    CREATE USER STITCH IDENTIFIED BY <password>
    
  3. Grant the Stitch user the CREATE SESSION privilege, which will allow Stitch to connect to the database:

    GRANT CREATE SESSION TO STITCH
    
  4. Grant the Stitch user SELECT privileges. This can be done one of two ways: Granting access to all tables, or only granting access to specific tables you want to replicate.

    • To grant Stitch access to all tables, run:

       GRANT SELECT ANY TABLE TO STITCH
      
    • To grant Stitch access to specific tables, run the following command for each table you want to replicate. Replace <SCHEMA> and <TABLE> with the name of the schema and table, respectively:

       GRANT SELECT ON <SCHEMA>.<TABLE> to STITCH
      

See the Privileges list tab for an explanation of why these permissions are required by Stitch.

In the table below are the database user privileges Stitch requires to connect to and replicate data from a Oracle RDS database.

Privilege name Reason for requirement
CREATE SESSION

Required to log into the Oracle RDS database.

SELECT

Required to select data from the tables and columns you want to replicate.

  • SELECT ANY TABLE grants SELECT privileges to any table in the connected database.
  • SELECT ON <SCHEMA.TABLE> grants SELECT privileges only to the specified table.
EXECUTE_CATALOG_ROLE

Required to use Log-based Incremental Replication. Required by Oracle RDS to access objects in the SYS schema.

EXECUTE ON DBMS_LOGMNR

Required to use Log-based Incremental Replication. Allows the Stitch user to execute the DBMS_LOGMNR package for LogMiner.

EXECUTE ON DBMS_LOGMNR_D

Required to use Log-based Incremental Replication. Allows the Stitch user to execute the DBMS_LOGMNR package for LogMiner.

SELECT ON SYS.V_$DATABASE

Required to validate the database’s configuration settings (archiving mode, supplemental logging, etc).

SELECT ANY TRANSACTION

Required to use Log-based Incremental Replication. Requied by Oracle RDS to query the SYS.V$LOGMNR_CONTENTS view.

SELECT ANY DICTIONARY

Required to select from system data dictionary objects.

SELECT ON SYS.V_$ARCHIVED_LOG

Required to use Log-based Incremental Replication. Required to locate the start and end of extracted dictionaries in archived redo log files via the SYS.V_$ARCHIVED_LOG view.

SELECT ON SYS.V_$LOGMNR_CONTENTS

Required to use Log-based Incremental Replication. Required to identify the redo log files to mine (read) via the SYS.V_$LOGMNR_CONTENTS view.

LOGMINING

Required to use Log-based Incremental Replication if using Oracle version 12. In version 12 of Oracle, this privilege is required to use the START_LOGMNR procedure in LogMiner.


Step 4: Retrieve the database's Oracle System ID

An Oracle System ID (SID) is used to uniquely identify a specific database in your system. When you connect an Oracle RDS database to Stitch, you’ll enter the SID of the database you want Stitch to extract data from into the Integration Settings page.

To retrieve your database’s SID, log into your database as a user with access to the SYS.V_$THREAD performance view and run the following:

SELECT INSTANCE FROM SYS.V_$THREAD

The value returned by the query will be the database’s SID. Keep this handy - you’ll need it to complete the setup.


Step 5: Connect Stitch

In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.

Step 5.1: Locate the database connection details in AWS

Next, you’ll retrieve the connection details required to complete the setup in Stitch. This info can be found on the Instance Details page in AWS.

If you don’t still have this page open, click RDS > Databases and then the instance you’re connecting to Stitch.

  1. On the Instance Details page, click the Connectivity & security tab if it’s not already open.
  2. Locate the Endpoint and Port fields, which are highlighted in the image below:

    Amazon RDS Instance Details page with the Endport and Port fields highlighted

Leave this page open for now - you’ll need it to complete the setup.

Step 5.2: Define the database connection details

  1. Sign into your Stitch account, if you haven’t already.
  2. On the Stitch Dashboard page, click the Add Integration button.
  3. Click the Oracle icon.
  4. Fill in the fields as follows:

    • Integration Name: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your data warehouse.

      For example, the name “Stitch Oracle RDS” would create a schema called stitch_oracle_rds in the data warehouse. Note: The schema name cannot be changed after the integration is saved.

    • Host (Endpoint): Paste the Endpoint address from the Oracle RDS Details page in AWS into this field. Don’t include the port number, which is appended to the end of the endpoint string - this will cause errors.

    • Port: Enter the port used by the Oracle RDS instance. The default is 1521.

    • Username: Enter the Stitch Oracle RDS database user’s username.

    • Password: Enter the password for the Stitch database user.

    • Oracle System ID (SID): Enter the Oracle System ID (SID) of the database you retrieved in Step 4.

Step 5.3: Define the SSL connection details

Click the Connect using SSL checkbox if you’re using an SSL connection. Note: The database must support and allow SSL connections for this setting to work correctly.

Step 5.4: Define default replication method

In the Default Replication Method section, you’ll select a default Replication Method for the integration.

The method you select will be the default Replication Method for any table you set to replicate. You can change the Replication Method for individual tables in the Table Settings page for that table.

Select a default Replication Method:

  • Log-based Incremental Replication - Stitch will use Log-based Incremental Replication. Refer to the Log-based Incremental documentation for more info, examples, and limitations for this method.

  • Full Table Replication - Stitch will use Full Table Replication. Refer to the Full Table documentation for more info, examples, and limitations for this method.

Step 5.5: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

To help prevent overages, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.


Step 6: Select data to replicate

The last step is to select select the tables and columns you want to replicate.

When you track a table, Stitch will use the default Replication Method selected in the Integration Settings page. You can choose a different Replication Method for individual tables during this process.

You can select tables and columns by:

  1. In the Integration Details page, click the Tables to Replicate tab.
  2. Locate a table you want to replicate.
  3. Click the checkbox next to the object’s name. A green checkmark means the object is set to replicate.
  4. If there are child objects, they’ll automatically display and you’ll be prompted to select some.
  5. After you set a table to replicate, the Settings page will display. Note: When you track a table, by default all columns will also be tracked.

  6. In the Settings page, define the table’s Replication Method or skip this step if you want to use the integration’s default method.

  7. Repeat this process for every table you want to replicate.

  8. Click the Finalize Your Selections button to save your data selections.

Initial and historical replication jobs

After you finish setting up Oracle RDS, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Oracle RDS Replication

Overview of Log-based Incremental Replication using LogMiner

Stitch uses Oracle RDS’s LogMiner package to replicate data incrementally. This means that when Log-based Incremental is selected as the Replication Method for a table, Stitch will only replicate new or updated data for the table during each replication job.

To identify new and updated data, Stitch uses Oracle RDS’s Approximate Commit System Change Numbers, or SCNs, as Replication Keys. When reading from the database’s logs, records with an SCN value greater than the maximum SCN from the previous job will be replicated.

Refer to the Log-based Incremental Replication documentation for a more detailed explanation, examples, and the limitations associated with this replication method.

Note: Stitch currently supports Log-based Incremental and Full Table Replication for Oracle RDS integrations. Other replication methods are not currently supported.

Data typing and LogMiner (Log-based Incremental Replication)

Oracle RDS’s LogMiner packages supports the data types listed in the table below. Refer to Oracle RDS’s documentation for more info.

Only columns with the data types listed below are able to be selected and replicated through Stitch. Columns with data types not in this list will show as UNSUPPORTED in Stitch. For reference, you can view the code for data typing in Stitch’s Oracle RDS integrations in the Singer Oracle RDS GitHub repository.

Oracle RDS data type Stitch data type mapping
BINARY_FLOAT FLOAT
BINARY_DOUBLE FLOAT
CHAR STRING
NCHAR STRING
NVARCHAR2 STRING
VARCHAR STRING
VARCHAR2 STRING
DATE DATE-TIME
TIMESTAMP DATE-TIME
TIMESTAMP WITH TIME ZONE DATE-TIME
TIMESTAMP WITH LOCAL TIME ZONE DATE-TIME
INTEGER INTEGER
SMALLINT INTEGER
NUMBER (*,0) INTEGER
NUMBER (*,*) DECIMAL


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.