Skip to content

Add support for SimpleQueryStringQuery.flags property #7869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down Expand Up @@ -545,6 +546,120 @@ public override void Write(Utf8JsonWriter writer, RangeRelation value, JsonSeria
}
}

[JsonConverter(typeof(SimpleQueryStringFlagsConverter))]
[Flags]
public enum SimpleQueryStringFlags
{
[EnumMember(Value = "WHITESPACE")]
Whitespace = 1 << 0,
[EnumMember(Value = "SLOP")]
Slop = 1 << 1,
[EnumMember(Value = "PREFIX")]
Prefix = 1 << 2,
[EnumMember(Value = "PRECEDENCE")]
Precedence = 1 << 3,
[EnumMember(Value = "PHRASE")]
Phrase = 1 << 4,
[EnumMember(Value = "OR")]
Or = 1 << 5,
[EnumMember(Value = "NOT")]
Not = 1 << 6,
[EnumMember(Value = "NONE")]
None = 1 << 7,
[EnumMember(Value = "NEAR")]
Near = 1 << 8,
[EnumMember(Value = "FUZZY")]
Fuzzy = 1 << 9,
[EnumMember(Value = "ESCAPE")]
Escape = 1 << 10,
[EnumMember(Value = "AND")]
And = 1 << 11,
[EnumMember(Value = "ALL")]
All = 1 << 12
}

internal sealed class SimpleQueryStringFlagsConverter : JsonConverter<SimpleQueryStringFlags>
{
public override SimpleQueryStringFlags Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
var s = reader.GetString();
if (string.IsNullOrEmpty(s))
{
return default;
}

var flags = s.Split('|');
var result = default(SimpleQueryStringFlags);
foreach (var flag in flags)
{
result |= flag switch
{
"WHITESPACE" => SimpleQueryStringFlags.Whitespace,
"SLOP" => SimpleQueryStringFlags.Slop,
"PREFIX" => SimpleQueryStringFlags.Prefix,
"PRECEDENCE" => SimpleQueryStringFlags.Precedence,
"PHRASE" => SimpleQueryStringFlags.Phrase,
"OR" => SimpleQueryStringFlags.Or,
"NOT" => SimpleQueryStringFlags.Not,
"NONE" => SimpleQueryStringFlags.None,
"NEAR" => SimpleQueryStringFlags.Near,
"FUZZY" => SimpleQueryStringFlags.Fuzzy,
"ESCAPE" => SimpleQueryStringFlags.Escape,
"AND" => SimpleQueryStringFlags.And,
"ALL" => SimpleQueryStringFlags.All,
_ => throw new JsonException($"Invalid flag value '{flag}' for type '{typeToConvert.Name}'.")
};
}

return result;
}

public override void Write(Utf8JsonWriter writer, SimpleQueryStringFlags value, JsonSerializerOptions options)
{
if (value == default)
{
writer.WriteStringValue(string.Empty);
return;
}

var sb = new StringBuilder();
if (value.HasFlag(SimpleQueryStringFlags.Whitespace))
sb.Append("WHITESPACE|");
if (value.HasFlag(SimpleQueryStringFlags.Slop))
sb.Append("SLOP|");
if (value.HasFlag(SimpleQueryStringFlags.Prefix))
sb.Append("PREFIX|");
if (value.HasFlag(SimpleQueryStringFlags.Precedence))
sb.Append("PRECEDENCE|");
if (value.HasFlag(SimpleQueryStringFlags.Phrase))
sb.Append("PHRASE|");
if (value.HasFlag(SimpleQueryStringFlags.Or))
sb.Append("OR|");
if (value.HasFlag(SimpleQueryStringFlags.Not))
sb.Append("NOT|");
if (value.HasFlag(SimpleQueryStringFlags.None))
sb.Append("NONE|");
if (value.HasFlag(SimpleQueryStringFlags.Near))
sb.Append("NEAR|");
if (value.HasFlag(SimpleQueryStringFlags.Fuzzy))
sb.Append("FUZZY|");
if (value.HasFlag(SimpleQueryStringFlags.Escape))
sb.Append("ESCAPE|");
if (value.HasFlag(SimpleQueryStringFlags.And))
sb.Append("AND|");
if (value.HasFlag(SimpleQueryStringFlags.All))
sb.Append("ALL|");
if (sb.Length == 0)
{
writer.WriteStringValue(string.Empty);
return;
}

sb.Remove(sb.Length - 1, 1);
writer.WriteStringValue(sb.ToString());
}
}

