LINQ to Miro Data
This article illustrates using LINQ to access tables within the Miro via the CData ADO.NET Data Provider for Miro. To achieve this, we will use LINQ to Entity Framework, which facilitates the generation of connections and can be seamlessly employed with any CData ADO.NET Data Providers to access data through LINQ.
See the help documentation for a guide to setting up an EF 6 project to use the provider.
- In a new project in Visual Studio, right-click on the project and choose to add a new item. Add an ADO.NET Entity Data Model.
- Choose EF Designer from Database and click Next.
- Add a new Data Connection, and change your data source type to "CData Miro Data Source".
Enter your data source connection information.
Using API Key Authentication
Miro uses API Key authentication with an access token. To generate an access token:
- Log in to your Miro account
- Navigate to Settings > Your apps
- Click "Create new app" or select an existing app
- Configure the required permissions (e.g., boards:read, teams:read)
- Install the app and generate an access token
- Copy the generated access token (it will only be shown once)
After obtaining your access token, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your access token.
Connecting to Miro
Once the authentication is configured, you can connect to Miro and query data from any of the available tables such as Boards, Items, Teams, Organizations, and more.
Below is a typical connection string:
Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';
- If saving your entity connection to App.Config, set an entity name. In this example we are setting APIEntities as our entity connection in App.Config.
- Enter a model name and select any tables or views you would like to include in the model.
Using the entity you created, you can now perform select commands. For example:
APIEntities context = new APIEntities();
var boardsQuery = from boards in context.Boards
select boards;
foreach (var result in boardsQuery) {
Console.WriteLine("{0} {1} ", result.Id, result.);
}
See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.