Learn more
 

Ready to get started?

Download a free trial of the SFTP ODBC Driver to get started:

 Download Now

Learn more:

SFTP Icon SFTP ODBC Driver

The SFTP ODBC Driver is a powerful tool that allows you to connect with live data from remote files and directories, directly from any applications that support ODBC connectivity.

Access remote data like you would a database through a standard ODBC Driver interface.

In this article

Related articles

Create Datasets from SFTP in Domo Workbench and Build Visualizations of SFTP Data in Domo


Use the CData ODBC Driver for SFTP to create datasets from SFTP data in Domo Workbench and then build visualizations in the Domo service.

Domo helps you manage, analyze, and share data across your entire organization, enabling decision makers to identify and act on strategic opportunities. Domo Workbench provides a secure, client-side solution for uploading your on-premise data to Domo. The CData ODBC Driver for SFTP links Domo Workbench to operational SFTP data. You can build datasets from SFTP data using standard SQL queries in Workbench and then create real-time visualizations of SFTP data in the Domo service.

The CData ODBC Drivers offer unmatched performance for interacting with live SFTP data in Domo due to optimized data processing built into the driver. When you issue complex SQL queries from Domo to SFTP, the driver pushes supported SQL operations, like filters and aggregations, directly to SFTP and utilizes the embedded SQL Engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze SFTP data using native Domo data types.

Connect to SFTP as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

After creating a DSN, you will need to create a dataset for SFTP in Domo Workbench using the SFTP DSN and build a visualization in the Domo service based on the dataset.

Build a Dataset for SFTP Data

You can follow the steps below to build a dataset based on a table in SFTP in Domo Workbench using the CData ODBC Driver for SFTP.

  1. Open Domo Workbench and, if you have not already, add your Domo service server to Workbench. In the Accounts submenu, click Add New, type in the server address (i.e., domain.domo.com) and click through the wizard to authenticate.
  2. In the DataSet Jobs submenu, click Add New.
  3. Name the dataset job (i.e., ODBC SFTP MyDirectory), select ODBC Connection Provider as the transport method, and click through the wizard.
  4. In the newly created DataSet Job, navigate to Source and click to configure the settings.
  5. Select System DSN for the Connection Type.
  6. Select the previously configured DSN (CData SFTP Sys) for the System DSN.
  7. Click to validate the configuration.
  8. Below the settings, set the Query to a SQL query: SELECT * FROM MyDirectory NOTE: By connecting to SFTP data using an ODBC driver, you simply need to know SQL in order to get your data, circumventing the need to know SFTP-specific APIs or protocols.
  9. Click preview.
  10. Check over the generated schema, add any transformations, then save and run the dataset job.

With the dataset job run, the dataset will be accessible from the Domo service, allowing you to build visualizations, reports, and more based on SFTP data.

Create Data Visualizations

With the DataSet Job saved and run in Domo Workbench, we are ready to build visualizations of the SFTP data in the Domo service.

  1. Navigate to the Data Center.
  2. In the data warehouse, select the ODBC data source and drill down to our new dataset.
  3. With the dataset selected, choose to create a visualization.
  4. In the new card:
    • Drag a Dimension to the X Value.
    • Drag a Measure to the Y Value.
    • Choose a Visualization.

With the CData ODBC Driver for SFTP, you can build custom datasets based on SFTP data using only SQL in Domo Workbench and then build and share visualizations and reports through the Domo service.