Learn more
 

Ready to get started?

Download a free trial of the SFTP Data Provider to get started:

 Download Now

Learn more:

SFTP Icon SFTP ADO.NET Provider

An easy-to-use database-like interface for .NET applications access to remote files and directories.

In this article

Related articles

DataBind Charts to SFTP Data


Use the standard ADO.NET procedures for databinding to provide bidirectional access to SFTP data from controls in the Visual Studio toolbox. This article demonstrates a graphical approach using wizards in Visual Studio, as well as how to databind with only a few lines of code.

DataBinding facilitates two-way interaction with data through UI controls. Using the CData ADO.NET Provider for SFTP streamlines the process of binding SFTP data to Windows Forms and Web controls within Visual Studio. In this article, we will demonstrate using wizards to establish a binding between SFTP data and a chart that dynamically updates. Additionally, the code walk-through section will guide you through the creation of a chart using just 10 lines of code.

DataBind to a Chart

DataBinding consists of three steps: Instantiate the control, configure the data source, and databind.

Configure the Connection and Select Database Objects

To create a chart control and establish a connection to SFTP, follow the steps outlined below using the Data Source Configuration Wizard. Within the wizard, you'll have the option to choose the specific SFTP entities you wish to bind to.

  1. In a Windows Forms project, drag and drop a Chart control from the toolbox to the form. In the Data section of the Chart properties, select DataSource and then select Add Project Data Source from the menu.
  2. In the Data Source Configuration Wizard that appears, select Database -> Dataset.
  3. In the Choose Your Data Connection step, click New Connection.

  4. In the Add Connection dialog, click Change to select the CData SFTP Data Source.

    Below is a typical connection string:

    RemoteHost=MyFTPServer;

    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 connection, 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.

  5. Choose the database objects you want to work with. This example uses the MyDirectory table.

DataBind

After adding the data source and selecting database objects, you can bind the objects to the chart. This example assigns the x-axis to Filesize and the y-axis to Filename.

  1. In the Chart properties, click the button in the Series property to open the Series Collection Editor.
  2. In the Series properties, select the columns you want for the x- and y-axes: Select columns from the menu in the XValueMember and YValueMember properties.

The chart is now databound to the SFTP data. Run the chart to display the current data.

Code Walk-through

DataBinding to SFTP data requires only a few lines of code and can be completed in three easy steps.

  1. Connect to SFTP.
  2. Create the SFTPDataAdapter to execute the query and create a DataSet to be filled with its results.
  3. DataBind the result set to the chart.

Below is the complete code:

SFTPConnection conn = new SFTPConnection("RemoteHost=MyFTPServer;"); SFTPCommand comm = new SFTPCommand("SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt", conn); SFTPDataAdapter da = new SFTPDataAdapter(comm); DataSet dataset = new DataSet(); da.Fill(dataset); chart1.DataSource = dataset; chart1.Series[0].XValueMember = "Filesize"; chart1.Series[0].YValueMembers = "Filename"; // Insert code for additional chart formatting here. chart1.DataBind();