Ready to get started?

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

Download Now

Access Trello Data with Entity Framework 6

This article shows how to access Trello 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 Trello 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 Trello Entity Framework 6 assembly and the connection string.

    Trello uses token-based authentication to grant third-party applications access to their API. When a user has granted an application access to their data, the application is given a token that can be used to make requests to Trello's API.

    Trello's API can be accessed in 2 different ways. The first is using Trello's own Authorization Route, and the second is using OAuth1.0.

    • Authorization Route: At the moment of registration, Trello assigns an API key and Token to the account. See the Help documentation for information on how to connect via the Authorization route.
    • OAuth Route: Similar to using Authorization, OAuth creates an Application Id and Secret when you create your account. See the Help documentation for information on how to to connect.

    <configuration> ... <connectionStrings> <add name="TrelloContext" connectionString="Offline=False;APIKey=myApiKey;Token=myGeneratedToken;InitiateOAuth=GETANDREFRESH" providerName="System.Data.CData.Trello" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Trello" type="System.Data.CData.Trello.TrelloProviderServices, System.Data.CData.Trello.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
  4. Add a reference to System.Data.CData.Trello.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 TrelloContext. 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 TrelloContext : DbContext { public TrelloContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<TrelloContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. Create another .cs file and name it after the Trello entity you are retrieving, for example, Boards. 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("Boards")] public class Boards { [System.ComponentModel.DataAnnotations.Key] public System.String BoardId { get; set; } public System.String Name { get; set; } }
  8. Now that you have created an entity, add the entity to your context class: public DbSet<Boards> Boards { set; get; }
  9. With the context and entity finished, you are now ready to query the data in a separate class. For example: TrelloContext context = new TrelloContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Boards select line;