Oracle

Oracle feature snapshot

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

Connecting Oracle

Oracle setup requirements

To set up Oracle in Stitch, you need:

• An Enterprise Stitch plan. Oracle integrations can be added on as part of an Enterprise plan. Reach out to Stitch support for more info.

• Privileges in the Oracle 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 database and to retrieve the database’s Oracle System ID. Refer to Oracle’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’s documentation for more info.

  • Use System administrator (SYSDBA) privileges, if replicating data incrementally. This is necessary to complete steps required to use Oracle LogMiner, which enables the use of Log-based Incremental Replication. Refer to Oracle’s documentation for more info.

• An existing Recovery Manager (RMAN) configuration, if replicating data incrementally. RMAN is used to manage database backups and archive logs and is required to use Log-based Incremental Replication. Setting up RMAN is outside the scope of this tutorial. If you need help setting up and using RMAN, refer to Oracle’s documentation or loop in a member of your technical team.

Step 1: 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 2: Enable Log-based Incremental Replication with LogMiner

Log-based Incremental Replication is the most efficient way to replicate Oracle 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: Verify the database’s current archiving mode

• Step 2.2: Enable ARCHIVELOG mode

• Step 2.3: Configure RMAN backups

• Step 2.4: Enable supplemental logging

Step 2.1: Verify the database's current archiving mode

To check the database’s current mode, run:

SELECT LOG_MODE FROM V$DATABASE

If the result is ARCHIVELOG, archiving is enabled and no further action is required. Skip to Step 3.3 to configure RMAN backups.

If the result is NOARCHIVELOG, then you’ll need to enable archiving. Move onto to Step 3.2 for instructions.

Step 2.2: Enable ARCHIVELOG mode

If the result to the query in Step 3.1 is NOARCHIVELOG, then you’ll need to enable ARCHIVELOG mode. Skip to Step 3.3 if the result was ARCHIVELOG.

1. Shut down the database instance. The database and any associated instances must be shut down before the datbase’s archiving mode can be changed.

   SHUTDOWN IMMEDIATE
   

2. If desired, back up the database. Oracle recommends backing up databases before any major changes. Refer to Oracle’s documentation for more info.

3. Start a new instance and mount (but not open) the database:

   STARTUP MOUNT
   

4. Change the database’s archiving mode and re-open it:

   ALTER DATABASE ARCHIVELOG
   ALTER DATABASE OPEN
   

Step 2.3: Configure RMAN backups

Next, you’ll configure Recovery Manager (RMAN) backups. This setting defines how long the database will retain backups and archive logs, which is what Stitch will read from to perform Log-based Incremental Replication. Refer to Oracle’s documentation for more info about RMAN.

Stitch recommends a retention period of at least 3 days, but strongly recommends 7. To specify the RMAN retention policy, run the following:

RMAN> CONFIGURE RETENTION POLICY TO RECOVERY WINDOW OF 7 DAYS;

Step 2.4: Enable supplemental logging

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

Stitch supports supplemental logging at the database and table level. Note: You do not need to enable both. Select the level you want to use for supplemental logging (database or table) and follow the steps below:

• At the database level, this means that any time a change is made to a table in the database, it will be logged in the redo log files.

  To enable supplemental logging at the database level, run:

  ALTER DATABASE ADD SUPPLEMENTAL LOG DATA (ALL) COLUMNS
  

• At the table level, this means that only changes made to the specified table will be logged in the redo log files. By only applying logging to the tables you want to replicate through Stitch, this may reduce the overall disk space used by redo log files.

  To enable supplemental logging at the table level, run the following for every table you want to replicate through Stitch:

  ALTER TABLE <SCHEMA_NAME>.<TABLE_NAME> ADD SUPPLEMENTAL LOG DATA (ALL) COLUMNS
  

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

SELECT SUPPLEMENTAL_LOG_DATA_MIN FROM V$DATABASE

If the returned value is YES or IMPLICIT, supplemental logging is enabled.

Step 3: Create a Stitch Oracle 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

GRANT EXECUTE_CATALOG_ROLE TO STITCH
GRANT SELECT ANY TRANSACTION TO STITCH
GRANT SELECT ANY DICTIONARY TO STITCH
GRANT EXECUTE ON DBMS_LOGMNR TO STITCH
GRANT EXECUTE ON DBMS_LOGMNR_D TO STITCH
GRANT SELECT ON SYS.V_$DATABASE TO STITCH
GRANT SELECT ON SYS.V_$ARCHIVED_LOG TO STITCH
GRANT SELECT ON SYS.V_$LOGMNR_CONTENTS TO STITCH

GRANT LOGMINING TO STITCH

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 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: Define the database connection details

• Step 5.2: Define the SSH connection details

• Step 5.3: Define the SSL connection details

• Step 5.4: Define the default replication method

• Step 5.5: Create a replication schedule

Step 5.1: Define the database connection details

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

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

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

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

   • Host (Endpoint): Enter the host address (endpoint) used by the Oracle instance. For example: This could be a network address such as 192.68.0.1, or a server endpoint like dbname.hosting-provider.com.

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

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

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

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

Step 5.2: Define the SSH connection details

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

1. Click the SSH Tunnel checkbox.

2. Fill in the fields as follows:

   • SSH Host: Enter the public IP address or hostname of the server Stitch will SSH into.

   • SSH Port: Enter the SSH port on your server. (22 by default)

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

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 the 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. Note: This method can only be used if you completed the steps for setting up LogMiner.

• Full Table Replication - Stitch will use Full Table Replication. Refer to the Full 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 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.

Oracle integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

To keep your row usage low, 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 and, if using Key-based Incremental Replication, its Replication Key.

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, 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 Replication

• Overview of Log-based Incremental Replication using LogMiner

• Data types

Overview of Log-based Incremental Replication using LogMiner

Stitch uses Oracle’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’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.

Data types

In the table below are the data types Oracle 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 have Unavailable in the Type column of the Tables to Replicate tab.

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

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.