Already have an account? Sign in

Amazon Oracle RDS (v1)

Amazon Oracle RDS feature snapshot

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

Connecting Amazon Oracle RDS

Amazon Oracle RDS setup requirements

To set up Amazon Oracle RDS in Stitch, you need:

• A Stitch Advanced plan.

• 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 Amazon Oracle RDS database that allow you to:

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

  • Create users and grant privileges. TheCREATE USER andGRANT 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 toAmazon Oracle RDS’s documentation for more info.

• If using Log-based Incremental Replication, you need:

  • A database using Oracle 8.0 through 18c. Versions earlier than 8.0 and later than 18c don’t include LogMiner functionality, which is required for Log-based Incremental Replication.

Step 1: Verify your Stitch account's data pipeline region

First, you’ll log into Stitch and verify the data pipeline region your account is using. Later in this guide, you’ll need to grant Stitch access by whitelisting our IP addresses.

The IP addresses you’ll whitelist depend on theData pipeline region your account is in.

1. Sign into your Stitch account, if you haven’t already.
2. ClickUser menu (your icon) > Edit User Settings and locate theData pipeline region section to verify your account’s region.

3. Locate the list of IP addresses for your region:

   • North America region IP addresses

   • Europe region IP addresses

Keep this list handy - you’ll need it later.

Step 2: Configure database connection settings

In this step, you’ll configure the database server to allow traffic from Stitch to access it. There are two ways to connect your database:

• A direct connection will work if your database is publicly accessible.
• An SSH tunnel is required if your database isn’t publicly accessible. This method uses a publicly accessible instance, or an SSH server, to act as an intermediary between Stitch and your database. The SSH server will forward traffic from Stitch through an encrypted tunnel to the private database.

Click the option you’re using below and follow the instructions.

Step 3: Enable Log-based Incremental Replication with LogMiner

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

• Step 3.1: Enable AWS automated backups

• Step 3.2: Define ARCHIVELOG retention hours

• Step 3.3: Enable supplemental logging

Step 3.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 theServices menu located in the top-left corner of the page.
3. Locate theRDS option. This should be in theDatabase section.

4. From the RDS Dashboard, clickDatabases on the left side of the page.

5. Select the instance you’re connecting to Stitch.
6. Click theModify button.

7. On theModify DB Instance page, scroll down to theBackup section.

8. SetBackup retention period to anything greater than1 day:

   

9. Scroll to the bottom of theDatabases page and clickContinue.
10. The next page will display a summary of the modifications made to the database. In theScheduling of Modifications section, select theApply Immediately option.
11. ClickModify DB Instance to apply the changes.

12. Navigate to the Instance Details page and locate theParameter group. Initially, the Parameter group should sayapplying.

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

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

Rebooting the instance will take a few minutes. When the status of theparameter group changes toin-sync and theDB instance status (located at the top of the Instance Details page) changes toavailable, the reboot will be complete:

Step 3.2: Define ARCHIVELOG retention hours

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

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

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

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

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

Step 3.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 Amazon Oracle RDS to use LogMiner. Refer toAmazon Oracle RDS’s documentation for more info about supplemental logging.

To enable supplemental logging, run:

execrdsadmin.rdsadmin_util.alter_supplemental_logging('ADD','ALL');

The result should bePL/SQL procedure successfully completed.

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

SELECTSUPPLEMENTAL_LOG_DATA_MINFROMV$DATABASE

If the result isYES, supplemental logging was successfully enabled.

Step 4: Create a Stitch Amazon 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.

• Instructions
• Privileges list

GRANTEXECUTE_CATALOG_ROLETO<stitch_username>GRANTSELECTANYTRANSACTIONTO<stitch_username>GRANTSELECTANYDICTIONARYTO<stitch_username>GRANTEXECUTEONDBMS_LOGMNRTO<stitch_username>GRANTEXECUTEONDBMS_LOGMNR_DTO<stitch_username>GRANTSELECTONSYS.V_$DATABASETO<stitch_username>GRANTSELECTONSYS.V_$ARCHIVED_LOGTO<stitch_username>

GRANTLOGMININGTO<stitch_username>

