Query: Adds ArrayContains to CosmosLinqExtensions to allow partial matching on array fields in queries #4992
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bcrobinson
force-pushed
the
feature/array_contains_builtin_function
branch
from
3c89ee6 to
e7785f8
Compare
|
@microsoft-github-policy-service agree company="Solarvista Software LTD" |
bcrobinson
force-pushed
the
feature/array_contains_builtin_function
branch
2 times, most recently
from
8ec125f to
f6b6d84
Compare
The `Array_Contains` funtion CosmosDB Sql has a 3rd parameter which allows it to do a partial match on the given item. This is unable to be called with the built in Linq `array.Contains(item)` extension methods.
This adds this adds an explicit mapping to this function to allow it to be called in Linq like this:
`documents.Where(document => document.ObjectArray.ArrayContains(new { Name = "abc" }, true))`
bcrobinson
force-pushed
the
feature/array_contains_builtin_function
branch
from
f6b6d84 to
786db81
Compare
bcrobinson
requested review from
a team,
khdang,
sboshra,
adityasa,
neildsh,
kirankumarkolli,
FabianMeiswinkel and
kirillg
as code owners
bcrobinson
changed the title
|
@bcrobinson technically adding this functionality makes sense. However, ARRAY_CONTAINS with partial match is a very expensive function (both RU consumption and latency wise) and use of it is generally discouraged in favor of another pattern. |
adityasa
reviewed
Feb 5, 2025
| new LinqTestInput("ArrayContains in Select clause with int value and match partial false", b => getQuery(b).Select(doc => doc.ArrayField.ArrayContains(1, false))), | ||
| new LinqTestInput("ArrayContains in Filter clause with int value and match partial false", b => getQuery(b).Where(doc => doc.ArrayField.ArrayContains(1, false))), | ||
| new LinqTestInput("ArrayContains in Select clause with object value and match partial false", b => getQuery(b).Select(doc => doc.ObjectArrayField.ArrayContains(new { Field = "abc" }, false))), | ||
| new LinqTestInput("ArrayContains in Filter clause with object value and match partial false", b => getQuery(b).Where(doc => doc.ObjectArrayField.ArrayContains(new { Field = "abc" }, false))), |
There was a problem hiding this comment.
Can you also include coverage for ArrayContains without third parameter?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description
The
Array_Containsfunction CosmosDB Sql has a 3rd parameter which allows it to do a partial match on the given item. This is unable to be called with the built in Linqarray.Contains(item)extension methods.This adds this adds an explicit mapping to this function to allow it to be called in Linq like this:
Remarks
New extension method called
ArrayContainsinstead ofContainsI namef the new
CosmosLinqExtensionsextension methodArrayContainsinstead ofContainsas the other extensions methods matched thier Cosmos Sql counterparts and because this is for a direct invokation of this function.Can change the name if you require.
ArrayContainsSignatureThe
itemToMatchparamater is anobjectas it will need to take anonymous objects (and c# doesn't have a similar concept to typescript'sPartial<T>). If was generic callers would be force to pass in an object of the same type, and the default serialiser creates object with every property that exists on the class. So the created query object with default values (e.g. Array_Contains(root["Items"],{ "I" = 0, "s" = null }))which would the cause Cosmos to try and match on all properties.Because it's not generic the
objis thenIEnumerable, so it would at a minimum only work on iterable values.If this was
ArrayContains<T>(this IEnumerable<T> obj, T itemToMatch, bool partialMatch)then we'd need to always pass the sameTtype to this method, and the serialiser would then serialise all the properties on the typeT, which would cause the partial matching in cosmos to fail. The downside is you loose some type checking (the anonymous object could have a property name typed wrong),Modification to
ArrayContainsVisitorThe
ArrayContainsVisitorvisitor already exists for theContainsLinq mappings, the I modified this to work with the different extension version for Array Contains.Type of change
Closing issues
closes #4991
To automatically close an issue: closes #IssueNumber