Working with Shortcut Data in LINQPad

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Execute LINQ queries to Shortcut data in LINQPad.

The CData ADO.NET Provider for Shortcut enables you to use standard ADO.NET interfaces like LINQ and the Entity Framework to work with Shortcut 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.

    Start by setting the Profile connection property to the location of the Shortcut Profile on disk (e.g. C:\profiles\Shortcut.apip). Next, set the ProfileSettings connection property to the connection string for Shortcut (see below).

    Shortcut API Profile Settings

    Log into your Shortcut account, navigate to Settings > API Tokens, and click Generate Token.

    Below is a typical connection string:

    Profile=C:\profiles\Shortcut.apip;ProfileSettings='APIKey=your_api_key';
  2. Select the desired tables and views and click Finish to create the data model.

  3. Build the project. The generated files can be used to create the Shortcut connection in LINQPad.

Connect to Shortcut 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.

  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.

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

Ready to get started?

Connect to live data from Shortcut with the API Driver

Connect to Shortcut