domino logo
Tech Ecosystem
Get Started
Get started with Python
Step 0: Orient yourself to DominoStep 1: Create a projectStep 2: Configure your projectStep 3: Start a workspaceStep 4: Get your files and dataStep 5: Develop your modelStep 6: Clean up WorkspacesStep 7: Deploy your model
Get started with R
Step 0: Orient yourself to Domino (R Tutorial)Step 1: Create a projectStep 2: Configure your projectStep 3: Start a workspaceStep 4: Get your files and dataStep 5: Develop your modelStep 6: Clean up WorkspacesStep 7: Deploy your model
Get Started with MATLAB
Step 1: Orient yourself to DominoStep 2: Create a ProjectStep 3: Configure Your ProjectStep 4: Start a MATLAB WorkspaceStep 5: Fetch and Save Your DataStep 6: Develop Your ModelStep 7: Clean Up Your Workspace
Step 8: Deploy Your Model
Scheduled JobsLaunchers
Step 9: Working with Datasets
Domino Reference Projects
Search in Deployments
Security and Credentials
Secure Credential Storage
Store Project CredentialsStore User CredentialsStore Model Credentials
Get API KeyUse a Token for AuthenticationCreate a Mirror of Compute Environments
Collaborate
Share and Collaborate on Projects
Set Project VisibilityInvite CollaboratorsCollaborator Permissions
Add Comments
Reuse Work
Set Up ExportsSet Up Imports
Organizations
Organization PermissionsTransfer Projects to an Organization
Projects
Domino File System Projects
Domino File SystemOrganize Domino File System Project AssetsImport Git RepositoriesWork from a Commit ID in GitFork ProjectsMerge Projects
Manage Project Files
Upload Files to DominoCompare File RevisionsExclude Project Files From SyncExport Files as Python or R Package
Archive a Project
Revert Projects and Files
Revert a FileRevert a Project
Git-based Projects
Git-based Project Directory StructureCreate a Git-based ProjectCreate a New RepositoryOrganize Git-based Project AssetsChange Branches in the WorkspaceDevelop Models in a WorkspaceResolve Merge ConflictsSync ChangesPull ChangesResolve Conflicts ManuallySave Artifacts to the Domino File SystemPull Artifacts from the Domino File System
Project FilesSet Project SettingsStore Project Credentials
Project Goals
Add GoalsEdit GoalsLink Work to Goals
Organize Projects with TagsSet Project Stages
Project Status
Set Project as BlockedSet Project as CompleteSet Project as Unblocked
View Execution DetailsView Project ActivityTrack Project StatusRename a Project
Share and Collaborate
Set Project VisibilityInvite CollaboratorsCollaborator Permissions
Export and Import Project Content
Set Up ExportsSet Up Imports
See the Assets for Your ProjectPromote Projects to ProductionTransfer Project OwnershipIntegrate Jira
Domino Datasets
Manage Large DataDatasets Best PracticesCreate a DatasetUse an Existing DatasetFile Location of Datasets in Projects
Datasets and Snapshots
Update a DatasetAdd Tags to SnapshotsCreate a Snapshot of a DatasetDelete Snapshots of DatasetsDelete a Dataset
Upgrade from Versions Prior to 4.5
External Data
Considerations for Connecting to External Data
Domino Data Sources
Connect to Data Sources
Connect to DataRobotConnect to IBM NetezzaConnect to ImpalaConnect to MSSQLConnect to MySQLConnect to OkeraConnect to Oracle DatabaseConnect to Palantir FoundryConnect to PostgreSQLConnect to RedshiftConnect to SnowflakeConnect to TeradataConnect to Azure Data Lake StorageConnect to Amazon S3 from DominoConnect to BigQueryConnect to Google Cloud StorageConnect to Generic S3Connect to IBM DB2
Reference Data Sources in ProjectsRetrieve DataCreate a Data Source(Admininstrator) Create a Data Source
External Data Volumes
Mount an External VolumeView Mounted VolumesUse a Mounted VolumeUmount a Volume
Tips: Transfer Data Over a Network
Workspaces
Create a Workspace
Open a VS Code WorkspaceSet Custom Preferences for RStudio Workspaces
Workspace Settings
Edit Workspace SettingsChange Your Workspace's Volume SizeConfigure Long-Running Workspaces
Save Work in a WorkspaceSync ChangesView WorkspacesStop a WorkspaceResume a WorkspaceDelete a WorkspaceView Workspace LogsView Workspace UsageView Workspace HistoryWork with Legacy Workspaces
Use Git in Your Workspace
Commit and Push Changes to Your Git RepositoryCommit All Changes to Your Git RepositoryPull the Latest Changes from Your Git RepositoryResolve Merge Conflicts
Checkpoints
Create a Workspace from a Checkpoint
Run Multiple Applications in a Workspace
Clusters
Spark on Domino
Hadoop and Spark Overview
Connect to a Cloudera CDH5 cluster from DominoConnect to a Hortonworks cluster from DominoConnect to a MapR cluster from DominoConnect to an Amazon EMR cluster from DominoRun Local Spark on a Domino ExecutorUse PySpark in Jupyter WorkspacesKerberos Authentication
On-Demand Spark Overview
Validated Spark VersionConfigure PrerequisitesWork with your ClusterManage DependenciesWork with Data
On-Demand Ray Overview
Validated Ray VersionConfigure PrerequisitesWork with your ClusterManage DependenciesWork with Data
On-Demand Dask Overview
Validated Dask VersionConfigure PrerequisitesWork with Your ClusterManage DependenciesWork with Data
On-Demand Open MPI
Configure MPI PrerequisitesFile Sync MPI ClustersValidate MPI VersionWork with your ClusterManage Dependencies
Environments
Set a Default EnvironmentCreate an EnvironmentEdit Environment DefinitionView Your EnvironmentsView Environment RevisionsDuplicate an EnvironmentArchive an Environment
Environments
Example: Create a New Environment
Customize Environments
Install Custom Packages with Git IntegrationReplace Default Environment Tools
Add Packages to Environments
Use Dockerfile InstructionsUse requirements.txt (Python only)Use the Execution to Add a PackageInstall Packages for Model Monitoring
Add Workspace IDEsAdd a Scala KernelEnable Custom Images for PublishingAccess Additional Domains and HostnamesUse TensorBoard in Jupyter Workspaces
Use External Images in Domino Environments
Create a Domino Image with an NGC ContainerPre-requisites for Automatic Custom Image CompatibilityCreate a Domino Environment with a Pre-Built ImageManually Create an Environment with a Pre-Built Image
Use Partner Environments
Use MATLAB as a WorkspaceUse Stata as a WorkspaceUse SAS as a Workspace
Executions
Execution StatesDomino Environment Variables
Jobs
Start a JobScheduled Jobs
Launchers
Launchers OverviewCreate a LauncherRun a LauncherCopy Launcher Definitions
View Job DetailsCompare JobsTag JobsStop JobsView Execution Performance
Execution Notifications
Set Notification PreferencesSet Custom Execution Notifications
Execution Results
Download Execution ResultsCustomize the Results DashboardAutomate Complex Pipelines with Apache Airflow
Model APIs
Configure a Model for Deployment
Scale Models
Scale Python ModelsScale Model Versions
Configure Compute ResourcesRoute Your ModelProject Files in ModelsEnvironments for ModelsShare and Collaborate on Models
Publish
Model APIs
Publish a ModelSend Test Calls to the ModelPublish a New Version of a ModelSelect How to Authorize a Model
Externally-Hosted Models
Model Requirements
Use Domino's REST API to Export a Model
Export Model ImageExport to NVIDIA Fleet Command
Create an ExportCheck the Status of an ExportPush a New VersionSet up Monitoring for an ExportArchive an ExportView Monitoring StatusTroubleshooting Exports
Domino Apps
Publish a Domino AppHost HTML Pages from DominoGrant Access to Domino AppsView a Domino AppView All Domino AppsIdentify Resources to WhitelistPublish a Python App with DashPublish an R App with ShinyPublish a Project as a Website with FlaskOptimize App Scalability and PerformanceGet the Domino Username of an App Viewer
Launchers
Create a LauncherRun a LauncherCopy Launcher Definitions
Model Monitoring and Remediation
Monitor WorkflowsData Drift and Quality Monitoring
Set up Monitoring for Model APIs
Set up Prediction CaptureSet up Drift DetectionSet up Model Quality MonitoringSet up NotificationsSet Scheduled ChecksSet up Cohort Analysis
Set up Model Monitor
Connect a Data SourceRegister a ModelSet up Drift DetectionSet up Model Quality MonitoringSet up Cohort AnalysisSet up NotificationsSet Scheduled ChecksUnregister a Model
Use Monitoring
Access the Monitor DashboardAnalyze Data DriftAnalyze Model QualityExclude Features from Scheduled Checks
Remediation
Cohort Analysis
Review the Cohort Analysis
Remediate a Model API
Monitor Settings
API TokenHealth DashboardNotification ChannelsTest Defaults
Monitoring Config JSON
Supported Binning Methods
Model Monitoring APIsTroubleshoot the Model Monitor
Event Notifications
Domino Command Line Interface (CLI)
Install the Domino Command Line Interface (CLI)Domino CLI ReferenceDownload Files with the CLIForce-Restore a Local ProjectMove a Project Between DeploymentsUse the Domino CLI Behind a Proxy
Troubleshooting
Troubleshoot Domino ModelsWork with Many FilesTroubleshoot Imports
Get Help
Additional ResourcesGet Domino VersionContact Technical SupportSupport BundlesBrowser SupportUser Guide Updates
domino logo
About Domino
Domino Data LabKnowledge BaseData Science BlogTraining
User Guide
>
External Data
>
Domino Data Sources
>
Connect to Data Sources
>
Connect to Oracle Database

