CSHARP-5543: Add new options for Atlas Search Text and Phrase operators #1678

adelinowona · 2025-04-25T22:34:05Z

No description provided.

BorisDog

Few minor comments

BorisDog · 2025-04-28T18:30:56Z

src/MongoDB.Driver/Search/SearchPhraseOptions.cs

+        /// <summary>
+        /// The score modifier.
+        /// </summary>
+        public SearchScoreDefinition<TDocument> Score { get; set; }


Alphabetic order?

BorisDog · 2025-04-28T18:37:45Z

src/MongoDB.Driver/Search/SearchTextOptions.cs

+        /// The criteria to use to match the terms in the query. Value can be either "any" or "all".
+        /// Defaults to "all" if omitted.
+        /// </summary>
+        public string MatchCriteria { get; set; }


Please check if this can be enum.

Should be ok!

BorisDog · 2025-04-28T18:39:16Z

src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

@@ -457,6 +470,7 @@ internal sealed class TextSearchDefinition<TDocument> : OperatorSearchDefinition
        private readonly SearchFuzzyOptions _fuzzy;
        private readonly SearchQueryDefinition _query;
        private readonly string _synonyms;
+        private readonly string _matchCriteria;


Alphabetical order.

BorisDog · 2025-04-28T23:12:43Z

src/MongoDB.Driver/MatchCriteria.cs

+    /// <summary>
+    /// Represents the criteria used to match terms in a query for the Atlas Search Text operator.
+    /// </summary>
+    public enum MatchCriteria


I think this should in Search folder (and namespace).

BorisDog · 2025-04-28T23:15:17Z

src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

@@ -329,11 +330,23 @@ public PhraseSearchDefinition(
            _slop = slop;
        }

+        public PhraseSearchDefinition(


Do we need two ctors? This class is internal so it's safe to change.

BorisDog · 2025-04-28T23:26:12Z

src/MongoDB.Driver/Search/SearchTextOptions.cs

+        /// The criteria to use to match the terms in the query. Value can be either "any" or "all".
+        /// Defaults to "all" if omitted.
+        /// </summary>
+        public MatchCriteria MatchCriteria { get; set; }


I would say we do not need the property be nullable. It should simply have the default value of MatchCriteria.All. Why do we need additional third state of null?

As per discussion with Boris, we probably should have it nullable so the user could explicitly have a 3rd unset state.

src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

sanych-sun · 2025-04-29T00:17:27Z

src/MongoDB.Driver/Search/SearchTextOptions.cs

+        /// The criteria to use to match the terms in the query. Value can be either "any" or "all".
+        /// Defaults to "all" if omitted.
+        /// </summary>
+        public MatchCriteria MatchCriteria { get; set; }


I would say we do not need the property be nullable. It should simply have the default value of MatchCriteria.All. Why do we need additional third state of null?

src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

sanych-sun · 2025-04-29T00:30:03Z

src/MongoDB.Driver/Search/SearchTextOptions.cs

+        /// <summary>
+        /// The name of the synonym mapping definition in the index definition. Value can't be an empty string.
+        /// </summary>
+        public string Synonyms { get; set; }


xml-docs says: Value can't be an empty string. Should we enforce this condition?

Similar to my other comment I prefer letting the server error rather than enforcing the condition in the driver. Yes, it's simple but I don't think the driver should be doing that much hand holding.

If we letting server to decide, why do we have it in XML docs then? =)

It's in the XML docs because I mirrored the official docs and it's mentioned there. I didn't think much of it.

src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

BorisDog

Minor changes requested.

BorisDog · 2025-04-30T16:11:20Z

src/MongoDB.Driver/Search/SearchDefinitionBuilder.cs

+            SearchPathDefinition<TDocument> path,
+            SearchQueryDefinition query,
+            SearchPhraseOptions<TDocument> options) =>
+            new PhraseSearchDefinition<TDocument>(path, query, options);


Indentation here and other places.

BorisDog · 2025-04-30T16:16:07Z

src/MongoDB.Driver/Search/SearchPhraseOptions.cs

+        public int? Slop { get; set; }
+
+        /// <summary>
+        /// The name of the synonym mapping definition in the index definition. Value can't be an empty string.


minor: 'Value can't be an empty string': it might sound like null is also an invalid value. I think it's worth clarifying this.

BorisDog · 2025-04-30T19:03:11Z

src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

