DocumentQueryable.CreateUserQuery Method

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

Overload List

	Name	Description
	CreateUserQuery(DocumentClient, String, FeedOptions)	Overloaded. This method creates a query for users under a database. It returns IOrderedQueryable{User}.
	CreateUserQuery(DocumentClient, String, SqlQuerySpec, FeedOptions)	Overloaded. This method creates a query for users under a database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.
	CreateUserQuery(DocumentClient, String, String, FeedOptions)	Overloaded. This method creates a query for users under a database. It returns IQueryable{dyanamic}.

See Also

DocumentQueryable Class
Microsoft.Azure.Documents.Linq Namespace

Return to top

DocumentQueryable.CreateUserQuery Method (DocumentClient, String, FeedOptions)

Overloaded. This method creates a query for users under a database. It returns IOrderedQueryable{User}.

Syntax

public static IOrderedQueryable<User> CreateUserQuery(
    this DocumentClient client,
    string usersLink,
    FeedOptions feedOptions = null
)

public:
[ExtensionAttribute]
static IOrderedQueryable<User^>^ CreateUserQuery(
    DocumentClient^ client,
    String^ usersLink,
    FeedOptions^ feedOptions = null
)

<ExtensionAttribute>
Public Shared Function CreateUserQuery (
    client As DocumentClient,
    usersLink As String,
    feedOptions As FeedOptions
) As IOrderedQueryable(Of User)

Parameters

• client
  Type: Microsoft.Azure.Documents.Client.DocumentClient

  The DocumentClient instance to execute the query.

• usersLink
  Type: System.String

  The path link for the users under a database, e.g. dbs/db_rid/users/.

• feedOptions
  Type: Microsoft.Azure.Documents.Client.FeedOptions

  The options for processing the query result feed. For details, see FeedOptions

Return Value

Type: System.Linq.IOrderedQueryable<User>

An IOrderedQueryable{User} that can evaluate the query.

Examples

This example below queries for users by id.

User user = client.CreateUserQuery(usersLink).Where(u => u.Id == "userid5").AsEnumerable().FirstOrDefault();

See Also

User
IDocumentQuery

Return to top

DocumentQueryable.CreateUserQuery Method (DocumentClient, String, SqlQuerySpec, FeedOptions)

Overloaded. This method creates a query for users under a database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

Syntax

public static IQueryable<object> CreateUserQuery(
    this DocumentClient client,
    string usersLink,
    SqlQuerySpec querySpec,
    FeedOptions feedOptions = null
)

public:
[ExtensionAttribute]
static IQueryable<Object^>^ CreateUserQuery(
    DocumentClient^ client,
    String^ usersLink,
    SqlQuerySpec^ querySpec,
    FeedOptions^ feedOptions = null
)

<ExtensionAttribute>
Public Shared Function CreateUserQuery (
    client As DocumentClient,
    usersLink As String,
    querySpec As SqlQuerySpec,
    feedOptions As FeedOptions
) As IQueryable(Of Object)

Parameters

• client
  Type: Microsoft.Azure.Documents.Client.DocumentClient

  The DocumentClient instance to execute the query.

• usersLink
  Type: System.String

  The path link for the users under a database, e.g. dbs/db_rid/users/.

• querySpec
  Type: Microsoft.Azure.Documents.SqlQuerySpec

  The SqlQuerySpec instance containing the SQL expression.

• feedOptions
  Type: Microsoft.Azure.Documents.Client.FeedOptions

  The options for processing the query result feed. For details, see FeedOptions

Return Value

Type: System.Linq.IQueryable<Object>

an IQueryable{dynamic> that can evaluate the query.

Remarks

Refer to https://msdn.microsoft.com/en-us/library/azure/dn782250.aspx and https://azure.microsoft.com/documentation/articles/documentdb-sql-query/ for syntax and examples.

Examples

This example below queries for users by id.

var query = new SqlQuerySpec(
    "SELECT * FROM users u WHERE u.id = @id", 
    new SqlParameterCollection(new SqlParameter[] { new SqlParameter { Name = "@id", Value = "userid5" }}));

User user = client.CreateUserQuery(usersLink, query).AsEnumerable().FirstOrDefault();

See Also

User
IDocumentQuery

Return to top

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

Overloaded. This method creates a query for users under a database. It returns IQueryable{dyanamic}.

Syntax

public static IQueryable<object> CreateUserQuery(
    this DocumentClient client,
    string usersLink,
    string sqlExpression,
    FeedOptions feedOptions = null
)

public:
[ExtensionAttribute]
static IQueryable<Object^>^ CreateUserQuery(
    DocumentClient^ client,
    String^ usersLink,
    String^ sqlExpression,
    FeedOptions^ feedOptions = null
)

<ExtensionAttribute>
Public Shared Function CreateUserQuery (
    client As DocumentClient,
    usersLink As String,
    sqlExpression As String,
    feedOptions As FeedOptions
) As IQueryable(Of Object)

Parameters

• client
  Type: Microsoft.Azure.Documents.Client.DocumentClient

  The DocumentClient instance to execute the query.

• usersLink
  Type: System.String

  The path link for the users under a database, e.g. dbs/db_rid/users/.

• sqlExpression
  Type: System.String

  The SQL statement.

• feedOptions
  Type: Microsoft.Azure.Documents.Client.FeedOptions

  The options for processing the query result feed. For details, see FeedOptions

Return Value

Type: System.Linq.IQueryable<Object>

an IQueryable{dynamic} that can evaluate the query.

Remarks

Refer to https://msdn.microsoft.com/en-us/library/azure/dn782250.aspx and https://azure.microsoft.com/documentation/articles/documentdb-sql-query/ for syntax and examples.

Examples

This example below queries for users by id.

User user = client.CreateUserQuery(usersLink, "SELECT * FROM users u WHERE u.id = 'userid5'").AsEnumerable().FirstOrDefault();

See Also

User
IDocumentQuery

Return to top