Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

---

Unreleased

3.5.0 - 2025-10-01

3.5.0 - 2025-03-26

Added

• Boxlang runtime certification

Removed

• ensureNativeStruct and newHashMap removed from models.util.Util
• Removed custom routine for async logging as it conflicted with the logger implementation

3.5.0 - 2024-12-13

Added

• Add support for wildcard mapping fields

Changed

• Bump hyper version to v8.0.0

3.4.2 - 2024-11-10

Added

• Add onLogstashEntryCreate interception point, to allow influencing and additions to final log object
• Add mode argument to client saveAll method to allow for a create mode to be used for data streams

3.4.1 - 2024-09-26

Added

• Add optional field argument to getMappings client method, which allows for wildcard search and filtering of mappings ( e.g. (GET) /logs-coldobx-*/_mapping/*application )

3.4.0 - 2024-09-26

Added

• Add component path analyzer to message and extra info fields so that parts of component paths are searchable
• Add labels property to Logstash Appender properties to allow for custom labels
• Add labels convention to Logstash Appender UserInfo UDF to allow keyword label filtering
• Add AppenderService object which allows for easier creation of detached appenders and index-specific logging
• Improved error handling to include the status code in the error message if a "reason" could not be extracted from the response: Elasticsearch server responded with [504 Gateway Timeout]. The response received was not JSON..

Fixed

• Ensure data stream existence check returns data stream records

[3.3.0] - 04-18-2024

Added

• Added addRuntimeMapping() method for mapping runtime fields at search time

Fixed

• Improved error handling for rare cases where ElasticSearch exceptions are missing a reason key.

[3.2.5] - 11-26-2023

Added

• Added asyncTimeout setting with default of 5000ms

Fixed

• Fixed rollover size not being applied correctly on the ILM policy

[3.2.4] - 11-21-2023

Fixed

• Added workaround for async manager usage in Linux environments
• Fixed Logstash appender error fallback Logbox reference

[3.2.3] - 11-19-2023

Changed

• Additional mapping enhancments for searchability
• Set default document bulk create to refresh only when requested
• Change explicit mapping of root message field to text to ensure search scoring ability

Added

• Added async property to LogstashAppender
• Added indexTemplatePriority property to logstash appender to prevent conflicts with multiple log streams sharing the same stream pattern

[3.2.2] - 07-27-2023

Fixed

• Corrected incorrect timestamps on LogstashAppender logs

[3.2.1] - 06-20-2023

Fixed

• Corrected a typing error when performing error handling in deleteById()

[3.2.0] - 06-08-2023

Added

• Added getTermVectors to SearchBuilder and Client to allow for fetching term vectors on document field(s)

[3.1.2] - 05-09-2023

Fixed

• Added additional error handling and failover to Logstash appender to prevent ES communication from failing to bring an application online

[3.1.1] - 04-28-2023

Fixed

• Added deprecated getters for startRows/maxRows properties due to compat issues with existing apps

[3.1.0] - 04-24-2023

Added

• Added support for scripted and runtime fields
• Added getTermsEnum to client to allow for fetching autocompletion terms and picklists
• Added generic set method to SearchBuilder to allow for ad-hoc body parameters

Fixed

• Fixed an issue with filterRange method to allow compatibility when used with filterTerms and filterTerm

Changed

• Renamed startRows/maxRows properties in search builder to from/size to better match ES query syntax. Adds custom setStartRows and setMaxRows methods which pass through.

[3.0.3] - 04-18-2023

Fixed

• Fixed regex used to detect Lucee HTML formatted error messages

[3.0.2] - 03-28-2023

Added

• Added a convenience method in the Util to process incorrectly formatted (HTML) exception messages
• Added a refreshIndex method to the client to perform full refreshes of index data
• Added formatToPainless utility script in the Util component to remove whitespace from painless scripts
• Added getIndexStats method to client for more informational stats on indexes

[3.0.1] - 03-12-2023

Fixed

• Fixed an error in LogstashAppender when attempting to migrate indices to from v2

[3.0.0] - 03-03-2023

Added

• Added Data Streams Support
• Added ILM ( Index Lifecycle Management ) Policy Suport
• Added Component and Index Template Support
• Added Snapshot Repository support
• Added create() method to Document object to support non-upsert operations
• Added support for migrating cbElasticSearch LogstashAppender indices from v2 to v3( ECS )
• Added throwOnError property to logstash appender to allow transmission errors to ES to fail quietly

Changed

• Changed Logstash Appender to use time series Data Streams instead of static indices
• Changed Logstash Appender Configuruation for data stream support and index lifecycles
• Converts Logstash Appender to use Elastic Common Schema.

Removed

• Removed Support for Elasticsearch versions < 7.x
• Removed Suppport for Alternate ES Clients
• Removed ElasticsearchAppender object as it was redundant

[2.4.0] - 2022-12-30

Removed

• Removed support for Adobe Coldfusion 2016 (EOL)

Fixed

• Issue #111 - Adds the ability to apply settings to an existing index
• Issue #106 - Adds the ability to specify case-insenstivity to wildcard searches ( default = false )
• Issue #105 - getAliases now supports multiple indexes with the same alias and returns the attributes to determine r/w capabilities

Added

• Added getSettings method to retreive settings for a server or for an index
• Added getMappings method to retreive mappings for an index

[2.3.3] - 2022-10-03

Added

• Added support for Elasticsearch v8
• Added ACF201 tests to matrix

Removed

• Removed Java v8 testing from matrix as ES8 only runs on 11+

Changed

• Added wait for refresh to cache provider put/delete to ensure concurrency support

[2.3.2] - 2022-09-28

Fixed

• Fixed an issue where documents were being sent to the rotational index without it being assured and mapped

[2.3.1] - 2022-07-11

Fixed

• Fixed incorrect return types in LogstashAppender provider methods

[2.3.0] - 2022-05-04

Added

• Added the ability to pass query params to the client get method
• Additional documentation updates and examples
• Added filterRange method to SearchBuilder
• Added the ability to pass an index name to the IndexBuilder delete method
• Added additional error handling and parsing to tasks

Fixed

• Fixes an issue with correctly passing key name to SearchBuilder sort method

[2.2.4] - 2021-12-31

Fixed

• Fixed an error with stack trace replacement in LogstashAppender.cfc

Changed

• Changed Build Process to Use Github Actions

[2.2.3] - Unreleased

Changed

• Build update experimentation version - unreleased

[2.2.2] - 2021-07-15

Added

• Added cfmigrations migration manager ( models.migrations.Manager )

[2.2.1] - 2021-07-14

Fixed

• Fixed reserved word issues which would cause errors in Lucee
• Adds null checks for intermittent errors in Document.cfc when all args were not present
• Fixes an issue with logstash appender where the exception type was not converting correctly to JSON when provided as additional info

Changed

• CI/CD Process migrated from Travis CI to Github Actions

[2.2.0] - 2021-02-18

Added

• Added patch method to client to allow for partial document updates
• Added deleteById method to client to prevent overhead of Document-based deletions when identifier and index are known
• Added the ability to pass request parameters to deletion methods
• Added a new patch method to IndexBuilder.cfc which provides a more intuitive API for partial updates to indices and settings
• Adds a new processBulkOperation method for performing bulk operations with multiple actions
• Additional error handling for non-JSON responses from Elasticsearch servers

Fixed

• Typos in documentation in docblocks

[2.1.2] - 2020-12-11

Fixed

• Issue #76 - Fixes an incorrect error response typing

[2.1.1] - 2020-12-07

Added

• Additional documentation updates
• Improve error response by passing all response errors through a single parsing method
• Add handling for root cause exceptions on shard failure ( Issue #65 )

Fixed

• Issue #72 - Fixes a bug where the node pool was not using the full length of the pool
• Issue #74 - Fixes a regression in filterTerms query DSL generation

[2.1.0] - 2020-12-03

Changed

• Modifies LogstashAppender schema to match default 7.x logstash template and adds additional schema keys and hooks for Stachebox

Added

• Adds the collapseToFields method to the search builder to support documents grouped on a specific field.

[2.0.5] - 2020-11-25

Added

• Adds the ability to specify an operator to term queries via filterTerm and filterTerms and pass multiple values to filter

[2.0.4] - 2020-11-04

Changed

• Lowers the default number of Logstash shards on index to 2, to prevent inheritance of application shard settings
• Lowers the default number of Logstash replicas to 0, to prevent maximum shard errors
• Changes the default Logstahs index rotation frequency to weekly

[2.0.3] - 2020-10-13

Fixed

• Fixes an error in the Logstash appender which could be thrown by a non-string value in the exception object type key

[2.0.2] - 2020-09-15

Added

• Adds additional data and exception information in Logstash appender messages

[2.0.1] - 2020-09-10

Added

• Adds Logstash appender and converts Elasticsearch appender to use Logstash schema for index data
• Adds a wildcard method to Search builder for wildcard searches on keyword-mapped fields

[2.0.0] - 2020-09-01

Changed

• Converts default native client to HyperClient ( native CFML implementation )
• Removes the deleteMapping method in the main client, as it is no longer supported in ES versions 6.5 and up.
• Removes support for Adobe Coldfusion 11
• Removes support for Lucee 4.x
• Moves previous native JEST Client to cbelasticsearch-jest module.
• Ends official support for 6.x versions of Elasticsearch

Added

• Adds cbElasticsearchPreSave and cbElasticsearchPostSave interceptions when saving individual or bulk documents
• Adds the ability to create, update, read, and delete Elasticsearch pipelines
• Adds the ability to configure a pipeline for document processing ( e.g. myDocument.setPipeline( 'my-pipeline' ) )
• Adds the ability to add save query parameters when saving individual documents ( e.g. myDocument.addParam( 'refresh', true ) )
• Adds the ability to pass a struct of params to bulk save operations (e.g. client.saveAll( documents, false, { "refresh" : true } ) )

[1.4.1] - 2020-02-27

Fixed

• Fixes an issue where a null value would throw an error when creating a native Java HashMap

[1.4.0] - 2020-02-22

Added

• Adds new search builder methods suggestTerm, suggestPhrase, and suggestCompletion for auto-completion and auto-suggestion queries
• Adds a throw on error argument, with a default of true, to client reindex() method when waiting for completion

Fixed

• Fixes an issue where default shard/replica settings were being overwritten when passing a complete config

[1.3.2] - 2020-02-12

Changed

• Modifies search builder methods of filterTerm and filterTerms to return the builder instance ( Issue #43 )
• Modifies Document setValue method to return instance, for method chaining ( Issue #40 )

Added

• Adds a Util component for common inbound and outbound conversions and casting

Fixed

• Fixes an error when individual documents in a bulk save contained errors ( Issue #44 )

[1.3.1] - 2019-12-13

Added

• Adds responses to task model
• Adds the ability to provide a transformation script to the client reindex method

[1.3.0] - 2019-11-28

Added

• Adds the ability to pass URL parameters to SearchBuilder-aware client methods. Adds a param( name, value ) supporting method to the SearchBuilder
• Adds a new Task object which can be refreshed and used in a loop as long-running tasks complete in the background ( e.g. while( !task.isComplete() ) )
• ( Breaking ) Changes the return type of the deleteByQuery and updateByQuery to return the full API response which may be inspected or used to follow-up on tasks
• implements a getAllTasks() method in the client, which will return an array of Task objects
• implements a getTask method in the client to retreive tasks by identifier ( e.g. - [node]:[id] ).
• implements a getIndices method in the client to retreive a map of indices with stats
• implements a getAliases method in the client to retreive a map of aliases

Fixed

• Resolves Issue #12 - slf4j missing on non-Runwar installations
• Resolves Issue #17 - implements workarounds and adds documentation on how to configure and use a connection to a secondary elasticsearch cluster

[1.2.2] - 2019-10-23

Added

• Adds fallback attempt when connection pool is unexpectedly closed upstream

[1.2.1] - 2019-09-27

Added

• Adds a soft fail to the version target check when a connection to the ES start page cannot be established

[1.2.0] - 2019-09-26

Added

• Implements compatibility for Elasticsearch v7
• Adds environment variable detection for default configuration
• Implements a new AliasBuilder object, which can be used to alias indexes
• Implements a new reindex() method in the client which allows the ability to reindex
• Implements new mustExist and mustNotExist methods to the SearchBuilder

[1.1.6] - 2019-06-21

Changed

• Reverts to previous versions of HTTP client due to instability and connection expiration issues

Added

• Adds connection cleanup prior to execution

[1.1.5] - 2019-06-20

Changed

• Updates Apache HTTP Client to v4.5.9

Added

• Adds count() methods to the SearchBuilder and Client

[1.1.4] - 2019-06-03

Changed

• Implements url encoding for identifiers, to allow for spaces and special characters in identifiers

[1.1.3] - 2019-05-11

Added

• Implements update by query API and interface

[1.1.2] - 2019-04-24

Added

• Adds compatibility when Secure JSON prefix setting is enabled

[1.1.1] - 2020-04-17

Changed

• Updates Java Dependencies, including JEST client, to latest versions

Added

• Implements search term highlighting capabilities

[1.1.0] - 2020-02-27

Changed

• Updates to term and filterTerms SearchBuilder methods to allow for more precise filtering

Added

• Adds filterTerm method which allows restriction of the search context
• Adds type and minimum_should_match parameters to multiMatch method in SearchBuilder

[1.0.0] - 2018-11-29

Changed

• Updates to SearchBuilder to alow for more complex queries with fewer syntax errors
• Refactor filterTerms to allow other should or filter clauses

Added

• Adds support for Elasticsearch v6.0+
• Adds a new MappingBuilder
• Add ability to specify _source excludes and includes in a query
• ACF Compatibility Updates

[0.3.0] - 2017-11-16

Added

• Adds readTimeout and connectionTimeout settings
• Adds defaultCredentials setting
• Adds default preflight of query to fix common assembly syntax issues

[0.2.1] - 2017-10-01

Added

• Adds filterTerms() method to allow an array of term restrictions to the result set

[0.2.0] - 2017-09-23

Added

• Adds support for terms filters in match()

Fixed

• Fixes pagination and offset handling

[0.1.0] - 2017-05-17

Added

• Initial Release