Skip to content

Releases: elastic/elasticsearch-ruby

v9.1.2

02 Sep 15:02
Compare
Choose a tag to compare
  • Fixes 2758 - msearch, bulk and other NDJSON endpoints overriding headers for content-type and accept. Pull Request.
  • Adds transform.set_upgrade_mode.
  • Updates source code documentation from latest 9.1 Elasticsearch specification.

v9.0.5

02 Sep 10:46
Compare
Choose a tag to compare
  • Fixes 2758 - msearch, bulk and other NDJSON endpoints overriding headers for content-type and accept. Pull Request.
  • Adds transform.set_upgrade_mode.

v8.19.1

28 Aug 10:06
Compare
Choose a tag to compare
  • Updated source code documentation links to Elasticsearch documentation to 8.19
  • Adds transform.set_upgrade_mode - Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade.

v8.18.1

28 Aug 10:05
Compare
Choose a tag to compare
  • Updates API code to the latest Elasticsearch 8.18 specification.
  • Adds inference.put_custom - Configure a custom inference endpoint.
  • Adds transform.set_upgrade_mode - Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade.

v9.1.1

07 Aug 10:05
Compare
Choose a tag to compare

Elasticsearch API

  • Updates source code documentation to latest 9.1 specification.
  • Adds inference.put_amazonsagemaker.

v9.1.0

29 Jul 19:50
Compare
Choose a tag to compare

Gem

Tested versions of Ruby for 9.1.0: Ruby (MRI) 3.2, 3.3, 3.4, head, JRuby 9.3, JRuby 9.4 and JRuby 10.

Elasticsearch API

API updates

  • Source code documentation and code has been updated with better formatting, updated links. It's also been updated to support common parameters and common cat parameters in APIs that support it (error_trace, filter_path, human, pretty). The API reference documentation can be generated with rake doc.
  • esql.async_query, esql.query - adds allow_partial_results boolean parameter. 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.
  • indices.get_field_mapping - removes local parameter.
  • synonyms.put_synonym, synonyms.put_synonym_rule - add refresh boolean parameter. If true, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.

New APIs

  • esql.get_query (Experimental) - Get a specific running ES|QL query information.
  • esql.list_queries (Experimental) - Get running ES|QL queries information.
  • indices.delete_data_stream_options - Removes the data stream options from a data stream.
  • indices.get_data_stream_options - Get the data stream options configuration of one or more data streams.
  • indices.get_data_stream_settings - Get setting information for one or more data streams.
  • indices.put_data_stream_options - Update the data stream options of the specified data streams.
  • indices.put_data_stream_settings - Update data stream settings.
  • indices.remove_block - Remove an index block from an index.
  • inference.put_custom - Create a custom inference endpoint.
  • inference.put_deepseek - Create a DeepSeek inference endpoint.
  • snapshot.repository_verify_integrity (Experimental) - Verify the integrity of the contents of a snapshot repository. NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.
  • streams.logs_disable - Disable the Logs Streams feature for this cluster.
  • streams.logs_enable - Enable the Logs Streams feature for this cluster.
  • streams.status - Return the current status of the streams feature for each streams type.

v9.0.4

29 Jul 15:55
Compare
Choose a tag to compare
  • Source code documentation and code has been updated to support common parameters and common cat parameters in APIs that support it (error_trace, filter_path, human, pretty). The API reference documentation can be generated with rake doc.
  • New API: inference.put_custom

v8.19.0

29 Jul 19:15
Compare
Choose a tag to compare

Client

Tested versions of Ruby for 8.19.0: Ruby (MRI) 3.1, 3.2, 3.3, 3.4. JRuby 9.3, JRuby 9.4 and JRuby 10.

API changes

  • cluster.get_component_template - Adds flat_settings boolean parameter, return settings in flat format (default: false). Adds settings_filter String parameter, filter out results, for example to filter out sensitive information.
  • cluster.put_component_template - Removes timeout parameter, adds cause String parameter, used defined reason for creation.
  • create - Adds require_alias and require_data_stream boolean parameters, to specify required type to be created.
  • eql.search - Adds ccs_minimize_roundtrips, ignore_unavailable, allow_no_indices boolean parameters and expand_wildcards String parameter.
  • esql.async_query - Adds allow_partial_results boolean parameter.
  • esql.async_query_get - Adds format String parameter (e.g. json, yaml).
  • esql.query - Adds allow_partial_results boolean parameter.
  • indices.recovery - Adds ignore_unavailable, allow_no_indices boolean parameters and expand_wildcards String parameter.
  • msearch - Adds ignore_unavailable, ignore_throttled, allow_no_indices, include_named_queries_score boolean parameters, expand_wildcards String parameter and routing, a comma-separated list of specific routing values.
  • open_point_in_time - Adds max_concurrent_shard_requests parameter, the number of concurrent shard requests per node executed concurrently when opening this point-in-time
  • reindex - Adds require_alias boolean parameter.
  • search_mvt - Adds grid_agg String parameter, aggregation used to create a grid for field.
  • snapshot.repository_analyze - Adds register_operation_count parameter, the minimum number of linearizable register operations to perform in total.

Time parameters master_timeout and timeout have been added to the following APIs:

  • index_lifecycle_management:

    • delete_lifecycle
    • get_lifecycle
    • put_lifecycle
    • start
    • stop
    • explain_lifecycle - Only master_timeout
  • ingest:

    • delete_geoip_database
    • delete_ip_location_database
    • put_geoip_database
    • put_ip_location_database

New APIs

  • indices.delete_data_stream_options - Deletes the data stream options of the selected data streams.
  • indices.get_data_stream_options - Returns the data stream options of the selected data streams.
  • indices.get_data_stream_settings - Gets a data stream's settings.
  • indices.put_data_stream_options - Updates the data stream options of the selected data streams.
  • indices.put_data_stream_settings - Updates a data stream's settings.
  • inference.put_amazonsagemaker - Configure an Amazon SageMaker inference endpoint.
  • inference.put_custom - Configure a custom inference endpoint.
  • inference.put_deepseek - Configure a DeepSeek inference endpoint.

v9.0.3

19 May 10:29
Compare
Choose a tag to compare
  • Adds ccr alias for cross_cluster_replication and slm alias for snapshot_lifecycle_management.
  • Tested for JRuby 10.0.0.
  • General updates in source code docs.

v9.0.2

07 May 10:39
Compare
Choose a tag to compare

Udpates setting 'Accept' and 'Content-Type' headers as to not duplicate or overwrite user set headers #2666.