domino logo
Tech Ecosystem
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 Domino ProjectStep 3: Configure Your Domino 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 Domino Datasets
Domino Reference
Notifications
On-Demand Open MPI
Configure MPI PrerequisitesFile Sync MPI ClustersValidate MPI VersionWork with your ClusterManage Dependencies
Projects
Projects OverviewProjects PortfolioReference ProjectsProject Goals in Domino 4+
Git Integration
Git Repositories in DominoGit-based ProjectsWorking from a Commit ID in Git
Jira Integration in DominoUpload Files to Domino using your BrowserFork and Merge ProjectsSearchSharing and CollaborationCommentsDomino File SystemCompare File Revisions
Revert Projects and Files
Revert a FileRevert a Project
Archive a Project
Advanced Project Settings
Project DependenciesProject TagsRename a ProjectSet up your Project to Ignore FilesUpload files larger than 550MBExporting Files as a Python or R PackageTransfer Project Ownership
Domino Runs
JobsDiagnostic Statistics with dominostats.jsonNotificationsResultsRun Comparison
Advanced Options for Domino Runs
Run StatesDomino Environment VariablesEnvironment Variables for Secure Credential StorageUse Apache Airflow with Domino
Scheduled Jobs
Domino Workspaces
WorkspacesUse Git in Your WorkspaceRecreate A Workspace From A Previous CommitUse Visual Studio Code in Domino WorkspacesPersist RStudio PreferencesAccess Multiple Hosted Applications in one Workspace Session
Spark on Domino
On-Demand Spark
On-Demand Spark OverviewValidated Spark VersionConfigure PrerequisitesWork with your ClusterManage DependenciesWork with Data
External Hadoop and Spark
Hadoop and Spark OverviewConnect 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 Ray
On-Demand Ray OverviewValidated Ray VersionConfigure PrerequisitesWork with your ClusterManage DependenciesWork with Data
On-Demand Dask
On-Demand Dask OverviewValidated Dask VersionConfigure PrerequisitesWork with Your ClusterManage DependenciesWork with Data
Customize the Domino Software Environment
Environment ManagementDomino Standard EnvironmentsInstall Packages and DependenciesAdd Workspace IDEsAdding Jupyter Kernels
Use Custom Images as a Compute Environment
Pre-requisites for Automatic Custom Image CompatibilityModify the Default Workspace ToolsCreate a Domino Image with an NGC ContainerCreate a Domino Environment with a Pre-Built ImageManually Modify Images for Domino Compatibility
Partner Environments for Domino
Use MATLAB as a WorkspaceUse Stata as a WorkspaceUse SAS as a Workspace
Advanced Options for Domino Software Environment
Publish in Domino with Custom ImagesInstall Custom Packages in Domino with Git IntegrationAdd Custom DNS Servers to Your Domino EnvironmentConfigure a Compute Environment to User Private Cran/Conda/PyPi MirrorsUse TensorBoard in Jupyter Workspaces
Publish your Work
Publish a Model API
Model Publishing OverviewModel Invocation SettingsModel Access and CollaborationModel Deployment ConfigurationPromote Projects to ProductionExport Model ImageExport to NVIDIA Fleet Command
Publish a Web Application
App Publishing OverviewGet Started with DashGet Started with ShinyGet Started with FlaskContent Security Policies for Web Apps
Advanced Web Application Settings in Domino
App Scaling and PerformanceHost HTML Pages from DominoHow to Get the Domino Username of an App Viewer
Launchers
Launchers OverviewAdvanced Launcher Editor
Manage 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
Assets Portfolio Overview
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
Connect to your Data
Data in Domino
Datasets OverviewProject FilesDatasets Best Practices
Connect to Data Sources
External Data VolumesDomino Data Sources
Connect to External Data
Connect to Amazon S3 from DominoConnect to Azure Data Lake StorageConnect to BigQueryConnect to DataRobotConnect to Generic S3 from DominoConnect to Google Cloud StorageConnect to IBM DB2Connect to IBM NetezzaConnect to ImpalaConnect to MSSQLConnect to MySQLConnect to OkeraConnect to Oracle DatabaseConnect to PostgreSQLConnect to RedshiftConnect to Snowflake from DominoConnect to Teradata
Work with Data Best Practices
Work with Big Data in DominoWork with Lots of FilesMove Data Over a Network
Advanced User Configuration Settings
User API KeysDomino TokenOrganizations Overview
Use the Domino Command Line Interface (CLI)
Install the Domino Command Line (CLI)Domino CLI ReferenceDownload Files with the CLIForce-Restore a Local ProjectMove a Project Between Domino DeploymentsUse the Domino CLI Behind a Proxy
Browser Support
Get Help with Domino
Additional ResourcesGet Domino VersionContact Domino Technical SupportSupport Bundles
domino logo
About Domino
Domino Data LabKnowledge BaseData Science BlogTraining
User Guide
>
Domino Reference
>
Connect to your Data
>
Connect to Data Sources
>
Connect to External Data
>
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 Environment variables for 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 Environment variables for 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.