Ready to get started?

Learn more about the CData ADO.NET Provider for SFTP or download a free trial:

Download Now

Access SFTP Data with Entity Framework 6

This article shows how to access SFTP data using an Entity Framework code-first approach. Entity Framework 6 is available in .NET 4.5 and above.

Entity Framework is an object-relational mapping framework that can be used to work with data as objects. While you can run the ADO.NET Entity Data Model wizard in Visual Studio to handle generating the Entity Model, this approach, the model-first approach, can put you at a disadvantage if there are changes in your data source or if you want more control over how the entities operate. In this article you will complete the code-first approach to accessing SFTP data using the CData ADO.NET Provider.

  1. Open Visual Studio and create a new Windows Form Application. This article uses a C# project with .NET 4.5.
  2. Run the command 'Install-Package EntityFramework' in the Package Manger Console in Visual Studio to install the latest release of Entity Framework.
  3. Modify the App.config file in the project to add a reference to the SFTP Entity Framework 6 assembly and the connection string.

    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.

    <configuration> ... <connectionStrings> <add name="SFTPContext" connectionString="Offline=False;RemoteHost=MyFTPServer;" providerName="System.Data.CData.SFTP" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.SFTP" type="System.Data.CData.SFTP.SFTPProviderServices, System.Data.CData.SFTP.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
  4. Add a reference to System.Data.CData.SFTP.Entities.EF6.dll, located in the lib -> 4.0 subfolder in the installation directory.
  5. Build the project at this point to ensure everything is working correctly. Once that's done, you can start coding using Entity Framework.
  6. Add a new .cs file to the project and add a class to it. This will be your database context, and it will extend the DbContext class. In the example, this class is named SFTPContext. The following code example overrides the OnModelCreating method to make the following changes:
    • Remove PluralizingTableNameConvention from the ModelBuilder Conventions.
    • Remove requests to the MigrationHistory table.
    using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SFTPContext : DbContext { public SFTPContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SFTPContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. Create another .cs file and name it after the SFTP entity you are retrieving, for example, MyDirectory. In this file, define both the Entity and the Entity Configuration, which will resemble the example below: using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; [System.ComponentModel.DataAnnotations.Schema.Table("MyDirectory")] public class MyDirectory { [System.ComponentModel.DataAnnotations.Key] public System.String Filesize { get; set; } public System.String Filename { get; set; } }
  8. Now that you have created an entity, add the entity to your context class: public DbSet<MyDirectory> MyDirectory { set; get; }
  9. With the context and entity finished, you are now ready to query the data in a separate class. For example: SFTPContext context = new SFTPContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.MyDirectory select line;