FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...

Elasticsearch for the Coldbox Framework

v1.3.1+191 Public

Elasticsearch for the Coldbox Platform

LICENSE

Apache License, Version 2.0.

Installation

Via CommandBox: install cbelasticsearch

Instructions

The elasticsearch module for the Coldbox Platform provides you with a fluent search interface for Elasticsearch, in addition to a CacheBox Cache provider and a Logbox Appender. Both the cache provider and logbox appender rely on Wirebox DSL mappings to the Elasticsearch client. As such additional Wirebox configuration is necessary to use them outside of the Coldbox context.

Installation

Via CommandBox: install cbelasticsearch

Requirements

  • Coldbox >= v4.5
  • Elasticsearch >= v5.0 and < v7.0
  • Lucee >= v4.5 or Adobe Coldfusion >= v11

Note: Most of the REST-based methods will work on Elasticsearch versions older than v5.0. A notable exception is the multi-delete methods, which use the delete by query functionality of ES5. As such, Cachebox and Logbox functionality would be limited.

Note: Elasticsearch 7.0+ is not currently supported due to the bundled Jest client, specifically because of changes to type handling in Elasticsearch 7.0.

Documentation

Read the full documentation for the module and its capabilites at (cbelasticsearch.ortusbooks.com)[https://cbelasticsearch.ortusbooks.com]


Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com


HONOR GOES TO GOD ABOVE ALL

Because of His grace, this project exists. If you don't like this, then don't read it, its not for you.

"...but we glory in tribulations also: knowing that tribulation worketh patience; And patience, experience; and experience, hope: And hope maketh not ashamed; because the love of God is shed abroad in our hearts by the Holy Ghost which is given unto us. ." Romans 5:5

THE DAILY BREAD

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12

CHANGELOG

1.3.2

  • ( Snapshot documentation )

1.3.1

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

1.3.0

  • 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
  • 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

  • Adds fallback attempt when connection pool is unexpectedly closed upstream

1.2.1

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

1.2.0

  • 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

  • Reverts to previous versions of HTTP client due to instability and connection expiration issues
  • Adds connection cleanup prior to execution

1.1.5

  • Updates Apache HTTP Client to v4.5.9
  • Adds count() methods to the SearchBuilder and Client

1.1.4

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

1.1.3

  • Implements update by query API and interface

1.1.2

  • Adds compatibility when Secure JSON prefix setting is enabled

1.1.1

  • Updates Java Dependencies, including JEST client, to latest versions
  • Implements search term highlighting capabilities

1.1.0

  • Updates to term and filterTerms SearchBuilder methods to allow for more precise filtering
  • 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

  • Adds support for Elasticsearch v6.0+
  • Adds a new MappingBuilder
  • Updates to SearchBuilder to alow for more complex queries with fewer syntax errors
  • Refactor filterTerms to allow other should or filter clauses
  • Add ability to specify _source excludes and includes in a query
  • ACF Compatibility Updates

0.3.0

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

0.2.1

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

0.2.0

  • Fixes pagination and offset handling
  • Adds support for terms filters in match()

0.1.0

  • Initial Release

Here are all the versions for this package. Please note that you can leverage CommandBox package versioning to install any package you like. Please refer to our managing package version guide for more information.

Version Created Last Update Published By Stable Actions
Current
1.3.2-snapshot Dec 13 2019 11:46 AM Dec 13 2019 11:46 AM
Version History
1.3.1+191 Dec 13 2019 11:26 AM Dec 13 2019 11:26 AM
1.3.1-snapshot Dec 13 2019 10:08 AM Dec 13 2019 10:08 AM
1.3.0+189 Nov 28 2019 10:50 AM Nov 28 2019 10:50 AM
1.3.0-snapshot Nov 23 2019 09:42 AM Nov 23 2019 09:42 AM
1.2.2+178 Nov 27 2019 10:34 AM Nov 27 2019 10:34 AM
1.2.2+175 Nov 27 2019 07:45 AM Nov 27 2019 07:45 AM
1.2.2+174 Nov 26 2019 03:21 PM Nov 26 2019 03:21 PM
1.2.2+173 Nov 26 2019 03:06 PM Nov 26 2019 03:06 PM
1.2.2+169 Oct 23 2019 04:41 PM Oct 23 2019 04:41 PM
1.2.2-snapshot Oct 15 2019 08:29 AM Oct 15 2019 08:29 AM
1.2.1+166 Oct 15 2019 08:13 AM Oct 15 2019 08:13 AM
1.2.0+165 Sep 26 2019 03:47 PM Sep 26 2019 03:47 PM
1.2.0-snapshot Sep 26 2019 03:32 PM Sep 26 2019 03:32 PM
1.1.6-snapshot Jun 26 2019 03:29 PM Jun 26 2019 03:29 PM
1.1.5+140 Jun 21 2019 07:22 PM Jun 21 2019 07:22 PM
1.1.5-snapshot Jun 03 2019 09:40 AM Jun 03 2019 09:40 AM
1.1.4+132 Jun 03 2019 09:27 AM Jun 03 2019 09:27 AM
1.1.4+131 Jun 03 2019 08:43 AM Jun 03 2019 08:43 AM
1.1.4-snapshot May 16 2019 06:02 AM May 16 2019 06:02 AM
1.1.3+117 May 11 2019 08:23 AM May 11 2019 08:23 AM
1.1.3-snapshot May 11 2019 08:07 AM May 11 2019 08:07 AM
1.1.2+110 Apr 24 2019 08:46 PM Apr 24 2019 08:46 PM
1.1.2-snapshot Apr 24 2019 08:30 PM Apr 24 2019 08:30 PM
1.1.1+100 Apr 17 2019 03:11 PM Apr 17 2019 03:11 PM
1.1.1-snapshot Apr 17 2019 03:14 PM Apr 17 2019 03:14 PM
1.1.0+92 Feb 27 2019 04:02 PM Mar 01 2019 03:44 PM
1.1.0-snapshot Feb 27 2019 03:57 PM Mar 01 2019 03:58 PM
1.0.0+84 Nov 29 2018 08:07 PM Nov 29 2018 08:07 PM
1.0.0-snapshot Feb 22 2019 11:17 AM Feb 22 2019 11:17 AM
0.3.0+61 Apr 27 2018 11:47 AM Apr 27 2018 11:47 AM
0.3.0+56 Dec 20 2017 06:33 AM Dec 20 2017 06:33 AM
0.3.0+53 Nov 23 2017 09:17 AM Nov 23 2017 09:17 AM
0.3.0+50 Nov 17 2017 07:07 AM Nov 17 2017 07:07 AM
0.3.0+48 Nov 16 2017 09:14 PM Nov 16 2017 09:14 PM
0.3.0-snapshot Nov 16 2017 08:53 PM Nov 29 2018 05:34 PM
0.2.1+42 Oct 01 2017 10:45 AM Oct 01 2017 10:45 AM
0.2.0+38 Sep 23 2017 09:16 AM Sep 23 2017 09:16 AM
0.2.0-snapshot Sep 23 2017 08:50 AM Sep 23 2017 08:50 AM
0.1.0+29 Aug 03 2017 12:15 PM Aug 03 2017 12:15 PM
0.1.0+27 Jun 07 2017 11:00 AM Jun 07 2017 11:00 AM
0.1.0+25 Jun 01 2017 04:47 PM Jun 01 2017 04:47 PM
0.1.0+22 Jun 01 2017 08:34 AM Jun 01 2017 08:34 AM
0.1.0+20 May 30 2017 05:24 PM May 30 2017 05:24 PM
0.1.0+17 May 22 2017 08:28 AM May 22 2017 08:28 AM
0.1.0+13 May 17 2017 02:12 PM May 17 2017 02:12 PM
0.1.0-snapshot May 15 2017 07:15 AM Aug 03 2017 12:15 PM

 

$ box install cbelasticsearch

No collaborators yet.
     
  • May 12 2017 12:16 PM
  • Dec 13 2019 11:46 AM
  • 2,930
  • 4,896
  • 2,709