DataServiceContext.Execute<TElement> Method (Uri)

Sends a request to the data service to execute a specific URI.

Not supported by the WCF Data Services 5.0 client for Silverlight.

Namespace:  System.Data.Services.Client
Assembly:  Microsoft.Data.Services.Client (in Microsoft.Data.Services.Client.dll)

Syntax

'Declaration
Public Function Execute(Of TElement) ( _
    requestUri As Uri _
) As IEnumerable(Of TElement)
'Usage
Dim instance As DataServiceContext 
Dim requestUri As Uri 
Dim returnValue As IEnumerable(Of TElement)

returnValue = instance.Execute(requestUri)

public IEnumerable<TElement> Execute<TElement>(
    Uri requestUri
)

public:
generic<typename TElement>
IEnumerable<TElement>^ Execute(
    Uri^ requestUri
)

member Execute : 
        requestUri:Uri -> IEnumerable<'TElement> 

JScript does not support generic types and methods.

Type Parameters

• TElement
  The type that the query returns.

Parameters

• requestUri
  Type: System.Uri
  The URI to which the query request will be sent. The URI may be any valid data service URI. Can contain $ query parameters.

Return Value

Type: System.Collections.Generic.IEnumerable<TElement>
The results of the query operation.

Exceptions

Remarks

The Execute method is used to query a data service by URI; the method causes an HTTP GET request to be issued to the data service. The request URI specified can be absolute or relative.

If the requestUri is absolute, this method validates whether the URI points to the same data service that was specified when constructing the DataServiceContext. If the requestUri is relative, this method strips off any leading slashes and appends requestUri to what was provided when constructing the DataServiceContext. A slash is appended after the URI passed to the DataServiceContext constructor, if one is not already present.

When this method returns, all of the HTTP response for the request has been read from the network stream, but the response will not have been processed; there is no identity resolution or object materialization. Identity resolution and full object materialization do not occur for a specified entity in the response until it is enumerated.

Examples

This example uses a do?while loop to load Customers entities from a paged results from the data service. The Execute method is called by using the next link URI to receive the next page of data.

' Create the DataServiceContext using the service URI.
Dim context = New NorthwindEntities(svcUri)
Dim token As DataServiceQueryContinuation(Of Customer) = Nothing
Dim pageCount = 0

Try
    ' Execute the query for all customers and get the response object.
    Dim response As QueryOperationResponse(Of Customer) = _
        CType(context.Customers.Execute(), QueryOperationResponse(Of Customer))

    ' With a paged response from the service, use a do...while loop 
    ' to enumerate the results before getting the next link.
    Do
        ' Write the page number.
        Console.WriteLine("Page {0}:", pageCount + 1)

        ' If nextLink is not null, then there is a new page to load.
        If token IsNot Nothing Then
            ' Load the new page from the next link URI.
            response = CType(context.Execute(Of Customer)(token),  _
            QueryOperationResponse(Of Customer))
        End If

        ' Enumerate the customers in the response.
        For Each customer As Customer In response
            Console.WriteLine(vbTab & "Customer Name: {0}", customer.CompanyName)
        Next

        ' Get the next link, and continue while there is a next link.
        token = response.GetContinuation()
    Loop While token IsNot Nothing
Catch ex As DataServiceQueryException
    Throw New ApplicationException( _
            "An error occurred during query execution.", ex)
End Try

// Create the DataServiceContext using the service URI.
NorthwindEntities context = new NorthwindEntities(svcUri);
DataServiceQueryContinuation<Customer> token = null;
int pageCount = 0; 

try
{ 
    // Execute the query for all customers and get the response object.
    QueryOperationResponse<Customer> response =
        context.Customers.Execute() as QueryOperationResponse<Customer>;

    // With a paged response from the service, use a do...while loop 
    // to enumerate the results before getting the next link.
    do
    {
        // Write the page number.
        Console.WriteLine("Page {0}:", pageCount++);

        // If nextLink is not null, then there is a new page to load.
        if (token != null)
        {
            // Load the new page from the next link URI.
            response = context.Execute<Customer>(token)
                as QueryOperationResponse<Customer>;
        }

        // Enumerate the customers in the response.
        foreach (Customer customer in response)
        {
            Console.WriteLine("\tCustomer Name: {0}", customer.CompanyName);
        }
    }

    // Get the next link, and continue while there is a next link.
    while ((token = response.GetContinuation()) != null);
}
catch (DataServiceQueryException ex)
{
    throw new ApplicationException(
        "An error occurred during query execution.", ex);
}

See Also

Reference

DataServiceContext Class

Execute Overload

System.Data.Services.Client Namespace

Other Resources

Loading Deferred Content (WCF Data Services)

How to: Load Paged Results (WCF Data Services)