DocumentClient.CreateUserDefinedFunctionQuery Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| CreateUserDefinedFunctionQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for user-defined functions in the Azure Cosmos DB service. |
| CreateUserDefinedFunctionQuery(String, FeedOptions) |
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB service. It returns An IOrderedQueryable{UserDefinedFunction}. |
| CreateUserDefinedFunctionQuery(Uri, FeedOptions) |
Extension method to create a query for user-defined functions in the Azure Cosmos DB service. |
| CreateUserDefinedFunctionQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB database with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec. |
| CreateUserDefinedFunctionQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{dynamic}. |
| CreateUserDefinedFunctionQuery(Uri, String, FeedOptions) |
Extension method to create a query for user-defined functions in the Azure Cosmos DB service. |
CreateUserDefinedFunctionQuery(Uri, SqlQuerySpec, FeedOptions)
Extension method to create a query for user-defined functions in the Azure Cosmos DB service.
public System.Linq.IQueryable<dynamic> CreateUserDefinedFunctionQuery (Uri userDefinedFunctionsUri, Microsoft.Azure.Documents.SqlQuerySpec querySpec, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);abstract member CreateUserDefinedFunctionQuery : Uri * Microsoft.Azure.Documents.SqlQuerySpec * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>
override this.CreateUserDefinedFunctionQuery : Uri * Microsoft.Azure.Documents.SqlQuerySpec * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>Public Function CreateUserDefinedFunctionQuery (userDefinedFunctionsUri As Uri, querySpec As SqlQuerySpec, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of Object)Parameters
- userDefinedFunctionsUri
- Uri
the URI to the user-defined functions.
- querySpec
- SqlQuerySpec
The sql query.
- feedOptions
- FeedOptions
The options for processing the query results feed.
Returns
The query result set.
Implements
Applies to
CreateUserDefinedFunctionQuery(String, FeedOptions)
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB service. It returns An IOrderedQueryable{UserDefinedFunction}.
public System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.UserDefinedFunction> CreateUserDefinedFunctionQuery (string collectionLink, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);abstract member CreateUserDefinedFunctionQuery : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.UserDefinedFunction>
override this.CreateUserDefinedFunctionQuery : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.UserDefinedFunction>Public Function CreateUserDefinedFunctionQuery (collectionLink As String, Optional feedOptions As FeedOptions = Nothing) As IOrderedQueryable(Of UserDefinedFunction)Parameters
- collectionLink
- String
The link to the parent collection resource.
- feedOptions
- FeedOptions
The options for processing the query result feed. For details, see FeedOptions
Returns
An IOrderedQueryable{UserDefinedFunction} that can evaluate the query with the provided SQL statement.
Implements
Examples
This example below queries for user-defined functions by id.
UserDefinedFunction udf = client.CreateUserDefinedFunctionQuery(collectionLink).Where(u => u.Id == "sqrt").AsEnumerable().FirstOrDefault();
See also
Applies to
CreateUserDefinedFunctionQuery(Uri, FeedOptions)
Extension method to create a query for user-defined functions in the Azure Cosmos DB service.
public System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.UserDefinedFunction> CreateUserDefinedFunctionQuery (Uri userDefinedFunctionsUri, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);abstract member CreateUserDefinedFunctionQuery : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.UserDefinedFunction>
override this.CreateUserDefinedFunctionQuery : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.UserDefinedFunction>Public Function CreateUserDefinedFunctionQuery (userDefinedFunctionsUri As Uri, Optional feedOptions As FeedOptions = Nothing) As IOrderedQueryable(Of UserDefinedFunction)Parameters
- userDefinedFunctionsUri
- Uri
the URI to the user-defined functions.
- feedOptions
- FeedOptions
The options for processing the query results feed.
Returns
The query result set.
Implements
Applies to
CreateUserDefinedFunctionQuery(String, SqlQuerySpec, FeedOptions)
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB database with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.
public System.Linq.IQueryable<dynamic> CreateUserDefinedFunctionQuery (string collectionLink, Microsoft.Azure.Documents.SqlQuerySpec querySpec, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);abstract member CreateUserDefinedFunctionQuery : string * Microsoft.Azure.Documents.SqlQuerySpec * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>
override this.CreateUserDefinedFunctionQuery : string * Microsoft.Azure.Documents.SqlQuerySpec * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>Public Function CreateUserDefinedFunctionQuery (collectionLink As String, querySpec As SqlQuerySpec, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of Object)Parameters
- collectionLink
- String
The link to the parent collection resource.
- querySpec
- SqlQuerySpec
The SqlQuerySpec instance containing the SQL expression.
- feedOptions
- FeedOptions
The options for processing the query result feed. For details, see FeedOptions
Returns
An IQueryable{dynamic} that can evaluate the query with the provided SQL statement.
Implements
Examples
This example below queries for user-defined functions by id.
var query = new SqlQuerySpec("SELECT * FROM udfs u WHERE u.id = @id", new SqlParameterCollection(new SqlParameter[] { new SqlParameter { Name = "@id", Value = "sqrt" }}));
UserDefinedFunction udf = client.CreateUserDefinedFunctionQuery(collectionLink, query).AsEnumerable().FirstOrDefault();
Remarks
Refer to https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started/ for syntax and examples.
See also
Applies to
CreateUserDefinedFunctionQuery(String, String, FeedOptions)
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{dynamic}.
public System.Linq.IQueryable<dynamic> CreateUserDefinedFunctionQuery (string collectionLink, string sqlExpression, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);abstract member CreateUserDefinedFunctionQuery : string * string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>
override this.CreateUserDefinedFunctionQuery : string * string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>Public Function CreateUserDefinedFunctionQuery (collectionLink As String, sqlExpression As String, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of Object)Parameters
- collectionLink
- String
The link to the parent collection resource.
- sqlExpression
- String
The SQL statement.
- feedOptions
- FeedOptions
The options for processing the query result feed. For details, see FeedOptions
Returns
An IQueryable{dynamic} that can evaluate the query with the provided SQL statement.
Implements
Examples
This example below queries for user-defined functions by id.
UserDefinedFunction udf = client.CreateUserDefinedFunctionQuery(collectionLink, "SELECT * FROM udfs u WHERE u.id = 'sqrt'").AsEnumerable().FirstOrDefault();
Remarks
Refer to https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started/ for syntax and examples.
See also
Applies to
CreateUserDefinedFunctionQuery(Uri, String, FeedOptions)
Extension method to create a query for user-defined functions in the Azure Cosmos DB service.
public System.Linq.IQueryable<dynamic> CreateUserDefinedFunctionQuery (Uri userDefinedFunctionsUri, string sqlExpression, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);abstract member CreateUserDefinedFunctionQuery : Uri * string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>
override this.CreateUserDefinedFunctionQuery : Uri * string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>Public Function CreateUserDefinedFunctionQuery (userDefinedFunctionsUri As Uri, sqlExpression As String, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of Object)Parameters
- userDefinedFunctionsUri
- Uri
the URI to the user-defined functions.
- sqlExpression
- String
The sql query.
- feedOptions
- FeedOptions
The options for processing the query results feed.
Returns
The query result set.
Implements
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for