## Crawl Oracle

URL: https://docs.atlan.com/apps/connectors/database/oracle/how-tos/crawl-oracle

> Crawl metadata from Oracle Database to catalog schemas, tables, views, and columns. Extract lineage and asset information after configuring user permissions and database connectivity.

Create a crawler workflow to automatically discover and catalog your [Oracle](https://docs.atlan.com/llms/connectors/oracle/set-up-oracle/llms.txt) database assets, including schemas, tables, views, and columns. After configuring the necessary user permissions and connectivity, you can extract metadata to enable data discovery, lineage tracking, and governance. Review the [order of operations](https://docs.atlan.com/llms/catalog/connector-capabilities/order-workflows/llms.txt) for metadata enrichment workflows before starting.

## Prerequisites

Before you begin, make sure you have:

* Oracle Database version 11.2 or later
* Configured [Oracle user permissions](https://docs.atlan.com/llms/connectors/oracle/set-up-oracle/llms.txt) with metadata read access
* Oracle database connection details (host, port, SID/Service Name, credentials)
* Reviewed the [order of operations](https://docs.atlan.com/llms/catalog/connector-capabilities/order-workflows/llms.txt) for workflow execution

## Create crawler workflow

Create a new Oracle crawler workflow in Atlan by selecting the Oracle connector package, configuring your extraction method and connection details, and running the crawler to extract metadata.

1. In your Atlan workspace, click **Connectors** in the left sidebar.
 * If you are using the **Old UI (Classic)**, click **New Workflow** in the top navigation.

2. Click **Marketplace**.

3. Search for **Oracle Assets** and select it.

4. Click **Install**.

5. Once installation completes, click **Setup Workflow** on the same tile.

### Configure extraction

Select your extraction method and provide the connection details.

:::warning Offline extraction sunset
The offline extraction method has been sunset and is no longer available. For on-premises or network-restricted environments, use the **Agent** extraction method with [Self-Deployed Runtime](https://docs.atlan.com/llms/platform/self-deployed-runtime/llms.txt).
:::

### Direct

In **Direct** extraction, Atlan connects to your database and crawls metadata directly.

 - For _Host Name_, enter the host for your Oracle instance.
 - For _Port_, enter the port number of your Oracle instance.
 - For _Username_ and _Password_, enter the [credentials you created when configuring permissions](https://docs.atlan.com/llms/connectors/oracle/set-up-oracle/llms.txt).
 - For _SID/Service Name_, enter the Oracle system identifier or service name for your database.
 - For _Default Database Name_, enter the database name (usually the same as the SID or service name).
 - To connect over TCPS, [set up TCPS](https://docs.atlan.com/llms/connectors/oracle/set-up-oracle/llms.txt) on your Oracle database, then:
 - Select **TCPS** as the connection protocol.
 - Package your Oracle Wallet directory into a `.zip` file, then click **Upload Wallet** to upload it. Atlan requires the wallet in `.zip` format.
 - If your Oracle Wallet is password-protected, enter the wallet password in the **Wallet Password** field.
 - Click **Test Authentication** to confirm connectivity to Oracle using these details.

### Agent

In **Agent** extraction, Self-Deployed Runtime executes metadata extraction within your organization's environment.

1. Install Self-Deployed Runtime if you haven't already:
 - [Install via Docker Compose](https://docs.atlan.com/llms/platform/self-deployed-runtime/install-on-docker-compose/llms.txt)
 - [Install on Kubernetes](https://docs.atlan.com/llms/platform/self-deployed-runtime/install-on-kubernetes/llms.txt)
2. Select the **Agent** tab.

3. Store sensitive information in the secret store configured with the Self-Deployed Runtime and reference the secrets in the corresponding fields. For more information, see [Configure secrets for workflow execution](https://docs.atlan.com/llms/platform/self-deployed-runtime/configure-workflow-execution/llms.txt).

4. For details on individual fields, including TCPS configuration, refer to the Direct extraction tab.

5. Click **Next** after completing the configuration.

### Configure connection

Set up connection details including a descriptive name, admin access, and data access permissions.

1. Provide a _Connection Name_ that represents your source environment. For example, you might use values like `production`, `development`, `gold`, or `analytics`.

2. To change the users able to manage this connection, update the users or groups listed under _Connection Admins_. If you don't specify any user or group, nobody can manage the connection, including admins.

3. To prevent users from querying Oracle data, change _Allow SQL Query_ to **No**. This option applies only to Direct extraction.

4. To prevent users from previewing Oracle data, change _Allow Data Preview_ to **No**. This option applies only to Direct extraction.

5. Click **Next** at the bottom of the screen.

### Configure crawler

Configure crawler settings to control which assets to include or exclude. If an asset appears in both filters, the exclude filter takes precedence.

1. To select specific assets for crawling, click **Include Metadata**. By default, all assets are included.

2. To exclude specific assets from crawling, click **Exclude Metadata**. By default, no assets are excluded.

3. To ignore tables and views based on a naming pattern, enter a regular expression in the _Exclude regex for tables & views_ field.

### Run crawler

Run preflight checks to validate your configuration, then execute the crawler immediately or schedule it to run on a recurring basis.

1. To verify [permissions and configuration](https://docs.atlan.com/llms/connectors/oracle/preflight-checks-for-oracle/llms.txt) before running, click **Preflight checks**. This option is available for Direct extraction only.

2. Choose your run option:
 - To run the crawler once immediately, click **Run** at the bottom of the screen.
 - To schedule the crawler to run hourly, daily, weekly, or monthly, click **Schedule Run** at the bottom of the screen.

Once the crawler completes, you can view the assets in Atlan's asset page.

## See also

* [What does Atlan crawl from Oracle](https://docs.atlan.com/llms/connectors/oracle/what-does-atlan-crawl-from-oracle/llms.txt): Complete reference of assets and metadata discovered during crawling
* [Preflight checks for Oracle](https://docs.atlan.com/llms/connectors/oracle/preflight-checks-for-oracle/llms.txt): Validation checks for permissions and configuration before running the crawler

---