Connect to SFTP Data as an External Source in Dremio

The CData JDBC Driver for SFTP implements JDBC Standards and allows various applications, including Dremio, to work with live SFTP 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 SFTP data as a part of your enterprise data lake. This article describes how to connect to SFTP data from Dremio as an External Source.

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

Prerequisites

This article assumes you are utilizing Docker to run Dremio. You can create a Docker container with the Dremio service using a command similar to the follow:

docker run -d --name dremio -p 9047:9047 -p 31010:31010 dremio/dremio-oss

Where dremio is the name of the container, 9047 is the container's port for the Dremio web interface and 31010 is the port that maps to the Dremio query service. dremio/dremio-oss specifies the image to use.

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

NOTE: The CData ARP Connectors are build to be compiled with Java 11. Be sure to install Java 11 and use the correct version. You can update your Java version using a command similar to the following:

sudo update-alternatives --config java

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 SFTP to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-sftp-plugin-{DREMIO_VERSION}.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for SFTP

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

Connecting to SFTP

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

👁 External Sources via CData JDBC Drivers (Amazon DynamoDB & Couchbase are shown)

Built-in Connection String Designer

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

java -jar cdata.jdbc.sftp.jar

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

SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

Set the following connection properties to control the relational view of the file system:

• RemotePath: Set this to the current working directory.
• TableDepth: Set this to control the depth of subfolders to report as views.
• FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.

Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server. 👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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:sftp:RTK=5246...;RemoteHost=MyFTPServer;

Access SFTP as an External Source

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

👁 Entering the JDBC URL (Amazon DynamoDB is shown)

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

👁 Live data in Dremio (Amazon DynamoDB is shown)

More Information & Free Trial

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