LINQ to Sugar CRM Data

This article illustrates using LINQ to access tables within the Sugar CRM via the CData ADO.NET Data Provider for Sugar CRM. 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.

1. 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.
2. Choose EF Designer from Database and click Next.
3. Add a new Data Connection, and change your data source type to "CData Sugar CRM Data Source".

4. Enter your data source connection information.

   The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

   You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

   Additionally, specify the URL to the SugarCRM account.

   Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

   Below is a typical connection string:

   User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;

👁 Required connection properties for the data source. (QuickBooks is shown.)

5. If saving your entity connection to App.Config, set an entity name. In this example we are setting SugarCRMEntities as our entity connection in App.Config.
6. 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 , update, delete, and insert commands. For example:

SugarCRMEntities context = new SugarCRMEntities();

var accountsQuery = from accounts in context.Accounts
 select accounts;

foreach (var result in accountsQuery) {
 Console.WriteLine("{0} {1} ", result.Id, result.Name);
}

See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.