Connect to Oracle Database

This topic describes how to connect to Oracle from Domino. Oracle Database is a proprietary relational database available as a cloud service or enterprise on-premises solution.

Domino recommends that you use a Domino Data Source to connect to an Oracle instance from Domino.

Create an Oracle data source

  1. From the navigation pane, click Data.

  2. Click Create a Data Source.

  3. In the New Data Source window, from Select Data Store, select Oracle.

    oracle newds

  4. Enter the Host, Port, and name of the Database.

  5. Enter the Data Source Name.

  6. Optional: Enter a Description to explain the purpose of the data source to others.

  7. Click Next.

  8. Enter the Username and Password to connect to Oracle. The Domino secret store backed by HashiCorp Vault securely stores the credentials.

  9. Click Test Credentials.

  10. If the data source authenticates, click Next.

  11. Select who can view and use the data source in projects.

  12. Click Finish Setup.

Alternate way to connect to Oracle

Warning
  1. Before you can connect to Oracle, you must install the following client software your environment:

    • The basic package: instantclient-basic-linux.x64-<oracle-version>dbru.zip

    • The SDK package: instantclient-sdk-linux.x64-<oracle-version>dbru.zip

      You must download download these files from the Instant Client Downloads page.

      1. Use your Oracle customer login.

      2. Host an internal mirror of the files somewhere accessible to your Domino hosts.

      3. Install the software manually. In the example environments in this topic, these files are retrieved from a private S3 bucket with wget. You must make them available in a similar manner for your Domino deployment.

