Connect to and manage Oracle in Microsoft Purview

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

Supported capabilities

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

* Besides the lineage on assets within the data source, lineage is also supported if dataset is used as a source/sink in Data Factory or Synapse pipeline.

The supported Oracle server versions are 6i to 19c. Proxy server isn't supported when scanning Oracle source.

When scanning Oracle source, Microsoft Purview supports:

  • Extracting technical metadata including:

    • Server
    • Schemas
    • Packages
    • Tables including the columns, foreign keys, indexes, triggers and unique constraints
    • Views including the columns and triggers
    • Stored procedures including the parameter dataset and result set
    • Functions including the parameter dataset
    • Sequences
    • Synonyms
    • Types including the type attributes
  • Fetching static lineage on assets relationships among tables, views and stored procedures. Stored procedure lineage is supported for static SQL returning result set.

When setting up scan, you can choose to scan an entire Oracle server, or scope the scan to a subset of schemas matching the given name(s) or name pattern(s).

Currently, the Oracle service name isn't captured in the metadata or hierarchy.

Prerequisites

Required permissions for scan

Microsoft Purview supports basic authentication (username and password) for scanning Oracle. The Oracle user must have read access to system tables in order to access advanced metadata. For classification, user also needs to have read permission on the tables/views to retrieve sample data.

The user should have permission to create a session and 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];

Register

This section describes how to register Oracle in Microsoft Purview using the Microsoft Purview governance portal.

Steps to register

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

  1. Navigate to your Microsoft Purview account in the Microsoft Purview governance portal.

  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 to connect to the database server. For example: MyDatabaseServer.com
    • An IP address. For example: 192.169.1.2
  3. Enter the Port number used to connect to the database server (1521 by default for Oracle).

  4. Enter the Oracle service name (not Oracle UID) used 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. For more information about scanning in general, see our introduction to scans and ingestion.

Tip

To troubleshoot any issues with scanning:

  1. Confirm you have followed all prerequisites.
  2. Review our scan troubleshooting documentation.

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 isn't 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 to connect to the database server in the User name input field.
      • Store the user password used to connect to the database server in the secret key.
    4. Schema: List subset of schemas to import expressed as a semicolon separated list in case-sensitive manner. 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.

      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 aren't acceptable.

    5. Driver location: Specify the path to the JDBC driver location in your machine where self-host integration runtime is running, for example, D:\Drivers\Oracle. It's the path to valid JAR folder location. Make sure the driver is accessible by the self-hosted integration runtime, learn more from prerequisites section.

    6. Stored procedure details: Controls the number of details imported from stored procedures:

      • Signature: The name and parameters of stored procedures.
      • Code, signature: The name, parameters and code of stored procedures.
      • Lineage, code, signature: The name, parameters and code of stored procedures, and the data lineage derived from the code.
      • None: Stored procedure details aren't included.
    7. 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 Test connection.

    Note

    Use the "Test connection" button in the scan setup UI to test the connection. The "Test Connection" in self-hosted integration runtime configuration manager UI -> Diagnostics tab does not fully validate the connectivity.

  7. Select Continue.

  8. Select a scan rule set for classification. You can choose between the system default, existing custom rule sets, or create a new rule set inline.

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

  10. Review your scan and select Save and Run.

View your scans and scan runs

To view existing scans:

  1. Go to the Microsoft Purview governance portal. Select the Data map tab on the left pane.
  2. Select the desired data source. You can view a list of existing scans on that data source under Recent scans, or you can view all scans on the Scans tab.
  3. Select the scan that has results you want to view. The page shows you all of the previous scan runs, along with the status and metrics for each scan run.
  4. Click the run ID to check more about the scan run details.

Manage your scans - edit, delete, or cancel

To manage or delete a scan:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab on the left pane.

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

  3. Select the scan that you want to manage. You can then:

    • Edit the scan by selecting Edit scan.
    • Cancel an in-progress scan by selecting Cancel scan run.
    • 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 on the Schema tab of Microsoft Purview.

Lineage

After scanning your Oracle source, you can browse data catalog or search data catalog to view the asset details.

Go to the asset -> lineage tab, you can see the asset relationship when applicable. Refer to the supported capabilities section on the supported Oracle lineage scenarios. For more information about lineage in general, see data lineage and lineage user guide.

Oracle lineage view

Next steps

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