DSL v0.1.9

DSL

• add track_total_hits option (@andreasklinger)

7.3.0

This version supports Elasticsearch server version 7.3.0.
It has the following changes:

Client

• Add note to readme about the default port value
• Add note about exception to default port rule when connecting using Elastic Cloud ID
• Cluster name is variable in cloud id

XPACK

• Support allow_no_match parameter in stop_data_frame_transform
• Add allow_no_match to get_data_frame_transform API
• Add missing headers
• Support get_builtin_privileges API
• Update tests for changed xpack paths
• test:integration task in xpack gem shouldn't do anything in favor of test:rest_api

7.2.1

This release has a single change:

• Cluster name is variable in cloud id. See the follow for issue details: #690

7.2.0

This client version supports Elasticsearch server version 7.2.0

Notable changes include the addition of the User-Agent header and support for compression with the compression: true option on a client.

Client

• Support User-Agent header client team specification
• Improve code handling headers
• Handle headers when using JRuby and Manticore
• Rename method for clarity
• Test selecting connections using multiple threads
• Synchronize access to the connections collection and mutation of @current instance variable
• Fix specs for selecting a connection
• Further fixes to specs for testing selecting connections in parallel
• Support providing a cloud id
• Allow a port to be set with a Cloud id and use default if no port is provided
• Remove unnecessary check for cloud_id when setting default port
• Add documentation for creating client with cloud_id
• Allow compression with Faraday and supported http adapters
• Put development gem dependencies in gemspec
• No reason to use ! for decompress method name
• Check for the existence of headers before checking headers
• Apply compression headers manually based on general :compression option
• Use GZIP constant
• Group tests into their transport adapters
• Support compression when using Curb adapter
• Support compression when using Manticore adapter with JRuby
• Fix Curb unit test, expecting headers to be merged and not set
• Update test descriptions for compression settings
• Add documentation of 'compression' option on client
• Improve client documentation for compression option
• Centralize header handling into one method
• Only add Accept-Encoding header if compression option is true

API

• Use rewritten test harness from XPACK for rest API tests
• Include skipped tests and further updates
• Delete all repositories and snapshots in a method
• Further updates to the rest API test runner
• Add erroneously removed constants and gems
• Updates to rest api yaml rspec tasks
• The get_source endpoint should raise an error if the resource is not found
• Rename method to clear data in tests and consolidate tasks into one method
• Update api for 7.2

DSL v0.1.8

• Swap links elasticsearch.org->elastic.co (@harry-wood)
• Add a composite aggregation (@watsonjon)
• Don't specify a type when creating mappings in tests
• Update links in elasticsearch-dsl README
• Allow Bool query and Bool filter methods to take objects as arguments
• Edit tests on bool query / filter to match context

7.1.0

7.1.0

This version of the client supports Elasticsearch server v7.1.0.

Client

• Update elasticsearch-transport README
• Use default port when host and protocol are specified but no port
• Verify that we have a response object before checking its status
• Make code more succinct for supporting host with path and no port
• Support options specified with String keys
• Update elasticsearch-transport/lib/elasticsearch/transport/client.rb
• Add tests showing IPv6 host specified when creating client

API

• Update links in elasticsearch-api README

XPACK

• Update elasticsearch-xpack README
• Minor formatting fix
• Remove puts line

6.8.0

This version of the Ruby client supports Elasticsearch v6.8.0.

6.3.1

This version fixes the "bug" that semver was broken in the last release; some API endpoints that were deprecated in version 6.x of ES were removed in gem version 6.3.0. They are added back in this version (6.3.1) and are removed again in version 7.0.0.

6.3.1

API

• Add delete_template back
• Add field_stats back
• Add get_template back
• Add indices/delete_mapping back
• Add indices/delete_warmer back
• Add indices/get_aliases back
• Add indices/get_warmer back
• Add indices/optimize back
• Add indices/put_warmer back
• Add indices/seal back
• Add indices/snapshot_index back
• Add indices/status back
• Add list_benchmarks back
• Add mpercolate back
• Add nodes/shutdown back
• Add percolate back
• Add put_template back
• Add remote/info back
• Add search_exists back
• Add suggest back
• Add mlt back

