Working with X-Cart Data in LINQPad

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with X-Cart.



Execute LINQ queries to X-Cart data in LINQPad.

The CData ADO.NET Provider for X-Cart enables you to use standard ADO.NET interfaces like LINQ and the Entity Framework to work with X-Cart data. This article shows how to connect from LINQPad and execute LINQ queries.

Create the Data Model

After downloading and installing the provider and LINQPad, create a new class library project in 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.

    An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

    • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
    • Search for REST API Module. Install the Module.
    • After the module has been installed, you need to set it up.
      • Go to the Settings section for the REST API Module.
      • On the settings page specify the API Key (only read)
    • Set the ApiKey and Url to the connection property to connect to data.

    Below is a typical connection string:

    Url=https://example.com/shop;ApiKey=MyApiKey;
  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 X-Cart connection in LINQPad.

Connect to X-Cart 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 X-Cart data through LINQPad. For examples of the supported LINQ queries, see the "LINQ and Entity Framework" chapter in the help documentation.