To access your data in Oracle, create a connection asset for it.
Oracle is a multi-model database management system.
Supported versions
- Oracle Database 19c and 21c
Create a connection to Oracle
To create the connection asset, you need the following connection details:
-
Service name or Database (SID)
-
Hostname or IP address
-
Port number
-
Username and password
-
SSL certificate (if required by the database server)
-
Alternate servers: A list of alternate database servers to use for failover for new or lost connections.
Syntax:(servername1[:port1][;property=value[;...]][,servername2[:port2][;property=value[;...]]]...)
The server name (servername1
,servername2
, and so on) is required for each alternate server entry. The port number (port1
,port2
, and so on) and the connection properties (property=value
) are optional for each alternate server entry. If the port is unspecified, the port number of the primary server is used.
If the port number of the primary server is not specified, the default port number1521
is used.
The optional connection properties are theServiceName
andSID
. -
Metadata discovery: The setting determines whether comments on columns (remarks) and aliases for schema objects such as tables or views (synonyms) are retrieved when assets are added by using this connection.
Select Server proxy to access the Oracle data source through a server proxy. Depending on its setup, a server proxy can provide load balancing, increased security, and privacy. The server proxy settings are independent of the authentication credentials and the personal or shared credentials selection. The server proxy settings cannot be stored in a vault.
- Proxy hostname or IP address: The proxy URL. For example, https://proxy.example.com.
- Server proxy port: The port number to connect to the proxy server. For example, 8080 or 8443.
- The Proxy username and Proxy password fields are optional.
For Private connectivity, to connect to a database that is not externalized to the internet (for example, behind a firewall), you must set up a secure connection.
Choose the method for creating a connection based on where you are in the platform
- In a project
- Click Assets > New asset > Connect to a data source. See Adding a connection to a project.
- In a catalog
- Click Add to catalog > Connection. See Adding a connection asset to a catalog.
- In a deployment space
- Click Import assets > Data access > Connection. See Adding data assets to a deployment space.
- In the Platform assets catalog
- Click New connection. See Adding platform connections.
Next step: Add data assets from the connection
Where you can use this connection
You can use Oracle connections in the following workspaces and tools:
Projects
- Data quality rules (IBM Knowledge Catalog)
- Data Replication (Data Replication service). You can replicate data from Oracle to other databases using Data Replication. For more information, see Replicating Oracle data.
- Data Refinery (watsonx.ai Studio or IBM Knowledge Catalog)
- DataStage (DataStage service). For more information, see Connecting to a data source in DataStage. The Oracle Database for DataStage connection gives you increased performance and more features such as before and after SQL statements and reject links. However, you cannot use the Oracle Database for DataStage connection outside of the DataStage service.
- Decision Optimization (watsonx.ai Studio and watsonx.ai Runtime)
- Metadata enrichment (IBM Knowledge Catalog)
- Metadata import (IBM Knowledge Catalog)
- SPSS Modeler (watsonx.ai Studio)
Catalogs
-
Platform assets catalog
-
Other catalogs (IBM Knowledge Catalog)
Data lineage
- Metadata import (lineage) (IBM Knowledge Catalog and IBM Manta Data Lineage)
- Data Virtualization service
- You can connect to this data source from Data Virtualization.
Oracle setup
Running SQL statements
To ensure that your SQL statements run correctly, refer to the Oracle Supported SQL Syntax and Functions for the correct syntax.
Configuring lineage metadata import for Oracle
When you create a metadata import for the Oracle connection, you can set options specific to this data source, and define the scope of data for which lineage is generated. For details about metadata import, see Designing metadata imports.
To import lineage metadata for Oracle, complete these steps:
- Create a data source definition. Select Oracle as the data source type. The Database (SID) or Service name field is required.
- Create a connection to the data source in a project.
- Create a metadata import. Learn more about options that are specific to Oracle data source:
- When you define a scope, you can analyze the entire data source or use the include and exclude options to define the exact schemas that you want to be analyzed. See Include and exclude lists.
- Optionally, you can provide external input in the form of a .zip file. You add this file in the Add inputs from file field. The file must have a supported structure. See External inputs.
- Optionally, specify advanced import options.
Include and exclude lists
You can include or exclude assets up to the schema level. Each value is evaluated as a regular expression. Assets which are added later in the data source will also be included or excluded if they match the conditions specified in the lists. Example values:
mySchema
:mySchema
schema.mySchema[1-5]
: any schema with a name that starts withmySchema
and ends with a digit between 1 and 5.
External inputs
If you use external Oracle PL/SQL scripts, you can add them in a .zip file as an external input. You can organize the structure of a .zip file as subfolders that represent schemas. After the scripts are scanned, they are added under respective schemas in the selected catalog or project. The .zip file can have the following structure:
<schema_name>
<script_name.sql>
<script_name.sql>
replace.csv
The replace.csv
file contains placeholder replacements for the scripts that are added in the .zip file. For more information about the format, see Placeholder replacements.
Advanced import options
- Extract extended attributes
- You can extract extended attributes like primary key, unique and referential integrity constraints of columns. By default these attributes are not extracted.
- Extract invalid objects
- Include invalid objects in extraction.
- Extraction mode
- You can decide which extraction mode to run for the imported metadata. You have the following options:
- Prefetch: use it for relational databases.
- Parallel bulk: use it for analytical processing engines.
- Single-thread: use it to avoid parallelism and large queries during extraction. When you select this mode, performance might be low.
- Transformation logic extraction
- You can enable building transformation logic descriptions from SQL code in SQL scripts.
- Dynamic SQL
- Enable dynamic SQL processing in DDL scripts.
Learn more
Parent topic: Supported connections