DocumentQueryable.CreateDocumentQuery Method (DocumentClient, String, String, FeedOptions)

Article
03/20/2015
2 minutes to read

Extension method to create a query for documents.

Namespace: Microsoft.Azure.Documents.Linq
Assembly: Microsoft.Azure.Documents.Client (in Microsoft.Azure.Documents.Client.dll)

Usage

'Usage
Dim client As DocumentClient
Dim documentsLink As String
Dim sqlExpression As String
Dim feedOptions As FeedOptions
Dim returnValue As IQueryable(Of Object)

returnValue = DocumentQueryable.CreateDocumentQuery(client, documentsLink, sqlExpression, feedOptions)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function CreateDocumentQuery ( _
    client As DocumentClient, _
    documentsLink As String, _
    sqlExpression As String, _
    <OptionalAttribute> Optional feedOptions As FeedOptions = Nothing _
) As IQueryable(Of Object)

[ExtensionAttribute] 
public static IQueryable<Object> CreateDocumentQuery (
    DocumentClient client,
    string documentsLink,
    string sqlExpression,
    [OptionalAttribute] FeedOptions feedOptions
)

[ExtensionAttribute] 
public:
static IQueryable<Object^>^ CreateDocumentQuery (
    DocumentClient^ client, 
    String^ documentsLink, 
    String^ sqlExpression, 
    [OptionalAttribute] FeedOptions^ feedOptions
)

/** @attribute ExtensionAttribute() */ 
public static IQueryable<Object> CreateDocumentQuery (
    DocumentClient client, 
    String documentsLink, 
    String sqlExpression, 
    /** @attribute OptionalAttribute() */ FeedOptions feedOptions
)

ExtensionAttribute 
public static function CreateDocumentQuery (
    client : DocumentClient, 
    documentsLink : String, 
    sqlExpression : String, 
    feedOptions : FeedOptions
) : IQueryable<Object>

Parameters

client
The DocumentClient to use.

documentsLink
The link to the documents.

sqlExpression
The SQL query.

feedOptions
The options for processing the query results feed.

Return Value

The query result set.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012