We use cookies to improve site navigation, analyze site usage, and enhance your user experience. Click "Accept" to enable cookies or "Reject" to reject cookies.

main-concepts

No menu items for this category
Home/Main Concepts/Metadata Standard/Schemas/Entity/Services/Connections/Database/Oracleconnection
OpenMetadata Documentation

OracleConnection

Oracle Database Connection Config

Properties

  • type: Service Type. Refer to #/definitions/oracleType. Default: Oracle.
  • scheme: SQLAlchemy driver scheme options. Refer to #/definitions/oracleScheme. Default: oracle+cx_oracle.
  • username (string): Username to connect to Oracle. This user should have privileges to read all the metadata in Oracle.
  • password (string): Password to connect to Oracle.
  • hostPort (string): Host and port of the Oracle service.
  • oracleConnectionType (object): Connect with oracle by either passing service name or database schema name.
  • instantClientDirectory (string): This directory will be used to set the LD_LIBRARY_PATH env variable. It is required if you need to enable thick connection mode. By default, we bring instant client 19 and point to /instantclient. Default: /instantclient.
  • databaseName (string): Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
  • connectionOptions: Refer to ../connectionBasicType.json#/definitions/connectionOptions.
  • connectionArguments: Refer to ../connectionBasicType.json#/definitions/connectionArguments.
  • schemaFilterPattern: Regex to only include/exclude schemas that matches the pattern. Refer to ../../../../type/filterPattern.json#/definitions/filterPattern. Default: {'includes': [], 'excludes': ['^sys$', '^ctxsys$', '^dbsnmp$', '^outln$']}.
  • tableFilterPattern: Regex to only include/exclude tables that matches the pattern. Refer to ../../../../type/filterPattern.json#/definitions/filterPattern.
  • databaseFilterPattern: Regex to only include/exclude databases that matches the pattern. Refer to ../../../../type/filterPattern.json#/definitions/filterPattern.
  • supportsMetadataExtraction: Refer to ../connectionBasicType.json#/definitions/supportsMetadataExtraction.
  • supportsUsageExtraction: Refer to ../connectionBasicType.json#/definitions/supportsUsageExtraction.
  • supportsLineageExtraction: Refer to ../connectionBasicType.json#/definitions/supportsLineageExtraction.
  • supportsDBTExtraction: Refer to ../connectionBasicType.json#/definitions/supportsDBTExtraction.
  • supportsProfiler: Refer to ../connectionBasicType.json#/definitions/supportsProfiler.
  • supportsQueryComment: Refer to ../connectionBasicType.json#/definitions/supportsQueryComment.
  • supportsDataDiff: Refer to ../connectionBasicType.json#/definitions/supportsDataDiff.
  • sampleDataStorageConfig: Refer to ../connectionBasicType.json#/definitions/sampleDataStorageConfig.

Definitions

  • oracleType (string): Service type. Must be one of: ['Oracle']. Default: Oracle.
  • oracleScheme (string): SQLAlchemy driver scheme options. Must be one of: ['oracle+cx_oracle']. Default: oracle+cx_oracle.
  • OracleDatabaseSchema (object)
    • databaseSchema (string): databaseSchema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single databaseSchema. When left blank, OpenMetadata Ingestion attempts to scan all the databaseSchema.
  • OracleServiceName (object)
    • oracleServiceName (string): The Oracle Service name is the TNS alias that you give when you remotely connect to your database.
  • OracleTNSConnection (object)
    • oracleTNSConnection (string): Pass the full constructed TNS string, e.g., (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=myhost)(PORT=1530)))(CONNECT_DATA=(SID=MYSERVICENAME))).

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.