7.0.0

This release supports version 7.0 of the Elasticsearch server. There have been no notable updates since the 7.0.0.pre release. Please see the release notes for that version.

7.0.0.pre

This is a pre-release to support Elasticsearch server version 7.0.0

This version contains the following changes:

• Added elastic_ruby_console executable. It opens a console with the elasticsearch gems you have installed required.
• Added macro benchmarking framework, available when developing. Use rake -T to view all available benchmarking tasks.

Client

• Fixed failing integration test
• Updated the Manticore development dependency
• Fixed a failing Manticore unit test
• Removed "turn" and switched the tests to Minitest
• Fixed integration tests for Patron
• Allow passing request headers in perform_request
• Added integration test for passing request headers in perform_request
• Added, that request headers are printed in trace output, if set
• Fix typos in elasticsearch-transport/README.md
• Assert that connection count is at least previous count when reloaded
• Adjust test for change in default number of shards on ES 7
• Abstract logging functionality into a Loggable Module (#556)
• Convert client integration tests to rspec
• Add flexible configuration in spec helper
• Use helper methods in spec_helper
• Remove minitest client integration tests in favor of rspec test
• Convert tests to rspec and refactor client
• minor changes to the client specs
• Use pry-nav in development for JRuby
• Keep arguments variable name for now
• Skip round-robin test for now
• Mark test as pending until there is a better way to detect rotating nodes
• Remove client unit test in favor of rspec test
• Comment-out round-robin test as it occasionally passes and pending is ineffective
• Document the default host and port constant
• Add documentation to spec_helper methods
• Redacted password if host info is printed in error message
• Adds tests for not including password in logged error message
• The redacted string change will be in 6.1.1
• Add more tests for different ways to specify client host argument
• Do not duplicate connections in connection pool after rebuild (#591)
• Ensure that the spec rake task is run as part of integration tests
• Use constant to define Elasticsearch hosts and avoid yellow status when number of nodes is 1
• Update handling of publish_address in _nodes/http response
• Add another test for hostname/ipv6:port format

API

• Added the wait_for_active_shards parameter to the "Indices Open" API
• Added the "Indices Split" API
• Added the wait_for_no_initializing_shards argument to the "Cluster Health" API
• Added the "Cluster Remote Info" API
• Remove the dependency on "turn"
• Clear cluster transient settings in test setups
• Use YAML.load_documents in the REST tests runner
• Removed pinning dependency for Minitest
• Replaced the testing framework from Test::Unit to Minites and improved test output
• Added, that trace logs are printed when the TRACE environment variable is set
• Removed the "turn" dependency from generated test_helper.rb
• Update the "Delete By Query" API to support :slices
• Speed up Elasticsearch::API::Utils.__listify
• Speed up Elasticsearch::API::Utils.__pathify
• Use "String#strip" and "String.empty?" in Utils.__pathify
• Updated the inline documentation for using scripts in the "Update" API
• Updated the "Scroll" API inline example with passing the scroll ID in the body
• Marked the percolate method as deprecated and added an example for current percolator
• Fixed, that Utils.__report_unsupported_parameters and Utils.__report_unsupported_method use Kernel.warn so they can be suppressed
• Fixed the "greedy" regex in the Utils.__rescue_from_not_found method
• Fixed the incorrect create method
• Allow passing headers in perform_request
• Set application/x-ndjson content type on Bulk and Msearch requests
• Update the Reindex API to support :slices
• Fixed and improved the YAML tests runner
• Added the include_type_name parameter to APIs
• Fixed the helper for unit tests
• Removed the requirement for passing the type parameter to APIs
• Removed dead code from the YAML tests runner
• Fixed the api:code:generate Thor task
• Add copy_settings as valid param to split API
• Port api/actions tests to rspec (#543)
• Update tests to not require type
• Account for escape_utils not being available for JRuby
• Add nodes/reload_secure_settings endpoint support (#546)
• Add new params for search and msearch API
• Retrieve stashed variable if referenced in test
• Convert cat API tests to rspec
• Convert cluster API tests to rspec
• Convert indices tests to rspec
• Fix documentation of #indices.analyze
• Avoid instantiating an array of valid params for each request, each time it is called (#550)
• Add headers to custom client documentation (#527)
• Fix typos in README
• Minor update to scroll documentation example
• Convert snapshot, ingest, tasks, nodes api tests to rspec
• Update source_includes and source_excludes params names for mget
• Update source_includes and source_excludes params names for get, search, bulk, explain
• Update source_includes and source_excludes params names for get_source
• Mark _search endpoint as deprecated
• Link to 6.0 documentation explicitly for _suggest deprecation
• Update documentation for msearch
• Update documentation for scroll_id to be in body of scroll endpoint
• Remove reference to deprecated format option for _analyze endpoint
• Correct endpoints used for get and put search template
• Fix minor typo
• Note that a non-empty body argument is required for the bulk api
• Add note about empty body in yard documentation
• Support if_primary_term param on index API
• Delete test2 template in between tests in case a test is not cleanup up properly
• Support ignore_throttled option on search API
• Updates for types removal changes
• Add missing update param
• Add missing params to methods
• Support if_primary_term param for delete
• Delete an index and index template not cleaned up after in rest api tests
• Update supported params for cat API endpoints
• Update supported params for cluster API endpoints
• Update supported params for indices API endpoints
• Update supported params for ingest API endpoints
• Update supported params for nodes API endpoints
• Update supported params for snapshot API endpoints
• Update missed node API endpoints
• Update missed tasks API endpoints
• Update top-level api endpoints
• Adjust specs and code after test failures
• Fix accidental overwrite of index code
• Add missing param in cat/thread_pool
• The type argument is not required in the index method
• Delete 'nomatch' template to account for lack of test cleanup
• Ensure that the :index param is supported for cat.segments
• Ensure that the :name param is passed to the templates API

DSL

• Add inner_hits option support for has_parent query
• Add inner_hits option support for has_child query
• Add inner_hits option support for has_parent filter
• Add inner_hits option support for has_child filter
• adds query support for nested queries in filter context (#531)
• Convert aggregations/pipeline tests to rspec (#564)
• Convert aggregations tests to rspec (#566)
• Convert filters tests to rspec (#567)
• Fix bug in applying no_match_filter to indices filter
• Update test for current elasticsearch version
• Fix integration tests for join field syntax
• Update agg scripted metric test for deprecation in ES issue #29328
• Fix script in update for #29328
• minor: fix spacing
• Convert queries tests to rspec (#569)
• Add inner_hits test after cherry-picking rspec conversion
• Remove tests already converted to rspec
• spec directory structure should mirror code directory structure
• Support query_string type option
• Ensure that filters are registered when called on bool queries (#609)
• Don't specify a type when creating mappings in tests

XPACK

• Embedded the source code for the elasticsearch-xpack Rubygem
• Fixed the setup for YAML integration tests
• Added missing X-Pack APIs
• Improved the YAML integration test runner
• Updated the Rakefile for running integration tests
• Added, that password for Elasticsearch is generated
• Fixed the Watcher example
• Updated the README
• Added gitignore for the elasticsearch-xpack Rubygem
• Add ruby-prof as a development dependency
• Handle multiple roles passed to get_role_mapping
• Minor updates to xpack api methods (#586)
• Support freeze and unfreeze APIs
• Rewrite xpack rest api yaml test handler (#585)
• Updates to take into account SSL settings
• Fix mistake in testing version range so test can be skipped
• Support set_upgrade_mode machine learning API
• Support typed_keys and rest_total_hits_as_int params for rollup_search
• Improve string output for xpack rest api tests
• Fix logic in version checking
• Support if_seq_no and if_primary_term in put_watch
• Don't test execute_watch/60_http_input because of possible Docker issue
• Support api key methods
• Fix minor typo in test description
• Fix issue with replacing argument value with an Integer value
• Support transform_and_set in yaml tests
• Skip two more tests
• Run security tests against elasticsearch 7.0.0-rc2
• Account for error when forecast_id is not provided and legacy path is used
• Blacklist specific tests, not the whole file
• Fix version check for skipping test