Python and cs_Oracle

  1. To interact with Oracle databases from Python, Domino recommends the cx_Oracle library.

  2. Use the following Dockerfile instruction to install the Oracle client drivers and cx_Oracle in your environment.

    Note
    USER root
    
    RUN \
        wget https://s3-us-west-2.amazonaws.com/<s3-bucket-name>/instantclient-basic-linux.x64-12.1.0.2.0.zip \
             -O /home/ubuntu/instantclient-basic-linux.x64-12.1.0.2.0.zip && \
        wget https://s3-us-west-2.amazonaws.com/<s3-bucket-name>/instantclient-sdk-linux.x64-12.1.0.2.0.zip \
             -O /home/ubuntu/instantclient-sdk-linux.x64-12.1.0.2.0.zip && \
        cd /home/ubuntu && \
        unzip instantclient-basic-linux.x64-12.1.0.2.0.zip && \
        unzip instantclient-sdk-linux.x64-12.1.0.2.0.zip && \
        mv instantclient_12_1 /usr/local/lib && \
        rm instantclient-basic-linux.x64-12.1.0.2.0.zip && \
        rm instantclient-sdk-linux.x64-12.1.0.2.0.zip && \
        apt-get install -y libaio1
    
    RUN \
        echo 'export OCI_LIB=/usr/local/lib/instantclient_12_1' \
              >> /home/ubuntu/.domino-defaults && \
        echo 'export OCI_INC=/usr/local/lib/instantclient_12_1/sdk/include' \
              >> /home/ubuntu/.domino-defaults && \
        echo 'export LD_LIBRARY_PATH=/usr/local/lib/instantclient_12_1:$LD_LIBRARY_PATH' \
              >> /home/ubuntu/.domino-defaults
    
    RUN \
        cd /usr/local/lib/instantclient_12_1 && \
        ln -sf libclntsh.so.12.1 libclntsh.so && \
        chown -R ubuntu:ubuntu /usr/local/lib/instantclient_12_1
    
    RUN \
        echo '/usr/local/lib/instantclient_12_1' \
              > /etc/ld.so.conf.d/oracle-instantclient.conf && \
        ldconfig -v
    
    RUN pip install cx_Oracle --upgrade
    
    USER ubuntu
  3. Set the following Domino environment variables to store secure information about your Oracle connection.

    • ORACLE_HOST

      Hostname where your database is running. Make sure your Oracle host and network firewall are configured to accept connections from Domino.

    • ORACLE_SERVICE

      The service name of the Oracle service running on the target host.

    • ORACLE_USER

      The Oracle user you want to authenticate as.

    • ORACLE_PASSWORD

      Password for the user specified previously.

      See Secure Credential Storage to learn more about Domino environment variables.

  4. See the cx_Oracle documentation for information about how to use the package. The following is an example to connect to Oracle with cx_Oracle where:

    • You have set up environment variables with the hostname, service name, username, and password.

    • Your user has access to a database named houses in the target Oracle instance.

      from __future__ import print_function
      import cx_Oracle
      import os
      
      # fetch values from environment variables and set the target database
      hostname = os.environ['ORACLE_HOST']
      service  = os.environ['ORACLE_SERVICE']
      username = os.environ['ORACLE_USER']
      password = os.environ['ORACLE_PASSWORD']
      connection_string = hostname + "/" + service
      
      # Connect as user "hr" with password "welcome" to the "oraclepdb" service running on this computer.
      connection = cx_Oracle.connect(username, password, connection_string)
      
      cursor = connection.cursor()
      cursor.execute("""
          SELECT address
          FROM houses
          WHERE zip = 90210""")
      for address in cursor:
          print("Address:", address)

