Connect to and manage Oracle in Azure Purview

This article outlines how to register Oracle, and how to authenticate and interact with Oracle in Azure Purview. For more information about Azure Purview, read the introductory article.

Supported capabilities

Metadata Extraction Full Scan Incremental Scan Scoped Scan Classification Access Policy Lineage
Yes Yes No No No No Yes**

** Lineage is supported if dataset is used as a source/sink in Data Factory Copy activity

The supported Oracle server versions are 6i to 19c

Proxy server is not supported when scanning Oracle source.

Prerequisites

Register

This section describes how to register Oracle in Azure Purview using the Purview Studio.

Prerequisites for registration

A read-only access to system tables is required.

The user should have permission to create a session as well as role SELECT_CATALOG_ROLE assigned. Alternatively, the user may have SELECT permission granted for every individual system table that this connector queries metadata from:

grant create session to [user];
grant select on all_users to [user];
grant select on dba_objects to [user];
grant select on dba_tab_comments to [user];
grant select on dba_external_locations to [user];
grant select on dba_directories to [user];
grant select on dba_mviews to [user];
grant select on dba_clu_columns to [user];
grant select on dba_tab_columns to [user];
grant select on dba_col_comments to [user];
grant select on dba_constraints to [user];
grant select on dba_cons_columns to [user];
grant select on dba_indexes to [user];
grant select on dba_ind_columns to [user];
grant select on dba_procedures to [user];
grant select on dba_synonyms to [user];
grant select on dba_views to [user];
grant select on dba_source to [user];
grant select on dba_triggers to [user];
grant select on dba_arguments to [user];
grant select on dba_sequences to [user];
grant select on dba_dependencies to [user];
grant select on dba_type_attrs to [user];
grant select on V_$INSTANCE to [user];
grant select on v_$database to [user];

Authentication for registration

The only supported authentication for an Oracle source is Basic authentication.

Steps to register

To register a new Oracle source in your data catalog, do the following:

  1. Navigate to your Purview account in the Purview Studio.

  2. Select Data Map on the left navigation.

  3. Select Register

  4. On Register sources, select Oracle. Select Continue.

    register sources

On the Register sources (Oracle) screen, do the following:

  1. Enter a Name that the data source will be listed within the Catalog.

  2. Enter the Host name to connect to an Oracle source. This can either be:

    • A host name used by JDBC to connect to the database server. For example: MyDatabaseServer.com

    • An IP address. For example: 192.169.1.2

    • Its fully qualified JDBC connection string. For example:

      jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=on)(ADDRESS=(PROTOCOL=TCP)(HOST=oracleserver1)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=oracleserver2)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=oracleserver3)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=orcl)))

  3. Enter the Port number used by JDBC to connect to the database server (1521 by default for Oracle).

  4. Enter the Oracle service name used by JDBC to connect to the database server.

  5. Select a collection or create a new one (Optional)

  6. Finish to register the data source.

    register sources options

Scan

Follow the steps below to scan Oracle to automatically identify assets and classify your data. For more information about scanning in general, see our introduction to scans and ingestion.

Create and run scan

To create and run a new scan, do the following:

  1. In the Management Center, select Integration runtimes. Make sure a self-hosted integration runtime is set up. If it is not set up, use the steps mentioned here to create a self-hosted integration runtime.

  2. Navigate to Sources.

  3. Select the registered Oracle source.

  4. Select + New scan.

  5. Provide the below details:

    1. Name: The name of the scan

    2. Connect via integration runtime: Select the configured self-hosted integration runtime

    3. Credential: Select the credential to connect to your data source. Make sure to:

      • Select Basic Authentication while creating a credential.
      • Provide the user name used by JDBC to connect to the database server in the User name input field.
      • Store the user password used by JDBC to connect to the database server in the secret key.

    4. Schema: List subset of schemas to import expressed as a semicolon separated list. For example, schema1; schema2. All user schemas are imported if that list is empty. All system schemas (for example, SysAdmin) and objects are ignored by default. When the list is empty, all available schemas are imported.

      Acceptable schema name patterns using SQL LIKE expressions syntax include using %. For example: A%; %B; %C%; D

      • Start with A or
      • End with B or
      • Contain C or
      • Equal D

      Usage of NOT and special characters are not acceptable.

    5. Driver location: Specify the path to the JDBC driver location in your VM where self-host integration runtime is running. This should be the path to valid JAR folder location.

      Note

      The driver should be accessible to all accounts in the VM. Please do not install in a user account.

    6. Maximum memory available: Maximum memory (in GB) available on customer's VM to be used by scanning processes. This is dependent on the size of Oracle source to be scanned.

      Note

      As a rule of thumb, please provide 1GB memory for every 1000 tables

      scan oracle

  6. Select Continue.

  7. Choose your scan trigger. You can set up a schedule or ran the scan once.

  8. Review your scan and select Save and Run.

View your scans and scan runs

To view existing scans, do the following:

  1. Go to the Purview Studio. Select the Data Map tab under the left pane.

  2. Select the desired data source. You will see a list of existing scans on that data source under Recent scans, or can view all scans under the Scans tab.

  3. Select the scan that has results you want to view.

  4. This page will show you all of the previous scan runs along with the status and metrics for each scan run. It will also display whether your scan was scheduled or manual, how many assets had classifications applied, how many total assets were discovered, the start and end time of the scan, and the total scan duration.

Manage your scans - edit, delete, or cancel

To manage or delete a scan, do the following:

  1. Go to the Purview Studio. Select the Data Map tab under the left pane.

  2. Select the desired data source. You will see a list of existing scans on that data source under Recent scans, or can view all scans under the Scans tab.

  3. Select the scan you would like to manage. You can edit the scan by selecting Edit scan.

  4. You can cancel an in progress scan by selecting Cancel scan run.

  5. You can delete your scan by selecting Delete scan.

Note

  • Deleting your scan does not delete catalog assets created from previous scans.
  • The asset will no longer be updated with schema changes if your source table has changed and you re-scan the source table after editing the description in the schema tab of Purview.

Next steps

Now that you have registered your source, follow the below guides to learn more about Purview and your data.