Connect to HCL Domino Data in as an External Source in Dremio

The CData JDBC Driver for HCL Domino implements JDBC Standards and allows various applications, including Dremio, to work with live HCL Domino data. Dremio is a data lakehouse platform designed to empower self-service, interactive analytics on the data lake. With the CData JDBC Driver, you can include live HCL Domino data as a part of your enterprise data lake. This article describes how to connect to HCL Domino data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live HCL Domino data in Dremio. Once you install the driver, authenticate with HCL Domino and gain immediate access to HCL Domino data within your data lake. By surfacing HCL Domino data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to HCL Domino data.

Build the ARP Connector

To use the CData JDBC Driver in Dremio, you need to build an Advanced Relation Pushdown (ARP) Connector. You can view the source code for the Connector on GitHub or download the ZIP file (GitHub.com) directly. Once you copy or extract the files, run the following command from the root directory of the connector (the directory containing the pom.xml file) to build the connector.

mvn clean install

Once the JAR file for the connector is built (in the target directory), you are ready to copy the ARP connector and JDBC Driver to your Dremio instance.

Installing the Connector and JDBC Driver

Install the ARP Connector to %DREMIO_HOME%/jars/ and the JDBC Driver for HCL Domino to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-domino-plugin-20.0.0.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for HCL Domino

docker cp PATH\TO\cdata.jdbc.domino.jar dremio_image_name:/opt/dremio/jars/3rdparty/

Connecting to HCL Domino

HCL Domino will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to HCL Domino data. The JDBC Driver has a built-in connection string designer that you can use (see below).

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the HCL Domino JDBC Driver. Double-click the JAR file or execute the jar file from the command line.

java -jar cdata.jdbc.domino.jar

Fill in the connection properties and copy the connection string to the clipboard.

Prerequisites

The connector requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.

Once the Proton service is installed and running, you will also need to create a user account and download its Internet certificate. This certificate can be used to set the connector certificate connection properties.

Authenticating to Domino

• Server: The name or IP address of the server running Domino with the Proton service.
• Port: The port number that the Proton service is listening on.
• Database: The name of the database file, including the .nsf extension.
• SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
• SSLClientCert: The path to the certificate file.
• SSLServerCert: This can be set to (*) if you trust the server. This is usually the case, but if you want to perform SSL validation, you may provide a certificate or thumbprint instead. See the documentation for SSLServerCert for details.

Additional Server Configuration

The connector supports querying Domino views if any are defined. Before views can be queried by the connector they must be registered with the design catalog.

Please refer to the Catalog Administration section of the AppDev pack documentation for details on how to do this.

NOTE: To use the JDBC Driver in Dremio, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Add the Runtime Key (RTK) to the JDBC URL. You will end up with a JDBC URL similar to the following:

jdbc:domino:RTK=5246...;Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*

Access HCL Domino as an External Source

To add HCL Domino as an External Source, click to add a new source and select Domino. Copy the JDBC URL and paste it into the New Domino Source wizard.

Save the connection and you are ready to query live HCL Domino data in Dremio, easily incorporating HCL Domino data into your data lake.

More Information & Free Trial

Using the CData JDBC Driver for HCL Domino in Dremio, you can incorporate live HCL Domino data into your data lake. Check out our CData JDBC Driver for HCL Domino page for more information about connecting to HCL Domino. Download a free, 30 day trial of the CData JDBC Driver for HCL Domino and get started today.