Share via

CosmosDbFunctionsExtensions Class

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore.Cosmos.Extensions
Assembly:
Microsoft.EntityFrameworkCore.Cosmos.dll
Package:
Microsoft.EntityFrameworkCore.Cosmos v9.0.0
Source:
CosmosDbFunctionsExtensions.cs

Provides CLR methods that get translated to database functions when used in LINQ to Entities queries. The methods on this class are accessed via Functions.

public static class CosmosDbFunctionsExtensions
type CosmosDbFunctionsExtensions = class
Public Module CosmosDbFunctionsExtensions
Inheritance
Object
CosmosDbFunctionsExtensions

Remarks

See Database functions, and Accessing Cosmos with EF Core for more information and examples.

Methods

CoalesceUndefined<T>(DbFunctions, T, T)

Coalesces a Cosmos undefined value via the ?? operator.
IsDefined(DbFunctions, Object)

Returns a boolean indicating if the property has been assigned a value. Corresponds to the Cosmos IS_DEFINED function.
VectorDistance(DbFunctions, ReadOnlyMemory<Byte>, ReadOnlyMemory<Byte>, Boolean, DistanceFunction)

Returns the distance between two vectors, given a distance function (aka similarity measure).
VectorDistance(DbFunctions, ReadOnlyMemory<Byte>, ReadOnlyMemory<Byte>, Boolean)

Returns the distance between two vectors, given a distance function (aka similarity measure).
VectorDistance(DbFunctions, ReadOnlyMemory<Byte>, ReadOnlyMemory<Byte>)

Returns the distance between two vectors, using the distance function and data type defined using IsVector(PropertyBuilder, DistanceFunction, Int32) .
VectorDistance(DbFunctions, ReadOnlyMemory<SByte>, ReadOnlyMemory<SByte>, Boolean, DistanceFunction)

Returns the distance between two vectors, given a distance function (aka similarity measure).
VectorDistance(DbFunctions, ReadOnlyMemory<SByte>, ReadOnlyMemory<SByte>, Boolean)

Returns the distance between two vectors, given a distance function (aka similarity measure).
VectorDistance(DbFunctions, ReadOnlyMemory<SByte>, ReadOnlyMemory<SByte>)

Returns the distance between two vectors, using the distance function and data type defined using IsVector(PropertyBuilder, DistanceFunction, Int32) .
VectorDistance(DbFunctions, ReadOnlyMemory<Single>, ReadOnlyMemory<Single>, Boolean, DistanceFunction)

Returns the distance between two vectors, given a distance function (aka similarity measure).
VectorDistance(DbFunctions, ReadOnlyMemory<Single>, ReadOnlyMemory<Single>, Boolean)

Returns the distance between two vectors, given a distance function (aka similarity measure).
VectorDistance(DbFunctions, ReadOnlyMemory<Single>, ReadOnlyMemory<Single>)

Returns the distance between two vectors, using the distance function and data type defined using IsVector(PropertyBuilder, DistanceFunction, Int32) .

Applies to