Skip to content

Add max_concurrent_shard_requests to open PIT API #4142

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 2 commits into from
Mar 28, 2025
Merged

Add max_concurrent_shard_requests to open PIT API #4142

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b9b67e
Add max_concurrent_shard_requests to open PIT API
pquentin Mar 27, 2025
7532901
Revert long -> int changes
pquentin Mar 28, 2025
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: 11 additions & 1 deletion output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 11 additions & 1 deletion output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 20 additions & 7 deletions output/schema/schema-serverless.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 23 additions & 10 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions output/schema/validation-errors.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@
],
"response": []
},
"open_point_in_time": {
"request": [
"Request: query parameter 'max_concurrent_shard_requests' does not exist in the json spec"
],
"response": []
},
"reindex": {
"request": [
"Request: query parameter 'require_alias' does not exist in the json spec",
Expand Down
15 changes: 8 additions & 7 deletions output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions specification/_global/msearch/MultiSearchRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

import { RequestBase } from '@_types/Base'
import { ExpandWildcards, Indices, Routing, SearchType } from '@_types/common'
import { long } from '@_types/Numeric'
import { integer, long } from '@_types/Numeric'
import { RequestItem } from './types'

/**
Expand Down Expand Up @@ -101,13 +101,14 @@ export interface Request extends RequestBase {
include_named_queries_score?: boolean
/**
* Maximum number of concurrent searches the multi search API can execute.
* Defaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`.
Copy link
Member Author

@pquentin pquentin Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't use @server_default as it expects a number

*/
max_concurrent_searches?: long
max_concurrent_searches?: integer
Copy link
Member Author

@pquentin pquentin Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also an integer: https://github.com/elastic/elasticsearch/blob/36c14bf3a56f85177f5ce60b2f839b6b35236bdc/server/src/main/java/org/elasticsearch/rest/action/search/RestMultiSearchAction.java#L115-L117

/**
* Maximum number of concurrent shard requests that each sub-search request executes per node.
* @server_default 5
*/
max_concurrent_shard_requests?: long
max_concurrent_shard_requests?: integer
Copy link
Member Author

@pquentin pquentin Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed we used long by mistake here, while it's an int: https://github.com/elastic/elasticsearch/blob/36c14bf3a56f85177f5ce60b2f839b6b35236bdc/server/src/main/java/org/elasticsearch/action/search/SearchRequest.java#L88.

/**
* Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.
*/
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/open_point_in_time/OpenPointInTimeRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import { RequestBase } from '@_types/Base'
import { ExpandWildcards, Indices, Routing } from '@_types/common'
import { integer } from '@_types/Numeric'
import { QueryContainer } from '@_types/query_dsl/abstractions'
import { Duration } from '@_types/Time'

Expand Down Expand Up @@ -111,6 +112,11 @@ export interface Request extends RequestBase {
* @server_default false
*/
allow_partial_search_results?: boolean
/**
* Maximum number of concurrent shard requests that each sub-search request executes per node.
* @server_default 5
*/
max_concurrent_shard_requests?: integer
}
body: {
/**
Expand Down
2 changes: 1 addition & 1 deletion specification/_global/search/SearchRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ export interface Request extends RequestBase {
* This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.
* @server_default 5
*/
max_concurrent_shard_requests?: long
max_concurrent_shard_requests?: integer
/**
* The nodes and shards used for the search.
* By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.
Expand Down
2 changes: 1 addition & 1 deletion specification/async_search/submit/AsyncSearchSubmitRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ export interface Request extends RequestBase {
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
max_concurrent_shard_requests?: long
max_concurrent_shard_requests?: integer
preference?: string
/** @server_default true */
request_cache?: boolean
Expand Down
6 changes: 3 additions & 3 deletions specification/fleet/msearch/MultiSearchRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import {
IndexName,
SearchType
} from '@_types/common'
import { long } from '@_types/Numeric'
import { integer, long } from '@_types/Numeric'
import { Checkpoint } from '../_types/Checkpoints'

/**
Expand Down Expand Up @@ -84,12 +84,12 @@ export interface Request extends RequestBase {
/**
* Maximum number of concurrent searches the multi search API can execute.
*/
max_concurrent_searches?: long
max_concurrent_searches?: integer
/**
* Maximum number of concurrent shard requests that each sub-search request executes per node.
* @server_default 5
*/
max_concurrent_shard_requests?: long
max_concurrent_shard_requests?: integer
/**
* Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.
*/
Expand Down
2 changes: 1 addition & 1 deletion specification/fleet/search/SearchRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ export interface Request extends RequestBase {
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
max_concurrent_shard_requests?: long
max_concurrent_shard_requests?: integer
preference?: string
pre_filter_shard_size?: long
request_cache?: boolean
Expand Down
Loading