diff --git a/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/airflow.md b/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/airflow.md index 53ae41edafc..c9cb2ce7487 100644 --- a/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/airflow.md +++ b/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/airflow.md @@ -43,7 +43,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -**Note**: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +**Note**: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have `CREATE SESSION` privilege for the user. diff --git a/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/cli.md b/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/cli.md index 485481190c0..2ca05e99287 100644 --- a/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/cli.md +++ b/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/cli.md @@ -45,7 +45,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -**Note**: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +**Note**: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have `CREATE SESSION` privilege for the user. diff --git a/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/index.md b/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/index.md index 6a135dca3e8..34caf80ffb0 100644 --- a/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/index.md +++ b/openmetadata-docs-v1/content/v0.13.2/connectors/database/oracle/index.md @@ -63,7 +63,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -**Note**: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +**Note**: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have `CREATE SESSION` privilege for the user. diff --git a/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/airflow.md b/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/airflow.md index 50f0ecf65ad..635a1027d7d 100644 --- a/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/airflow.md +++ b/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/airflow.md @@ -43,7 +43,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -**Note**: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +**Note**: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have `CREATE SESSION` privilege for the user. diff --git a/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/cli.md b/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/cli.md index d6fc93a619d..026a1ccd96e 100644 --- a/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/cli.md +++ b/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/cli.md @@ -45,7 +45,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -**Note**: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +**Note**: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have `CREATE SESSION` privilege for the user. diff --git a/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/index.md b/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/index.md index 72e8e4b2fa0..4188f97a080 100644 --- a/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/index.md +++ b/openmetadata-docs-v1/content/v1.0.0/connectors/database/oracle/index.md @@ -63,7 +63,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -**Note**: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +**Note**: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have `CREATE SESSION` privilege for the user. diff --git a/openmetadata-docs/content/connectors/database/oracle/airflow.md b/openmetadata-docs/content/connectors/database/oracle/airflow.md index 6ce3bbfd6e7..897f073b97c 100644 --- a/openmetadata-docs/content/connectors/database/oracle/airflow.md +++ b/openmetadata-docs/content/connectors/database/oracle/airflow.md @@ -37,7 +37,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -Note: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +Note: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have following permissions: diff --git a/openmetadata-docs/content/connectors/database/oracle/cli.md b/openmetadata-docs/content/connectors/database/oracle/cli.md index 6c5a517784d..0518cc4ff00 100644 --- a/openmetadata-docs/content/connectors/database/oracle/cli.md +++ b/openmetadata-docs/content/connectors/database/oracle/cli.md @@ -37,7 +37,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -Note: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +Note: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have following permissions: 1. `CREATE SESSION` privilege for the user. diff --git a/openmetadata-docs/content/connectors/database/oracle/index.md b/openmetadata-docs/content/connectors/database/oracle/index.md index 2b0d767fa1e..7fe6e51a224 100644 --- a/openmetadata-docs/content/connectors/database/oracle/index.md +++ b/openmetadata-docs/content/connectors/database/oracle/index.md @@ -58,7 +58,7 @@ To deploy OpenMetadata, check the Deployment guides. To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. -Note: To fetch metadata from oracle db we use python-oracledb and this support 12c, 18c, 19c and 21c versions! +Note: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. To ingest metadata from oracle user must have following permissions: 1. `CREATE SESSION` privilege for the user. diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Oracle.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Oracle.md index b786a2f3c88..805042730bd 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Oracle.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Oracle.md @@ -3,7 +3,11 @@ In this section, we provide guides and references to use the Oracle connector. ## Requirements -To ingest metadata from Oracle, a user must have `CREATE SESSION` privilege. + +Note: To retrieve metadata from an Oracle database, the python-oracledb library can be utilized, which provides support for versions 12c, 18c, 19c, and 21c. + +To ingest metadata from oracle user must have following permissions: +1. `CREATE SESSION` privilege for the user. ```sql -- CREATE USER @@ -12,14 +16,27 @@ CREATE USER user_name IDENTIFIED BY admin_password; -- CREATE ROLE CREATE ROLE new_role; --- GRANT ROLE TO USER +-- GRANT ROLE TO USER GRANT new_role TO user_name; -- GRANT CREATE SESSION PRIVILEGE TO USER GRANT CREATE SESSION TO new_role; + ``` -**Important:** To fetch metadata from Oracle database we use `python-oracledb`. This library only supports Oracle 12c, 18c, 19c and 21c versions! +2. `GRANT SELECT` on the relevant tables which are to be ingested into OpenMetadata to the user +```sql + +GRANT SELECT ON table_name TO {user | role}; + +``` + +### Profiler & Data Quality +Executing the profiler worflow or data quality tests, will require the user to have `SELECT` permission on the tables/schemas where the profiler/tests will be executed. More information on the profiler workflow setup can be found [here](https://docs.open-metadata.org/connectors/ingestion/workflows/profiler) and data quality tests [here](https://docs.open-metadata.org/connectors/ingestion/workflows/data-quality). + +### Usage & Lineage +For the usage and lineage workflow, the user will need `SELECT` privilege. You can find more information on the usage workflow [here](https://docs.open-metadata.org/connectors/ingestion/workflows/usage) and the lineage workflow [here](https://docs.open-metadata.org/connectors/ingestion/workflows/lineage). + You can find further information on the Oracle connector in the [docs](https://docs.open-metadata.org/connectors/database/oracle). @@ -28,7 +45,7 @@ You can find further information on the Oracle connector in the [docs](https://d $$section ### Scheme $(id="scheme") -SQLAlchemy driver scheme options. +**oracle+cx_oracle**: Sqlalchemy scheme to connect to Oracle. $$ $$section @@ -46,21 +63,29 @@ $$ $$section ### Host Port $(id="hostPort") -Host and port of the Oracle service. +Host and port of the oracle service. This should be specified as a string in the format 'hostname:port'. +**Example**: `localhost:1521` $$ $$section ### Oracle Connection Type $(id="oracleConnectionType") Connect with oracle by either passing service name or database schema name. - + +- **Database Schema**: Using a database schema name when connecting to an Oracle database allows the user to access only the objects within that schema, rather than the entire database. +- **Oracle Service Name**: Oracle Service Name is a unique identifier for a database instance or group of instances that perform a particular function. $$ $$section -### Oracle Connection Type $(id="oracleConnectionType") +### Oracle Service Name $(id="oracleServiceName") -Connect with oracle by either passing service name or database schema name. - +The Oracle Service Name is the TNS alias that you give when you remotely connect to your database and this Service name is recorded in tnsnames. +$$ + +$$section +### Database Schema $(id="databaseSchema") + +The name of the Database Schema available in Oracle that you want to connect with. $$ $$section @@ -72,13 +97,14 @@ $$ $$section ### Connection Options $(id="connectionOptions") -Additional connection options to build the URL that can be sent to service during the connection. - +Enter the details for any additional connection options that can be sent to Oracle during the connection. These details must be added as Key-Value pairs. $$ $$section ### Connection Arguments $(id="connectionArguments") -Additional connection arguments such as security or protocol configs that can be sent to service during connection. - +Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Oracle during the connection. These details must be added as Key-Value pairs. +- In case you are using Single-Sign-On (SSO) for authentication, add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "sso_login_url"`. +- In case you authenticate with SSO using an external browser popup, then add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "externalbrowser"`. + $$