Access Live SFTP Data in Coginiti Pro



Connect to and query live SFTP data from the GUI in the Coginiti Pro: SQL Analytics Tool.

Coginiti Pro is a single tool for all your SQL data and analytics needs, designed specifically for data engineers, analysts, and data scientists. When paired with the CData JDBC Driver for SFTP, Coginiti Pro can access and query live SFTP data. This article describes how to connect to and query SFTP data from Coginiti Pro.

With built-in optimized data processing, the CData JDBC Driver for SFTP offers unmatched performance for interacting with live SFTP data. When you issue complex SQL queries 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 client-side (often SQL functions and JOIN operations). In addition, its built-in dynamic metadata querying allows you to work with and analyze SFTP data using native data types.

Gather Connection Properties and Build a Connection String

Download the CData JDBC Driver for SFTP installer, unzip the package, and run the JAR file to install the driver. Then gather the required connection properties.

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.

NOTE: To use the JDBC driver in Coginiti Pro, you may 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.

Built-in Connection String Designer

For assistance 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 (including the RTK) and copy the connection string to the clipboard.

Create a JDBC Data Source for SFTP Data

  1. Open Coginiti Pro and in the File menu, select "Edit Drivers."
  2. In the newly opened wizard, click "Add" and select "Generic."
  3. In the "JDBC Drivers" wizard, set the driver properties (below) and click "Create Driver."

    • Set JDBC Driver Name to a useful name, like CData JDBC Driver for SFTP.
    • Click "Add Files" to add the JAR file from the "lib" folder in the installation directory (e.g. cdata.jdbc.sftp.jar)
    • Select the Class Name: cdata.jdbc.sftp.SFTPDriver.

Create a Connection using the CData JDBC Driver for SFTP

  1. In the File menu, click "Edit Connections."
  2. In the newly opened wizard, click "Add" and select "Generic."
  3. In the "Connections" wizard, set the connection properties.
    • Set Connection name to an identifying name.
    • Set Database JDBC driver to the Driver you configured earlier.
    • Set JDBC URL to the JDBC URL configured using the built-in connection string designer (e.g. jdbc:sftp:RemoteHost=MyFTPServer;
  4. Click "Test" to ensure the connection is configured properly. Click "Save."

Query SFTP Using SQL

  1. Open the Connections tab by clicking on database icon: .
  2. Click the plus sign () to add a new query tab.
  3. Once the query console is open, write the SQL script you wish to execute and click "Run at Cursor".

    NOTE: You can use the explorer on the left to determine table/view names and column names.

    Using the explorer

    1. In the "Select connection" field, select the connection you wish to query.
    2. Expand your newly created connection, expand the "CData" catalog, and expand the SFTP catalog.
    3. Expand "Tables" or "Views" to find the entity you wish to query.
    4. Expand your selected entity to explore the fields (columns).

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for SFTP and start working with your live SFTP data in Coginiti Pro. Reach out to our Support Team if you have any questions.

Ready to get started?

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

 Download Now

Learn more:

SFTP Icon SFTP JDBC Driver

An easy-to-use database-like interface for Java based applications and reporting tools access to remote files and directories.