CSHARP-5543: Add new options for Atlas Search Text and Phrase operators #1678
Conversation
| /// <summary> | ||
| /// The score modifier. | ||
| /// </summary> | ||
| public SearchScoreDefinition<TDocument> Score { get; set; } |
| /// 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; } |
There was a problem hiding this comment.
Please check if this can be enum.
| private readonly SearchFuzzyOptions _fuzzy; | ||
| private readonly SearchQueryDefinition _query; | ||
| private readonly string _synonyms; | ||
| private readonly string _matchCriteria; |
| /// <summary> | ||
| /// Represents the criteria used to match terms in a query for the Atlas Search Text operator. | ||
| /// </summary> | ||
| public enum MatchCriteria |
There was a problem hiding this comment.
I think this should in Search folder (and namespace).
| _slop = slop; | ||
| } | ||
|
|
||
| public PhraseSearchDefinition( |
There was a problem hiding this comment.
Do we need two ctors? This class is internal so it's safe to change.
| /// 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; } |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
As per discussion with Boris, we probably should have it nullable so the user could explicitly have a 3rd unset state.
| /// 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; } |
There was a problem hiding this comment.
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?
| /// <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; } |
There was a problem hiding this comment.
xml-docs says: Value can't be an empty string. Should we enforce this condition?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
If we letting server to decide, why do we have it in XML docs then? =)
There was a problem hiding this comment.
It's in the XML docs because I mirrored the official docs and it's mentioned there. I didn't think much of it.
| SearchPathDefinition<TDocument> path, | ||
| SearchQueryDefinition query, | ||
| SearchPhraseOptions<TDocument> options) => | ||
| new PhraseSearchDefinition<TDocument>(path, query, options); |
There was a problem hiding this comment.
Indentation here and other places.
| public int? Slop { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// The name of the synonym mapping definition in the index definition. Value can't be an empty string. |
There was a problem hiding this comment.
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.
| SearchScoreDefinition<TDocument> score) | ||
| : base(OperatorType.Phrase, path, score) | ||
| SearchPhraseOptions<TDocument> options) | ||
| : base(OperatorType.Phrase, path, options?.Score) |
There was a problem hiding this comment.
Also indentation for this line (and in TextSearchDefinition ctor)
| { "fuzzy", () => _fuzzy.Render(), _fuzzy != null }, | ||
| { "synonyms", _synonyms, _synonyms != null } | ||
| { "synonyms", _synonyms, _synonyms != null }, | ||
| { "matchCriteria", _matchCriteria == MatchCriteria.Any ? "any" : "all", _matchCriteria != null } |
There was a problem hiding this comment.
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.
# Conflicts: # src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs
# Conflicts: # src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs
No description provided.