-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add support for condition token filter #3523
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
using System; | ||
using System.Collections.Generic; | ||
using Newtonsoft.Json; | ||
|
||
namespace Nest | ||
{ | ||
/// <summary> | ||
/// The conditional token filter takes a predicate script and a list of subfilters, and | ||
/// only applies the subfilters to the current token if it matches the predicate. | ||
/// </summary> | ||
public interface IConditionTokenFilter : ITokenFilter | ||
{ | ||
/// <summary> | ||
/// a predicate script that determines whether or not the filters will be applied | ||
/// to the current token. Note that only inline scripts are supported | ||
/// </summary> | ||
[JsonProperty("script")] | ||
IScript Script { get; set; } | ||
|
||
/// <summary> | ||
///a chain of token filters to apply to the current token if the predicate | ||
/// matches. These can be any token filters defined elsewhere in the index mappings. | ||
/// </summary> | ||
[JsonProperty("filter")] | ||
IEnumerable<string> Filters { get; set; } | ||
} | ||
|
||
/// <inheritdoc cref="IConditionTokenFilter" /> | ||
public class ConditionTokenFilter : TokenFilterBase, IConditionTokenFilter | ||
{ | ||
public ConditionTokenFilter() : base("condition") { } | ||
|
||
/// <inheritdoc cref="IConditionTokenFilter.Script" /> | ||
public IScript Script { get; set; } | ||
|
||
/// <inheritdoc cref="IConditionTokenFilter.Filters" /> | ||
public IEnumerable<string> Filters { get; set; } | ||
} | ||
|
||
/// <inheritdoc cref="IConditionTokenFilter" /> | ||
public class ConditionTokenFilterDescriptor | ||
: TokenFilterDescriptorBase<ConditionTokenFilterDescriptor, IConditionTokenFilter>, IConditionTokenFilter | ||
{ | ||
protected override string Type => "condition"; | ||
|
||
IScript IConditionTokenFilter.Script { get; set; } | ||
IEnumerable<string> IConditionTokenFilter.Filters { get; set; } | ||
|
||
/// <inheritdoc cref="IConditionTokenFilter.Script" /> | ||
public ConditionTokenFilterDescriptor Script(Func<ScriptDescriptor, IScript> scriptSelector) => | ||
Assign(a => a.Script = scriptSelector?.Invoke(new ScriptDescriptor())); | ||
|
||
/// <inheritdoc cref="IConditionTokenFilter.Script" /> | ||
public ConditionTokenFilterDescriptor Script(string predicate) => | ||
Assign(a => a.Script = new InlineScript(predicate)); | ||
|
||
/// <inheritdoc cref="IConditionTokenFilter.Filters" /> | ||
public ConditionTokenFilterDescriptor Filters(params string[] filters) => | ||
Assign(a => a.Filters = filters); | ||
|
||
/// <inheritdoc cref="IConditionTokenFilter.Filters" /> | ||
public ConditionTokenFilterDescriptor Filters(IEnumerable<string> filters) => | ||
Assign(a => a.Filters = filters); | ||
|
||
} | ||
} |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can this be a single filter or enumerable of filters?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, this does not allow inline token filter declarations only references.
I've only seen it being documented as an array of string.