[JsonConverter(typeof(TextQueryTypeConverter))]
public enum TextQueryType
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

using System;
using System.Runtime.Serialization;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Elastic.Clients.Elasticsearch.Core;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ public sealed partial class SimpleQueryStringQuery : SearchQuery
public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get; set; }
[JsonInclude, JsonPropertyName("fields")]
public Fields? Fields { get; set; }
[JsonInclude, JsonPropertyName("flags")]
public Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlags? Flags { get; set; }
[JsonInclude, JsonPropertyName("fuzzy_max_expansions")]
public int? FuzzyMaxExpansions { get; set; }
[JsonInclude, JsonPropertyName("fuzzy_prefix_length")]
Expand Down Expand Up @@ -78,6 +80,7 @@ public SimpleQueryStringQueryDescriptor() : base()
private float? BoostValue { get; set; }
private Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperatorValue { get; set; }
private Fields? FieldsValue { get; set; }
private Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlags? FlagsValue { get; set; }
private int? FuzzyMaxExpansionsValue { get; set; }
private int? FuzzyPrefixLengthValue { get; set; }
private bool? FuzzyTranspositionsValue { get; set; }
Expand Down Expand Up @@ -128,6 +131,12 @@ public SimpleQueryStringQueryDescriptor<TDocument> Fields(Fields? fields)
return Self;
}

public SimpleQueryStringQueryDescriptor<TDocument> Flags(Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlags? flags)
{
FlagsValue = flags;
return Self;
}

public SimpleQueryStringQueryDescriptor<TDocument> FuzzyMaxExpansions(int? fuzzyMaxExpansions)
{
FuzzyMaxExpansionsValue = fuzzyMaxExpansions;
Expand Down Expand Up @@ -215,6 +224,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
JsonSerializer.Serialize(writer, FieldsValue, options);
}

if (FlagsValue is not null)
{
writer.WritePropertyName("flags");
JsonSerializer.Serialize(writer, FlagsValue, options);
}

if (FuzzyMaxExpansionsValue.HasValue)
{
writer.WritePropertyName("fuzzy_max_expansions");
Expand Down Expand Up @@ -272,6 +287,7 @@ public SimpleQueryStringQueryDescriptor() : base()
private float? BoostValue { get; set; }
private Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperatorValue { get; set; }
private Fields? FieldsValue { get; set; }
private Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlags? FlagsValue { get; set; }
private int? FuzzyMaxExpansionsValue { get; set; }
private int? FuzzyPrefixLengthValue { get; set; }
private bool? FuzzyTranspositionsValue { get; set; }
Expand Down Expand Up @@ -322,6 +338,12 @@ public SimpleQueryStringQueryDescriptor Fields(Fields? fields)
return Self;
}

public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlags? flags)
{
FlagsValue = flags;
return Self;
}

public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions)
{
FuzzyMaxExpansionsValue = fuzzyMaxExpansions;
Expand Down Expand Up @@ -409,6 +431,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
JsonSerializer.Serialize(writer, FieldsValue, options);
}

if (FlagsValue is not null)
{
writer.WritePropertyName("flags");
JsonSerializer.Serialize(writer, FlagsValue, options);
}

if (FuzzyMaxExpansionsValue.HasValue)
{
writer.WritePropertyName("fuzzy_max_expansions");
Expand Down