> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Oracle Connector

> Connect Oracle to Collate effortlessly. Complete setup guide, configuration steps, and troubleshooting tips for seamless data catalog integration.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/oracle.webp" name="Oracle" stage="PROD" availableFeatures={["Metadata", "Query Usage", "Data Profiler", "Data Quality", "dbt", "Lineage", "Column-level Lineage", "Stored Procedures", "Sample Data", "Reverse Metadata (Collate Only)", "Auto-Classification"]} unavailableFeatures={["Owners", "Tags"]} />

<iframe width="560" height="315" src="https://www.youtube.com/embed/8bGaJ251WyE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />

This section provides guides and references to use the Oracle connector.
Configure and schedule Oracle metadata and profiler workflows from the Collate UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Data Profiler](/ai-2-0/how-to-guides/data-quality-observability/profiler/profiler-workflow)
* [Data Quality](/ai-2-0/how-to-guides/data-quality-observability/quality)
* [Lineage](/ai-2-0/how-to-guides/guide-for-data-users/ingestion/lineage)
* [dbt Integration](/ai-2-0/connectors/database/dbt)
* [Troubleshooting](/ai-2-0/connectors/database/oracle/troubleshooting)
* [Reverse Metadata](#reverse-metadata)

## Requirements

**Note**: To retrieve metadata from an Oracle database, Collate uses the `python-oracledb` library, which provides support for versions 12c, 18c, 19c, and 21c.
To ingest metadata from Oracle, the user must have `CREATE SESSION` privilege.

```sql theme={null}
-- CREATE USER
CREATE USER user_name IDENTIFIED BY admin_password;
-- CREATE ROLE
CREATE ROLE new_role;
-- GRANT ROLE TO USER
GRANT new_role TO user_name;
-- Grant CREATE SESSION Privilege.
--   This allows the role to connect.
GRANT CREATE SESSION TO new_role;
-- Grant SELECT_CATALOG_ROLE Privilege.
--   This allows the role ReadOnly Access to Data Dictionaries
GRANT SELECT_CATALOG_ROLE TO new_role;
```

To give permissions directly to the user instead of creating a role, use the following example.

```sql theme={null}
-- Create a New User
CREATE USER my_user IDENTIFIED by my_password;
-- Grant CREATE SESSION Privilege.
--   This allows the user to connect.
GRANT CREATE SESSION TO my_user;
-- Grant SELECT_CATALOG_ROLE Privilege.
--   This allows the user ReadOnly Access to Data Dictionaries
GRANT SELECT_CATALOG_ROLE to my_user;
```

**Note**: With just these permissions, the user can ingest metadata, but not run Data Profiler and Data Quality workflows. Grant `SELECT` permissions on the tables to include in profiling and data quality checks.

```sql theme={null}
-- If you are using a role and do not want to specify a specific table, but any
GRANT SELECT ANY TABLE TO new_role;
-- If you are not using a role, but directly giving permission to the user and do not want to specify a specific table, but any
GRANT SELECT ANY TABLE TO my_user;
-- if you are using role
GRANT SELECT ON ADMIN.EXAMPLE_TABLE TO new_role;
-- if you are not using role, but directly giving permission to the user
GRANT SELECT ON ADMIN.EXAMPLE_TABLE TO my_user;
-- if you are using role
GRANT SELECT ON {schema}.{table} TO new_role;
-- if you are not using role, but directly giving permission to the user
GRANT SELECT ON {schema}.{table} TO my_user;
```

For more information, see the [Oracle GRANT statement reference](https://docs.oracle.com/javadb/10.8.3.0/ref/rrefsqljgrant.html). Oracle provides no built-in routine to grant SELECT on a full schema.

## Metadata Ingestion

To ingest metadata from Oracle, you need to create a service connection. The service connects Oracle with Collate. Once you create a service, Collate automatically starts ingesting metadata.

### Step 1: Add New Service

1. In the left navigation, click **Connections**.
2. On the **Connections** page, click **Add New Service**.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=733cef1141ef13d318634aa9f407eb2b" alt="Add New Service" width="2992" height="1256" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **Database Services**, then click the **Oracle** connector tile.

<img src="https://mintcdn.com/collatedocs/bWmb7UY94lEjxxg4/public/images/ai-2.0/connectors/metadata-ingestion/Database/select-service/oracle.png?fit=max&auto=format&n=bWmb7UY94lEjxxg4&q=85&s=3d92147d335a9e072c7a7f5fc23209cc" alt="Select Service" width="1900" height="900" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/select-service/oracle.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other Oracle services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/collatedocs/bWmb7UY94lEjxxg4/public/images/ai-2.0/connectors/metadata-ingestion/Database/service-name/oracle.png?fit=max&auto=format&n=bWmb7UY94lEjxxg4&q=85&s=2c749147a87d9c9a8258cb0e9eb119ad" alt="Add New Service Name" width="1496" height="856" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/service-name/oracle.png" />

<Note>
  **Note**: The service name cannot be changed after it is set.
</Note>

### Step 4: Configure Connection Options

Specify where ingestion runs, provide your source credentials, and verify the connection.

#### Select Ingestion Runner

Select an **Ingestion Runner**: the runner where the ingestion pipeline executes.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=1249f828648614445e8a976ea1933487" alt="Add Name and Select Ingestion Runner" width="1444" height="506" data-path="public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png" />

#### Enter Connection Details

Enter the connection details for Oracle. The right-hand panel in the UI displays inline help for each field.

<img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/connection-details/oracle.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=05fe1c942e554b0df5d8b5e5843fc1f2" alt="Configure Service Connection" width="1458" height="1316" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/connection-details/oracle.png" />

* **Username**: Specify the User to connect to Oracle. It should have enough privileges to read all the metadata.
* **Password**: Password to connect to Oracle.
* **Host and Port**: Enter the fully qualified hostname and port number for your Oracle deployment.
* **Database Name**: Optional name for the database in Collate. If left blank, Collate uses a default database name. Use the same name as the SID to ensure accurate results and proper identification of tables during profiling, data quality checks, and dbt workflows.
* **Oracle Connection Type**: Select the Oracle Connection Type. The type can either be `Oracle Service Name` or `Database Schema`.
  * **Oracle Service Name**: The TNS alias used to connect remotely to the database. Oracle records this service name in `tnsnames.ora`.
  * **Database Schema**: The name of the database schema available in Oracle to connect with.
* **Oracle instant client directory**: The directory pointing to where the `instantclient` binaries for Oracle are located. In the ingestion Docker image, Collate
  provides them by default at `/instantclient`. If this parameter is set (it is by default), Collate runs the [thick Oracle client](https://python-oracledb.readthedocs.io/en/latest/user_guide/initialization.html#initializing-python-oracledb).
  Collate ships instant client version 19 binaries for the [AMD64 architecture](https://www.oracle.com/database/technologies/instant-client/linux-x86-64-downloads.html)
  and the [ARM64 architecture](https://www.oracle.com/database/technologies/instant-client/linux-arm-aarch64-downloads.html).
* **Use DBA Tables**: Enabled by default. When enabled, the connector uses `DBA_TABLES` to retrieve metadata for all database objects, which requires DBA-level privileges. Disable it to use `ALL_TABLES`, which only returns metadata for objects accessible to the current user.

#### Advanced Configuration

Database Services include an Advanced Configuration section for passing extra arguments to the connector and, if needed, changing the connection scheme. This is only required for advanced connectivity scenarios or customizations.

* **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to the database during the connection. These details must be added as key-value pairs.
* **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as key-value pairs.

#### Test Connection

Once the credentials have been added, click on **Test Connection** and **Save** the changes.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=3365cff7bb9d82c85a2ff9ab559d6f11" alt="Test Connection" width="1446" height="188" data-path="public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your database service. Filter patterns use regular expressions applied to asset names.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated regular expressions. Collate skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When both Include and Exclude are set, Exclude takes priority.

<Tip>
  **Tip**: Leave all filter patterns empty to ingest all databases, schemas, and tables available in the source.
</Tip>

#### Filter Options

The Database, Schema, Table, and Stored Procedure sections each include the following filter options:

* **Database**: Controls which databases Collate ingests from the source.
* **Schema**: Controls which schemas within the ingested databases are included.
* **Table**: Controls which tables and views within the ingested schemas are included.
* **Stored Procedure**: Controls which stored procedures are included in metadata ingestion.

Each section provides the following controls:

* **Scan Mode**: Choose one of the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Exclude system toggle**: Use this toggle to automatically filter out system-reserved names defined by the connector—for example, **Exclude system databases** for the Databases section.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips. An asset is included if it matches any rule.

<Tip>
  **Tip**: If [AutoPilot](/ai-2-0/admin-guide/applications/autopilot) is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes.
</Tip>

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Connections** in the left navigation and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts schemas, tables, columns, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. In the left navigation, click **Connections** and select your service.

2. Click the **Agents** tab.

3. Click **Add Agent** and select **Metadata** from the dropdown.
   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=accad7d1c4ddf209781bff851d51d464" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png" />
   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=d5ec1f0f3742cadab8cd54c602c97239" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure core parameters for metadata extraction. The following fields are available:

     | Field                                 | Default | Description                                                                                                              |
     | ------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
     | Default Owner                         | —       | Owner applied to all entities when no specific level owner is configured. Accepts a user or team name/email.             |
     | Service Owner                         | —       | Owner assigned to the service entity.                                                                                    |
     | Database Owner                        | —       | Owner assigned to all ingested databases. Accepts a single owner or a per-database name mapping.                         |
     | Database Schema Owner                 | —       | Owner assigned to all ingested schemas. Accepts a single owner or a per-schema name mapping.                             |
     | Table Owner                           | —       | Owner assigned to all ingested tables. Accepts a single owner or a per-table name mapping.                               |
     | Enable Inheritance                    | On      | When on, child entities inherit the owner from their parent when they have no owner configured.                          |
     | Query Log Duration                    | 1       | Number of days to look back in query logs when processing stored procedure results.                                      |
     | Query Parsing Timeout Limit           | 300     | Timeout in seconds for parsing a single query.                                                                           |
     | Number of Threads                     | 1       | Number of threads to use for parallel table ingestion.                                                                   |
     | Incremental Extraction                | Off     | When enabled, subsequent runs only extract entities changed since the last successful run.                               |
     | Successful Pipeline Run Lookback Days | 7       | Number of days to search back for a prior successful run to use as a baseline for incremental extraction.                |
     | Safety Margin Days                    | 1       | Additional days added to the baseline timestamp as a buffer for incremental extraction.                                  |
     | JSON Schema Sample Size               | 10      | Number of rows sampled to infer JSON column schema. Only applies when Extract JSON Schema is enabled in Advanced Config. |

     <img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/database-agent-setup.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=429839e5b479082a6909dd2a7734513d" alt="Agent Setup" width="1570" height="1396" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/database-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. For more information about various filter options, see **Step 5: Configure Ingestion Options**.

     <img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/database-filter-pattern.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=8a0c5fcc3475acf8acc94e6eecb55a11" alt="Filter Patterns" width="1560" height="1030" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/database-filter-pattern.png" />

   * **Scope & Behaviour**: Control how the agent handles metadata during ingestion. Toggle each option on or off based on your needs:

     | Toggle                         | Default | Description                                                                                                                                                            |
     | ------------------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Include Tables                 | On      | Ingest table metadata from the source. Turn off to skip tables entirely.                                                                                               |
     | Include Tags                   | On      | Ingest tags from the source.                                                                                                                                           |
     | Include Stored Procedures      | On      | Ingest stored procedure metadata.                                                                                                                                      |
     | Include DDL Statements         | Off     | Ingest DDL statements alongside table metadata.                                                                                                                        |
     | Include Owners                 | Off     | Assign owners to ingested entities when the source owner's email matches a user in Collate. Does not overwrite an existing owner.                                      |
     | Include Custom Properties      | Off     | Ingest connector-specific custom properties onto entities.                                                                                                             |
     | Mark Deleted Tables            | On      | Soft-delete tables in Collate when they are removed from the source. Applies only within the currently ingested schema.                                                |
     | Mark Deleted Stored Procedures | On      | Soft-delete stored procedures in Collate when they are removed from the source.                                                                                        |
     | Mark Deleted Schemas           | Off     | Soft-delete schemas and all their child assets when removed from the source.                                                                                           |
     | Mark Deleted Databases         | Off     | Soft-delete databases and all their child assets when removed from the source.                                                                                         |
     | Override Metadata              | Off     | When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value. |
     | Enable Debug Log               | Off     | Sets the ingestion log level to DEBUG. Useful for troubleshooting.                                                                                                     |

     <Note>
       **Note**: Available toggles vary by connector. Stored procedure options only appear for connectors that support stored procedures.
     </Note>

     <img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/database-scope-behaviour.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=6ada5b2870c990f494d1dac400e73459" alt="Scope & Behaviour" width="1566" height="1436" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/database-scope-behaviour.png" />

   * **Advanced Config**: Optional connector-specific settings such as Include Views and Extract JSON Schema.

     <img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/database-advance.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=63ef86d9e746b6d31f0571b599792357" alt="Advanced Config" width="1564" height="352" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/database-advance.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule; trigger the agent manually when needed.

   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/schedule.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=25cc1d78f6f2a8bd115830d034d1d8d1" alt="Schedule Interval" width="1588" height="1044" data-path="public/images/ai-2.0/connectors/metadata-ingestion/schedule.png" />

6. Click **Add** to deploy the agent.

## Reverse Metadata

* **Description Management**: Oracle supports description updates at the following levels:
  * Table level
  * Column level

* **Owner Management**: Owner management is not supported for Oracle.

* **Tag Management**: Tag management is not supported for Oracle.

* **Custom SQL Template**: Oracle supports custom SQL templates for metadata changes. The template is interpreted using python f-strings.

  Here are examples of custom SQL queries for metadata changes:

  ```sql theme={null}
  -- Update column description
  COMMENT ON COLUMN {schema}.{table}.{column} IS {description}
  ```

  The list of variables for custom SQL can be found [here](/ai-2-0/admin-guide/applications/reverse-metadata#custom-sql-templates).

For more information about reverse metadata ingestion, see [Reverse Metadata Application](/ai-2-0/admin-guide/applications/reverse-metadata).

## Troubleshooting

<Columns cols={2}>
  <Card title="Oracle Troubleshooting" href="/ai-2-0/connectors/database/oracle/troubleshooting">
    Learn more about how to troubleshoot common Oracle connector issues and resolve configuration or ingestion errors.
  </Card>
</Columns>