Class CosmosLinq

Namespace

Microsoft.Azure.Cosmos.Linq

Assembly

Microsoft.Azure.Cosmos.Client.dll

This class provides methods for cosmos LINQ code.

public static class CosmosLinq

Inheritance

object

CosmosLinq

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

InvokeUserDefinedFunction(string, params object[])

Helper method to invoke User Defined Functions via Linq queries in the Azure Cosmos DB service.

public static object InvokeUserDefinedFunction(string udfName, params object[] arguments)

Parameters

udfName string

The UserDefinedFunction name

arguments object[]

The arguments of the UserDefinedFunction

Returns

object

Placeholder for the udf result.

Examples

// Equivalent to SELECT * FROM books b WHERE udf.toLowerCase(b.title) = 'war and peace'" 
IQueryable<Book> queryable = client
    .GetContainer("database", "container")
    .GetItemLinqQueryable<Book>()
    .Where(b => CosmosLinq.InvokeUserDefinedFunction("toLowerCase", b.Title) == "war and peace");

FeedIterator<Book> bookIterator = queryable.ToFeedIterator();
while (feedIterator.HasMoreResults)
{
    FeedResponse<Book> responseMessage = await feedIterator.ReadNextAsync();
    DoSomethingWithResponse(responseMessage);
}

Remarks

This is a stub helper method for use within LINQ expressions. Cannot be called directly. Refer to https://docs.microsoft.com/azure/cosmos-db/sql-query-linq-to-sql for more details about the LINQ provider. Refer to https://docs.microsoft.com/azure/cosmos-db/stored-procedures-triggers-udfs for more details about user defined functions.

See Also

UserDefinedFunctionProperties