VOOZH about

URL: https://www.cdata.com/kb/tech/miro-ado-linqpad.rst

โ‡ฑ Working with Miro Data in LINQPad


Working with Miro Data in LINQPad

๐Ÿ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Execute LINQ queries to Miro data in LINQPad.

The CData ADO.NET Provider for Miro enables you to use standard ADO.NET interfaces like LINQ and the Entity Framework to work with Miro data. This article will demonstrate the process of establishing a connection from LINQPad and executing LINQ queries.

Create the Data Model

After downloading and installing both the provider and LINQPad, create a new class library project within Visual Studio.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

  1. Right-click your project and click Add -> New Item -> ADO.NET Entity Data Model. In the resulting dialog, select Code First from database. Click New Connection and specify the connection string options in the resulting wizard.

    Using API Key Authentication

    Miro uses API Key authentication with an access token. To generate an access token:

    1. Log in to your Miro account
    2. Navigate to Settings > Your apps
    3. Click "Create new app" or select an existing app
    4. Configure the required permissions (e.g., boards:read, teams:read)
    5. Install the app and generate an access token
    6. 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';
    ๐Ÿ‘ The required connection properties in the Entity Data Model Configuration Wizard. (JSON is shown.)
  2. Select the desired tables and views and click Finish to create the data model.

    ๐Ÿ‘ The last step of the Entity Data Model Configuration Wizard, where tables are imported into the entity model.
  3. Build the project. The generated files can be used to create the Miro connection in LINQPad.

Connect to Miro Data in LINQPad

After you have obtained the required connection properties and created the data model assembly, follow the steps below to start using the data model in LINQPad.

  1. Open LINQPad and click Add Connection.

  2. Select the "Use a typed data context from your own assembly" option.

  3. Select Entity Framework DbContext.

    ๐Ÿ‘ The Choose Data Context dialog.
  4. Click Browse next to the Path to Custom Assembly box and browse to your project folder. Browse to the .dll or .exe under the bin folder.

  5. Select the name of the DbContext.
  6. If you saved your connection string in App.Config, specify the path to the App.config.
๐Ÿ‘ The next step of the wizard, where the data model assembly is imported.

You can now query Miro data through LINQPad. For examples of the supported LINQ queries, see the "LINQ and Entity Framework" chapter in the help documentation.

๐Ÿ‘ The results of a query in LINQPad. (JSON is shown.)