R and ROracle

  1. To interact with Oracle databases from R, Domino recommends the ROracle library.

  2. Use the following Dockerfile instruction to install the Oracle client drivers and RODBC in your environment.

    Note
    USER root
    
    RUN \
        wget https://s3-us-west-2.amazonaws.com/<s3-bucket-name>/instantclient-basic-linux.x64-12.1.0.2.0.zip \
             -O /home/ubuntu/instantclient-basic-linux.x64-12.1.0.2.0.zip && \
        wget https://s3-us-west-2.amazonaws.com/<s3-bucket-name>/instantclient-sdk-linux.x64-12.1.0.2.0.zip \
             -O /home/ubuntu/instantclient-sdk-linux.x64-12.1.0.2.0.zip && \
        cd /home/ubuntu && \
        unzip instantclient-basic-linux.x64-12.1.0.2.0.zip && \
        unzip instantclient-sdk-linux.x64-12.1.0.2.0.zip && \
        mv instantclient_12_1 /usr/local/lib && \
        rm instantclient-basic-linux.x64-12.1.0.2.0.zip && \
        rm instantclient-sdk-linux.x64-12.1.0.2.0.zip && \
        apt-get install -y libaio1
    
    RUN \
        echo 'export OCI_LIB=/usr/local/lib/instantclient_12_1' \
              >> /home/ubuntu/.domino-defaults && \
        echo 'export OCI_INC=/usr/local/lib/instantclient_12_1/sdk/include' \
              >> /home/ubuntu/.domino-defaults && \
        echo 'export LD_LIBRARY_PATH=/usr/local/lib/instantclient_12_1:$LD_LIBRARY_PATH' \
              >> /home/ubuntu/.domino-defaults
    
    RUN \
        cd /usr/local/lib/instantclient_12_1 && \
        ln -s libclntsh.so.12.1 libclntsh.so && \
        chown -R ubuntu:ubuntu /usr/local/lib/instantclient_12_1
    
    RUN \
        echo '/usr/local/lib/instantclient_12_1' \
              > /etc/ld.so.conf.d/oracle-instantclient.conf && \
        ldconfig -v
    
    RUN \
        cd /home/ubuntu && \
        wget https://cran.r-project.org/src/contrib/ROracle_1.3-1.tar.gz && \
        R CMD INSTALL --configure-args='--with-oci-inc=/usr/local/lib/instantclient_12_1/sdk/include --with-oci-lib=/usr/local/lib/instantclient_12_1' ROracle_1.3-1.tar.gz
    
    USER ubuntu
  3. Set up the following Domino environment variables to store secure information about your Oracle connection.

    • ORACLE_HOST

      Hostname where your database is running. Make sure your Oracle host and network firewall are configured to accept connections from Domino.

    • ORACLE_SERVICE

      The service name of the Oracle service running on the target host.

    • ORACLE_USER

      The Oracle user you want to authenticate as.

    • ORACLE_PASSWORD

      Password for the user specified previously.

      See Secure Credential Storage to learn more about Domino environment variables.

  4. See the ROracle documentation for usage details.

Domino Data LabKnowledge BaseData Science BlogTraining
Copyright © 2022 Domino Data Lab. All rights reserved.