CosmosDbFunctionsExtensions Class

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.Cosmos.dll

Package:: Microsoft.EntityFrameworkCore.Cosmos v10.0.0

Source:: CosmosDbFunctionsExtensions.cs

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.

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.

[System.Runtime.CompilerServices.Nullable(0)]
public static class CosmosDbFunctionsExtensions

[<System.Runtime.CompilerServices.Nullable(0)>]
type CosmosDbFunctionsExtensions = class

Public Module CosmosDbFunctionsExtensions

Inheritance: Object
CosmosDbFunctionsExtensions

Attributes: NullableAttribute

Remarks

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

Methods

Name	Description
CoalesceUndefined<T>(DbFunctions, T, T)	Coalesces a Cosmos `undefined` value via the `??` operator.
FullTextContains(DbFunctions, String, String)	Checks if the specified property contains the given keyword using full-text search.
FullTextContainsAll(DbFunctions, String, String[])	Checks if the specified property contains all the given keywords using full-text search.
FullTextContainsAny(DbFunctions, String, String[])	Checks if the specified property contains any of the given keywords using full-text search.
FullTextScore(DbFunctions, String, String[])	Returns the full-text search score for the specified property and keywords.
IsDefined(DbFunctions, Object)	Returns a boolean indicating if the property has been assigned a value. Corresponds to the Cosmos `IS_DEFINED` function.
Rrf(DbFunctions, Double[], Double[])	Combines scores provided by two or more specified functions.
Rrf(DbFunctions, Double[])	Combines scores provided by two or more specified functions.
VectorDistance(DbFunctions, ReadOnlyMemory<Byte>, ReadOnlyMemory<Byte>, Nullable<Boolean>, VectorDistanceOptions)	Returns the distance between two vectors, given a distance function (aka similarity measure).
VectorDistance(DbFunctions, ReadOnlyMemory<SByte>, ReadOnlyMemory<SByte>, Nullable<Boolean>, VectorDistanceOptions)	Returns the distance between two vectors, given a distance function (aka similarity measure).
VectorDistance(DbFunctions, ReadOnlyMemory<Single>, ReadOnlyMemory<Single>, Nullable<Boolean>, VectorDistanceOptions)	Returns the distance between two vectors, given a distance function (aka similarity measure).

Applies to

Feedback

Was this page helpful?