Ready to get started?

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

Download Now

Working with Magento Data in LINQPad

Execute LINQ queries to Magento data in LINQPad.

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

    Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

    You will also need to provide the URL to your Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

    • Customer: To use Magento as a customer, make sure you have created a customer account in the Magento homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Magento system.

    • Administrator: To access Magento as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

      If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

    Below is a typical connection string:

    OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;
  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 Magento connection in LINQPad.

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