Step 5: 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 Amazon Oracle RDS database to Stitch, you’ll enter the SID of the database you want Stitch to extract data from into theIntegration Settings page.

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

SELECTINSTANCEFROMSYS.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 6: Connect Stitch

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

• Step 6.1: Locate the database connection details in AWS

• Step 6.2: Define the database connection details in Stitch

• Step 6.3: Define the SSH connection details

• Step 6.4: Define the default replication method

• Step 6.5: Create a replication schedule

Step 6.1: Locate the database connection details in AWS

1. Sign into theAWS Console, if needed.
2. Navigate to theRDS option.

3. On theRDS Dashboard page, click theDatabases option on the left side of the page. This will open theRDS Databases page.

4. In the list of databases, locate and click on the instance you want to connect to Stitch. This will open theDatabase Details page.

5. On the Database Details page, scroll down to theConnectivity & security section.

6. Locate the following fields:
   • Endpoint

   • DB Name: This field contains the name of the database used to launch the instance. You’ll only need this info if you want to connect this specific database to Stitch.

     You can connect this database to Stitch, or another database within Amazon Oracle RDS.

   • Port: This is the port used by the database.

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

Step 6.2: Define the database connection details in Stitch

1. If you aren’t signed into your Stitch account,sign in now.

2. On the Stitch Dashboard page, click theAdd Integration button.

3. Locate and click theOracle 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 destination.

     For example, the name “Stitch Amazon Oracle RDS” would create a schema calledstitch_amazon_oracle_rds in the destination.Note: The schema name cannot be changed after the integration is saved.

   • Port: Enter the port used by the Amazon Oracle RDS instance. The default is1521.

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

   • Password: Enter the password for the Stitch Amazon Oracle RDS database user.

   • Oracle System ID (SID): Enter the Oracle System ID (SID) of the database you retrieved inStep 5.

Step 6.3: Define the SSH connection details

If you’re using an SSH tunnel to connect your Amazon Oracle RDS database to Stitch, you’ll also need to define the SSH settings. Refer to theSetting up an SSH Tunnel for a database in Amazon Web Services guide for assistance with completing these fields.

1. Click theSSH Tunnel checkbox.

2. Fill in the fields as follows:

   • SSH Host: Paste thePublic DNS of the SSH sever (EC2 instance) into this field. Refer to theAmazon SSH guide for instructions on retrieving this info.

   • SSH Port: Enter the SSH port of the SSH server (EC2 instance) into this field. This will usually be22.

   • SSH User: Enter the Stitch Linux (SSH) user’s username.

Step 6.4: Define the default replication method

In theDefault 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 theLog-based Incremental documentation for more info, examples, and limitations for this method.

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

Note:Key-based Incremental documentation is also available for this integration, but it must be set manually. This is due to Stitch requiring a Replication Key to be selected for every table set to replicate.

Step 6.5: Create a replication schedule

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

Amazon Oracle RDS integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 7: Select data to replicate

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

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

• Selection options
• Individual tables and columns
• All tables and columns
• Database views

Initial and historical replication jobs

After you finish setting up Amazon Oracle RDS, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending 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.

Amazon Oracle RDS replication

• Overview of Log-based Incremental Replication using LogMiner

• Data types

Overview of Log-based Incremental Replication using LogMiner

Stitch uses Amazon Oracle RDS’sLogMiner 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 Amazon Oracle RDS’sApproximate Commit System Change Numbers, or SCNs, asReplication 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 theLog-based Incremental Replication documentation for a more detailed explanation, examples, and the limitations associated with this replication method.

Data types

In the table below are the data types Amazon Oracle RDS integrations support and the Stitch data type it will map to, depending on the version of the integration being used:

• indicates that the data type is supported. Following the icon is the Stitch data type it will map to.
• indicates that the data type is supported, but there is additional information you should know. Hover over the icon to view a tooltip with the information.
• indicates that the data type isn't applicable to the integration. This is usually because the integration doesn't use that particular data type.
• indicates that the data type isn't supported. In Stitch, columns with unsupported data types will haveUnavailable in theType column of theTables to Replicate tab.

Refer to theData typing guide for more info about how Stitch identifies and types data when it's loaded into your destination.

Note: This table doesn't display info for versions that have been sunset.

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