Skip to content

Add default values for EQL allow_partial_search_results and allow_partial_sequence_results #3637

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.

Sign up for GitHub

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 1 commit into from
Jan 29, 2025
Merged

Add default values for EQL allow_partial_search_results and allow_partial_sequence_results #3637

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions specification/eql/search/EqlSearchRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,19 @@ export interface Request extends RequestBase {
keep_alive?: Duration
keep_on_completion?: boolean
wait_for_completion_timeout?: Duration
/**
* Allow query execution also in case of shard failures.
* If true, the query will keep running and will return results based on the available shards.
* For sequences, the behavior can be further refined using allow_partial_sequence_results
* @server_default true
*/
allow_partial_search_results?: boolean
/**
* This flag applies only to sequences and has effect only if allow_partial_search_results=true.
* If true, the sequence query will return results based on the available shards, ignoring the others.
* If false, the sequence query will return successfully, but will always have empty results.
* @server_default false
*/
allow_partial_sequence_results?: boolean
/**
* For basic queries, the maximum number of matching events to return. Defaults to 10
Expand Down
Loading