-            SearchScoreDefinition<TDocument> score)
-                : base(OperatorType.Phrase, path, score)
+            SearchPhraseOptions<TDocument> options)
+            : base(OperatorType.Phrase, path, options?.Score)


Also indentation for this line (and in TextSearchDefinition ctor)

BorisDog · 2025-04-30T19:08:18Z

src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

        }

        private protected override BsonDocument RenderArguments(RenderArgs<TDocument> args) =>
            new()
            {
                { "query", _query.Render() },
                { "fuzzy", () => _fuzzy.Render(), _fuzzy != null },
-                { "synonyms", _synonyms, _synonyms != null }
+                { "synonyms", _synonyms, _synonyms != null },
+                { "matchCriteria", _matchCriteria == MatchCriteria.Any ? "any" : "all", _matchCriteria != null }


I'd suggest to make this more errorproof and check for unexpected values:

MatchCriteriaToString(MatchCriteria? matchCriteria) => matchCriteria switch { _ => throw... }

Because if a user sets MatchCriteria=(MatchCriteria)3 we don't want to be sending "all" in such case.

Done, thanks!

BorisDog

LGTM

sanych-sun

LGTM

# Conflicts: # src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

adelinowona added the feature label Apr 25, 2025

adelinowona requested a review from BorisDog April 25, 2025 22:34

adelinowona requested a review from a team as a code owner April 25, 2025 22:34

adelinowona removed the request for review from a team April 28, 2025 15:38

BorisDog requested changes Apr 28, 2025

View reviewed changes

adelinowona requested a review from BorisDog April 28, 2025 22:17

BorisDog reviewed Apr 28, 2025

View reviewed changes

sanych-sun requested changes Apr 29, 2025

View reviewed changes

adelinowona requested review from BorisDog and sanych-sun April 29, 2025 20:08

BorisDog requested changes Apr 30, 2025

View reviewed changes

adelinowona requested a review from BorisDog April 30, 2025 16:54

BorisDog requested changes Apr 30, 2025

View reviewed changes

adelinowona requested a review from BorisDog April 30, 2025 20:13

BorisDog approved these changes Apr 30, 2025

View reviewed changes

sanych-sun approved these changes Apr 30, 2025

View reviewed changes

adelinowona added 8 commits May 1, 2025 01:03

CSHARP-5543: Add new options for Atlas Search Text and Phrase operators

494a486

# Conflicts: # src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

put options in alphabetical order

c563ebe

make matchCriteria an enum

5e845d6

address pr comments

573fcc1

fix indentation and clarify api docs

a7a6fa5

fix indentation and more robust matchCriteria checks

b75bcc8

add test for exception

71ec65b

avoid context capturing

d9a7434

# Conflicts: # src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs

adelinowona force-pushed the csharp5543 branch from 6aee06f to d9a7434 Compare May 1, 2025 05:05

adelinowona added 2 commits May 1, 2025 01:07

minor indentation fix

24f4c85

sync xml docs

79bb9e0

adelinowona merged commit d6840c3 into mongodb:main May 1, 2025
1 check was pending

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CSHARP-5543: Add new options for Atlas Search Text and Phrase operators #1678

CSHARP-5543: Add new options for Atlas Search Text and Phrase operators #1678

adelinowona commented Apr 25, 2025

BorisDog left a comment

BorisDog Apr 28, 2025

adelinowona Apr 28, 2025

BorisDog Apr 28, 2025

adelinowona Apr 28, 2025

BorisDog Apr 28, 2025

BorisDog Apr 28, 2025

BorisDog Apr 28, 2025

BorisDog Apr 28, 2025

sanych-sun Apr 29, 2025

sanych-sun Apr 29, 2025

sanych-sun Apr 29, 2025

sanych-sun Apr 29, 2025

adelinowona Apr 29, 2025

sanych-sun Apr 30, 2025

adelinowona Apr 30, 2025

BorisDog left a comment

BorisDog Apr 30, 2025

BorisDog Apr 30, 2025

BorisDog Apr 30, 2025

BorisDog Apr 30, 2025

adelinowona Apr 30, 2025

BorisDog left a comment

sanych-sun left a comment

CSHARP-5543: Add new options for Atlas Search Text and Phrase operators #1678

CSHARP-5543: Add new options for Atlas Search Text and Phrase operators #1678

Conversation

adelinowona commented Apr 25, 2025

BorisDog left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BorisDog left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BorisDog left a comment

Choose a reason for hiding this comment

sanych-sun left a comment

Choose a reason for hiding this comment