Sample: Create a LINQ query with late binding
Applies To: Dynamics CRM 2015
This sample code is for Microsoft Dynamics CRM 2015 and Microsoft Dynamics CRM Online 2015 Update. Download the Microsoft Dynamics CRM SDK package. The sample can be found in the following location in the download package:
SampleCode\CS\GeneralProgramming\Queries\UseLinqWithLateBinding.cs
Requirements
For more information about the requirements for running the sample code provided in this SDK, see Use the sample and helper code.
Demonstrates
This sample shows how to create .NET Language-Integrated Query (LINQ) queries using late-bound entities.
Example
using System;
using System.Collections.Generic;
using System.Linq;
using System.ServiceModel;
// These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
// located in the SDK\bin folder of the SDK download.
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Client;
namespace Microsoft.Crm.Sdk.Samples
{
/// <summary>
/// Demonstrates how to make LINQ queries with the OrganizationServiceContext
/// object and the dynamic entity type.</summary>
/// <remarks>
/// At run-time, you will be given the option to delete all the
/// database records created by this program.</remarks>
public class UseLinqWithDotNetDataServicesDE
{
#region Class Level Members
/// <summary>
/// Stores the organization service proxy.
/// </summary>
private OrganizationServiceProxy _serviceProxy;
// Define the IDs needed for this sample.
private List<Guid> _accountIds = new List<Guid>();
private List<Guid> _contactIds = new List<Guid>();
private List<Guid> _leadIds = new List<Guid>();
#endregion Class Level Members
#region How To Sample Code
/// <summary>
/// This method first connects to the Organization service and service context.
/// Afterwards, several LINQ query techniques are demonstrated.
/// </summary>
/// <param name="serverConfig">Contains server connection information.</param>
/// <param name="promptforDelete">When True, the user will be prompted to delete all
/// created entities.</param>
public void Run(ServerConnection.Configuration serverConfig, bool promptforDelete)
{
try
{
// Connect to the Organization service.
// The using statement assures that the service proxy will be properly disposed.
using (_serviceProxy = new OrganizationServiceProxy(serverConfig.OrganizationUri, serverConfig.HomeRealmUri,serverConfig.Credentials, serverConfig.DeviceCredentials))
{
// This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes();
CreateRequiredRecords();
OrganizationServiceContext orgContext =
new OrganizationServiceContext(_serviceProxy);
// Retrieve records with Skip/Take record paging. Setting a page size
// can help you manage your Skip and Take calls, since Skip must be
// passed a multiple of Take's parameter value.
int pageSize = 5;
var accountsByPage = from a in orgContext.CreateQuery("account")
select a["name"];
System.Console.WriteLine("Skip 10 accounts, then Take 5 accounts");
System.Console.WriteLine("======================================");
foreach (var name in accountsByPage.Skip(2 * pageSize).Take(pageSize))
{
System.Console.WriteLine(name);
}
System.Console.WriteLine();
System.Console.WriteLine("<End of Listing>");
System.Console.WriteLine();
//OUTPUT:
//Skip 10 accounts, then Take 5 accounts
//======================================
//Fourth Coffee 6
//Fourth Coffee 7
//Fourth Coffee 8
//Fourth Coffee 9
//Fourth Coffee 10
//<End of Listing>
// Use orderBy to order items retrieved.
var orderedAccounts = from a in orgContext.CreateQuery("account")
orderby a["name"]
select a["name"];
System.Console.WriteLine("Display accounts ordered by name");
System.Console.WriteLine("================================");
foreach (var name in orderedAccounts)
{
System.Console.WriteLine(name);
}
System.Console.WriteLine();
System.Console.WriteLine("<End of Listing>");
System.Console.WriteLine();
//OUTPUT:
//Display accounts ordered by name
//================================
//A. Datum Corporation
//Adventure Works
//Coho Vineyard
//Fabrikam
//Fourth Coffee 1
//Fourth Coffee 10
//Fourth Coffee 2
//Fourth Coffee 3
//Fourth Coffee 4
//Fourth Coffee 5
//Fourth Coffee 6
//Fourth Coffee 7
//Fourth Coffee 8
//Fourth Coffee 9
//Humongous Insurance
//<End of Listing>
// Filter multiple entities using LINQ.
var query = from c in orgContext.CreateQuery("contact")
join a in orgContext.CreateQuery("account")
on c["contactid"] equals a["primarycontactid"]
where (String)c["lastname"] == "Wilcox" ||
(String)c["lastname"] == "Andrews"
where ((String)a["address1_telephone1"]).Contains("(206)")
|| ((String)a["address1_telephone1"]).Contains("(425)")
select new
{
Contact = new
{
FirstName = c["firstname"],
LastName = c["lastname"]
},
Account = new
{
Address1_Telephone1 = a["address1_telephone1"]
}
};
Console.WriteLine("Join account and contact");
Console.WriteLine("List all records matching specified parameters");
Console.WriteLine("Contact name: Wilcox or Andrews");
Console.WriteLine("Account area code: 206 or 425");
Console.WriteLine("==============================================");
foreach (var record in query)
{
Console.WriteLine("Contact Name: {0} {1}",
record.Contact.FirstName, record.Contact.LastName);
Console.WriteLine("Account Phone: {0}",
record.Account.Address1_Telephone1);
}
Console.WriteLine("<End of Listing>");
Console.WriteLine();
//OUTPUT:
//Join account and contact
//List all records matching specified parameters
//Contact name: Wilcox or Andrews
//Account area code: 206 or 425
//==============================================
//Contact Name: Ben Andrews
//Account Phone: (206)555-5555
//Contact Name: Ben Andrews
//Account Phone: (425)555-5555
//Contact Name: Colin Wilcox
//Account Phone: (425)555-5555
//<End of Listing>
// Build a complex query with LINQ. This query includes multiple
// JOINs and a complex WHERE statement.
var complexQuery = from c in orgContext.CreateQuery("contact")
join a in orgContext.CreateQuery("account")
on c["contactid"] equals a["primarycontactid"]
join l in orgContext.CreateQuery("lead")
on a["originatingleadid"] equals l["leadid"]
where (String)c["lastname"] == "Wilcox" ||
(String)c["lastname"] == "Andrews"
where ((String)a["address1_telephone1"]).Contains("(206)")
|| ((String)a["address1_telephone1"]).Contains("(425)")
select new
{
Contact = new
{
FirstName = c["firstname"],
LastName = c["lastname"]
},
Account = new
{
Address1_Telephone1 = a["address1_telephone1"]
},
Lead = new
{
LeadId = l["leadid"]
}
};
Console.WriteLine("Join account, contact and lead");
Console.WriteLine("List all records matching specified parameters");
Console.WriteLine("Contact name: Wilcox or Andrews");
Console.WriteLine("Account area code: 206 or 425");
Console.WriteLine("==============================================");
foreach (var record in complexQuery)
{
Console.WriteLine("Lead ID: {0}",
record.Lead.LeadId);
Console.WriteLine("Contact Name: {0} {1}",
record.Contact.FirstName, record.Contact.LastName);
Console.WriteLine("Account Phone: {0}",
record.Account.Address1_Telephone1);
}
Console.WriteLine("<End of Listing>");
Console.WriteLine();
//OUTPUT:
//Join account, contact and lead
//List all records matching specified parameters
//Contact name: Wilcox or Andrews
//Account area code: 206 or 425
//==============================================
//Lead ID: 78d5df14-64a3-e011-aea3-00155dba3818
//Contact Name: Colin Wilcox
//Account Phone: (425)555-5555
//<End of Listing>
DeleteRequiredRecords(promptforDelete);
}
}
// Catch any service fault exceptions that Microsoft Dynamics CRM throws.
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>)
{
// You can handle an exception here or pass it back to the calling method.
throw;
}
}
/// <summary>
/// Creates any entity records that this sample requires.
/// </summary>
public void CreateRequiredRecords()
{
// Create 3 contacts.
Contact contact = new Contact()
{
FirstName = "Ben",
LastName = "Andrews",
EMailAddress1 = "sample@example.com",
Address1_City = "Redmond",
Address1_StateOrProvince = "WA"
};
_contactIds.Add(_serviceProxy.Create(contact));
contact = new Contact()
{
FirstName = "Colin",
LastName = "Wilcox",
EMailAddress1 = "sample@example.com",
Address1_City = "Bellevue",
Address1_StateOrProvince = "WA"
};
_contactIds.Add(_serviceProxy.Create(contact));
contact = new Contact()
{
FirstName = "Ben",
LastName = "Smith",
EMailAddress1 = "sample@example.com",
Address1_City = "Bellevue",
Address1_StateOrProvince = "WA"
};
_contactIds.Add(_serviceProxy.Create(contact));
// Create 3 leads.
Lead lead = new Lead()
{
FirstName = "Dan",
LastName = "Wilson",
EMailAddress1 = "sample@example.com",
Address1_City = "Redmond",
Address1_StateOrProvince = "WA"
};
_leadIds.Add(_serviceProxy.Create(lead));
lead = new Lead()
{
FirstName = "Jim",
LastName = "Wilson",
EMailAddress1 = "sample@example.com",
Address1_City = "Bellevue",
Address1_StateOrProvince = "WA"
};
_leadIds.Add(_serviceProxy.Create(lead));
lead = new Lead()
{
FirstName = "Denise",
LastName = "Smith",
EMailAddress1 = "sample@example.com",
Address1_City = "Bellevue",
Address1_StateOrProvince = "WA"
};
_leadIds.Add(_serviceProxy.Create(lead));
// Create 5 customized Accounts for the LINQ samples.
Account account = new Account
{
Name = "A. Datum Corporation",
Address1_StateOrProvince = "Colorado",
Address1_Telephone1 = "(206)555-5555",
PrimaryContactId =
new EntityReference(Contact.EntityLogicalName, _contactIds[0])
};
_accountIds.Add(_serviceProxy.Create(account));
account = new Account
{
Name = "Adventure Works",
Address1_StateOrProvince = "Illinois",
Address1_County = "Lake County",
Address1_Telephone1 = "(206)555-5555",
OriginatingLeadId =
new EntityReference(Lead.EntityLogicalName, _leadIds[0])
};
_accountIds.Add(_serviceProxy.Create(account));
account = new Account
{
Name = "Coho Vineyard",
Address1_StateOrProvince = "Washington",
Address1_County = "King County",
Address1_Telephone1 = "(425)555-5555",
PrimaryContactId =
new EntityReference(Contact.EntityLogicalName, _contactIds[1]),
OriginatingLeadId =
new EntityReference(Lead.EntityLogicalName, _leadIds[0])
};
_accountIds.Add(_serviceProxy.Create(account));
account = new Account
{
Name = "Fabrikam",
Address1_StateOrProvince = "Washington",
Address1_Telephone1 = "(425)555-5555",
PrimaryContactId =
new EntityReference(Contact.EntityLogicalName, _contactIds[0])
};
_accountIds.Add(_serviceProxy.Create(account));
account = new Account
{
Name = "Humongous Insurance",
Address1_StateOrProvince = "Missouri",
Address1_County = "Saint Louis County",
Address1_Telephone1 = "(314)555-5555",
PrimaryContactId =
new EntityReference(Contact.EntityLogicalName, _contactIds[1])
};
_accountIds.Add(_serviceProxy.Create(account));
// Create 10 basic Account records.
for (int i = 1; i <= 10; i++)
{
account = new Account
{
Name = "Fourth Coffee " + i,
Address1_StateOrProvince = "California"
};
_accountIds.Add(_serviceProxy.Create(account));
}
}
/// <summary>
/// Deletes any entity records that were created for this sample.
/// <param name="prompt">Indicates whether to prompt the user
/// to delete the records created in this sample.</param>
/// </summary>
public void DeleteRequiredRecords(bool prompt)
{
bool toBeDeleted = true;
if (prompt)
{
// Ask the user if the created entities should be deleted.
Console.Write("\nDo you want these entity records deleted? (y/n) [y]: ");
String answer = Console.ReadLine();
if (answer.StartsWith("y") ||
answer.StartsWith("Y") ||
answer == String.Empty)
{
toBeDeleted = true;
}
else
{
toBeDeleted = false;
}
}
if (toBeDeleted)
{
// Delete all records created in this sample.
foreach (Guid accountId in _accountIds)
{
_serviceProxy.Delete(Account.EntityLogicalName, accountId);
}
foreach (Guid contactId in _contactIds)
{
_serviceProxy.Delete(Contact.EntityLogicalName, contactId);
}
foreach (Guid leadId in _leadIds)
{
_serviceProxy.Delete(Lead.EntityLogicalName, leadId);
}
Console.WriteLine("Entity record(s) have been deleted.");
}
}
#endregion How To Sample Code
#region Main method
/// <summary>
/// Standard Main() method used by most SDK samples.
/// </summary>
/// <param name="args"></param>
static public void Main(string[] args)
{
try
{
// Obtain the target organization's Web address and client logon
// credentials from the user.
ServerConnection serverConnect = new ServerConnection();
ServerConnection.Configuration config = serverConnect.GetServerConfiguration();
UseLinqWithDotNetDataServicesDE app = new UseLinqWithDotNetDataServicesDE();
app.Run(config, true);
}
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp);
Console.WriteLine("Code: {0}", ex.Detail.ErrorCode);
Console.WriteLine("Message: {0}", ex.Detail.Message);
Console.WriteLine("Plugin Trace: {0}", ex.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == ex.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
catch (System.TimeoutException ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Message: {0}", ex.Message);
Console.WriteLine("Stack Trace: {0}", ex.StackTrace);
Console.WriteLine("Inner Fault: {0}",
null == ex.InnerException.Message ? "No Inner Fault" : ex.InnerException.Message);
}
catch (System.Exception ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine(ex.Message);
// Display the details of the inner exception.
if (ex.InnerException != null)
{
Console.WriteLine(ex.InnerException.Message);
FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> fe = ex.InnerException
as FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>;
if (fe != null)
{
Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp);
Console.WriteLine("Code: {0}", fe.Detail.ErrorCode);
Console.WriteLine("Message: {0}", fe.Detail.Message);
Console.WriteLine("Plugin Trace: {0}", fe.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == fe.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
}
}
// Additonal exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,
// SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.
finally
{
Console.WriteLine("Press <Enter> to exit.");
Console.ReadLine();
}
}
#endregion Main method
}
}
See Also
OrganizationServiceContext
CreateQuery<TEntity>
CreateQuery
Build queries with LINQ (.NET language-integrated query)
© 2016 Microsoft. All rights reserved. Copyright