Skip to content

[API] Updates source code docs esql, create, search #2672

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 1 commit into from
May 2, 2025
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 @@ -27,6 +27,7 @@ module Actions
# The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.
#
# @option arguments [Boolean] :allow_partial_results If +true+, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
# If +false+, the query will fail if there are any failures.To override the default behavior, you can set the +esql.query.allow_partial_results+ cluster setting to +false+. Server default: true.
# @option arguments [String] :delimiter The character to use between values within a CSV row.
# It is valid only for the CSV format.
# @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely +null+ will be removed from the +columns+ and +values+ portion of the results.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ module Actions
# @option arguments [Boolean] :drop_null_columns Should columns that are entirely +null+ be removed from the +columns+ and +values+ portion of the results?
# Defaults to +false+. If +true+ then the response will include an extra section under the name +all_columns+ which has the name of all columns.
# @option arguments [Boolean] :allow_partial_results If +true+, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
# If +false+, the query will fail if there are any failures.To override the default behavior, you can set the +esql.query.allow_partial_results+ cluster setting to +false+. Server default: true.
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body request body
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,15 @@ module Actions
# You can change the default of only waiting for the primary shards to start through the index setting +index.write.wait_for_active_shards+.
# Note that changing this setting will also affect the +wait_for_active_shards+ value on all subsequent write operations.
#
# @option arguments [String] :index Name of the index you wish to create. (*Required*)
# @option arguments [String] :index Name of the index you wish to create.
# Index names must meet the following criteria:
# - Lowercase only
# - Cannot include +\+, +/+, +*+, +?+, +"+, +<+, +>+, +|+, ++ (space character), +,+, or +#+
# - Indices prior to 7.0 could contain a colon (+:+), but that has been deprecated and will not be supported in later versions
# - Cannot start with +-+, +_+, or +++
# - Cannot be +.+ or +..+
# - Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster)
# - Names starting with +.+ are deprecated, except for hidden indices and internal indices managed by plugins (*Required*)
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
# @option arguments [Time] :timeout Period to wait for a response.
Expand Down
4 changes: 2 additions & 2 deletions elasticsearch-api/lib/elasticsearch/api/actions/search.rb
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ module Actions
# - +_local+ to, if possible, run the search on shards on the local node, or if not, select shards using the default method.
# - +_only_nodes:<node-id>,<node-id>+ to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.
# - +_prefer_nodes:<node-id>,<node-id>+ to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.
# +_shards:<shard>,<shard>+ to run the search only on the specified shards. You can combine this value with other +preference+ values. However, the +_shards+ value must come first. For example: +_shards:2,3|_local+.
# +<custom-string>+ (any string that does not start with +_+) to route searches with the same +<custom-string>+ to the same shards in the same order.
# - +_shards:<shard>,<shard>+ to run the search only on the specified shards. You can combine this value with other +preference+ values. However, the +_shards+ value must come first. For example: +_shards:2,3|_local+.
# - +<custom-string>+ (any string that does not start with +_+) to route searches with the same +<custom-string>+ to the same shards in the same order.
# @option arguments [Integer] :pre_filter_shard_size 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 (if date filters are mandatory to match but the shard bounds and the query are disjoint).
# When unspecified, the pre-filter phase is executed if any of these conditions is met:
Expand Down
2 changes: 1 addition & 1 deletion elasticsearch-api/lib/elasticsearch/api/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@
module Elasticsearch
module API
VERSION = '9.0.0'.freeze
ES_SPECIFICATION_COMMIT = '2843115df10df34cd34d22868131fdf7592e2655'.freeze
ES_SPECIFICATION_COMMIT = 'c7ee66d99d0c1d6906bdca079a868c187de23c69'.freeze
end
end