Module documentation for 0.14.0.0
Elasticsearch client and query DSL for Haskell
Search doesn't have to be hard. Let the dog do it.
"Bloodhound makes Elasticsearch almost tolerable!" - Almost-gruntled user
"ES is a nightmare but Bloodhound at least makes it tolerable." - Same user, later opinion.
As of version 0.13.0.0, Bloodhound has 2 separate module trees for ElasticSearch versions 1 and 5. Import the module that is appropriate for your use case. If you would like to add support for another major version, open a ticket expressing your intend and follow the pattern used for other versions. We weighed the idea of sharing code between versions but it just got too messy, especially considering the instability of the ElasticSearch API. We switched to a model which would allow the persons responsible for a particular protocol version to maintain that version while avoiding conflict with other versions.
See our TravisCI for a listing of ElasticSearch version we test against.
Bloodhound is stable for production use. I will strive to avoid breaking API compatibility from here on forward, but dramatic features like a type-safe, fully integrated mapping API may require breaking things in the future.
The TravisCI tests are run using Stack. You should use Stack instead of
cabal to build and test Bloodhound to avoid compatibility problems. You will also need to have an ElasticSearch instance running at
localhost:9200 in order to execute some of the tests. See the "Version compatibility" section above for a list of ElasticSearch versions that are officially validated against in TravisCI.
Steps to run the tests locally:
1. Dig through the [past releases] (https://www.elastic.co/downloads/past-releases) section of the ElasticSearch download page and install the desired ElasticSearch versions.
2. Install [Stack] (http://docs.haskellstack.org/en/stable/README.html#how-to-install)
3. In your local Bloodhound directory, run
stack setup && stack build
4. Start the desired version of ElasticSearch at
localhost:9200, which should be the default.
stack test in your local Bloodhound directory.
6. The unit tests will pass if you re-execute
stack test. If you want to start with a clean slate, stop your ElasticSearch instance, delete the
data/ folder in the ElasticSearch installation, restart ElasticSearch, and re-run
Hackage page and Haddock documentation
It's not using Bloodhound, but if you need an introduction to or overview of Elasticsearch and how to use it, you can use this screencast.
See the examples directory for example code.
- Chris Allen
- Liam Atkinson
- Christopher Guiney
- Curtis Carter
- Michael Xavier
- Bob Long
- Maximilian Tagher
- Anna Kopp
- Matvey B. Aksenov
- Jan-Philip Loos
Possible future functionality
Function Score Query
Node discovery and failover
Might require TCP support.
Support for TCP access to Elasticsearch
Pretend to be a transport client?
Bulk cluster-join merge
Might require making a lucene index on disk with the appropriate format.
Geohash cell filter
Script based sorting
Collapsing redundantly nested and/or structures
The Seminearring instance, if deeply nested can possibly produce nested structure that is redundant. Depending on how this affects ES performance, reducing this structure might be valuable.
Runtime checking for cycles in data structures
check for n > 1 occurrences in DFS:
Photo from HA! Designs: https://www.flickr.com/photos/hadesigns/
@jagare - #204 Fix bug where Location was used instad of LatLon - #207 Add instructions on how to run example code
@andrewthad - #200 Add function for deleting alias - #201 Add BulkCreateEncoding, which allows use of aeson's Encoding for faster bulk creates - #203 Add support for total fields limit
@chrissound - #196 Add missing import to example
@tmcgilchrist - #186 Fix warnings and drop redundant constraints
@23Skidoo - #183 Bump dependencies to support GHC 8.2
@bermanjosh - #182 Support for Suggesters and Template Queries
@dawei-dev - #181 Fix typo
@bitemyapp - Aeson 1.2
@shmish111 - #177 Added stats aggregation
@justinwhite - #176 Fixed typo
@WraithM - #175 Sorted version of getInitialScroll for V5 client
@michaelxavier - #174 doctests are bad - #171 Added Semigroup instances - #165 Aeson 1.1
@bermanjosh - #168 Sub-aggregation support - #167 Limit QuickCheck to 500 checks
- @michaelxavier - #162 Allow Aeson 1.1
- @bermanjosh - #159 Fix bug with tie breaker json instance for MultiMatchQuery
This release contains several new APIs, documentation fixes, and some minor type updates, and steps towards ES 2.0 support. Thanks to all of our contributors!
- #139 Make
Maybefor Windows compatibility - #138 Change the
nodePluginVersionrecord to deal with plugins which report
NAas their version.
- #155 Shed
derivedependency in test. - #154 Switch to
Simplebuild type. - #153 Loosen deps on aeson, hspec.
- #151 Add
- @michaelxavier - #150 Fix some failing QuickCheck tests. - #147 Drop dependency on deprecated doctest-prop. - #137 Add node stats API. - #128 Add nodes API. - #127 Add haddock sections to break up API. - #126 Add snapshot/restore API. - #125 Set lower bound for http-client - #123 Allow replica count of 0 in smart constructor.
- @23Skidoo - #143 Fix an example. - #142 Docs cleanup.
- @alistair - #135 Changes date formatting to have leading zeroes to bring us closer to ES 2.0 support. - #133 Fix parent child tests for ES 2.0. - #132 Parse status API from ES 2.0. - #131 Add cardinality aggregations.
- @dinnu93 - #130 Add OverloadedStrings to first example.
- @MaxGabriel - #117 Fix haddocks italicizing forward slashes.
@bitemyapp - Add http-client-0.5.0 support
Thanks to the following people, Bloodhound 0.10.0.0 is being released! This one gets a bit messy due to the Aeson 0.11 changeover, but this should be good to go now. Note that Aeson 0.11 returned to Aeson 0.9's behavior and semantics.
@MichaelXavier - #112 List indices support - #94 Implement index optimization - #91 Make
respIsTwoHunnamore semantic - More detail: This is actually the cause of a bug in real code. If you happen to be using parseEsResponse (which uses respIsTwoHunna) to parse the result of certain operations such as creating an index, those operations return a 201 and unjustly are deemed to be a failure. - Cleaned up errant Haskell tokens in README - #84 Added request auth hooks
@dzhus / @MailOnline - #85 Add updateDocument
@ReadmeCritic - #108 Update README URLs based on HTTP redirects
@MHova - #105 Add helper data types and functions for Missing Aggregations - Removed unused server versions from the tests - Updated readme to reflect actual ES versions supported and tested - Added support for parsing results of Missing Aggregations - #104 Export BucketValue - #102 Add local testing instructions to the README - #89 Support Bool and Numeric keys in TermsResults - Added Missing Aggregation support - #98 Improve EsProtocolException documentation for human error - Updated README to warn about 2.0 compatibility - Fix docs specifying an incorrect terminating condition
@bitemyapp - Merge monkey, puzzled over spurious local doctest failures
Thanks to the following people, Bloodhound 0.10.0.0 is being released! This one gets a bit messy due to the Aeson 0.10 upgrade, so you may want to wait for the dust to settle. YMMV.
@MichaelXavier - #77: Add test for error parsing - #76/#78: Support for updating (modifying) index settings - #79/#80: Index aliases - #81: Low-level scroll API support - #82: Date range aggregation
@bitemyapp - Fucked around with dependencies and broke things in order to upgrade to Aeson 0.10 - Please forgive me.
Thanks to the following people, Bloodhound 0.9.0.0 is being released!
@MichaelXavier - #75: A more explicit type for errors - #74: Add readme and changelog to extra source files
@MaxDaten - #38/#73 Provide safety by using URL-encoding
@centromere - #72 Added parent support to documentExists
Thanks to the following people, Bloodhound 0.8.0.0 is being released!
@MichaelXavier - #67: Deriving Monad(Throw|Catch|Mask) - #64: Export BH constructor - #61: Filter aggregation support - #60: Add value_count aggregation support - #58: Eliminate partiality in EsResult
@centromere - #59: Fixed bug with IndexSettings serialization - #56: Added fields support to Search - #55: Added ability to specify a parent document - #54: Fixed IndexTemplate serialization bug - #52: Added ability to manipulate templates - #51: Fixed mapping API - #50: Fixed problem with put sending POST
@bermanjosh - #63: Url query encoding bug - #53: Scan type
@sjakobi - #69: Replace Control.Monad.Error with CM.Except via mtl-compat - #70: Silence redundant import warning with base-4.8.* - #71: Use "newManager" instead of deprecated "withManager"
Added QueryFilter thanks to Bjørn Nordbø!
Support for optimistic concurrency control thanks again to @MichaelXavier!
Allow Aeson 0.9
Moved to BHMonad, thanks to @MichaelXavier! Now there's a reader of config information and IO is lifted.
SearchHits have a Monoid now, makes combining search results nicer, allows for defaulting when a search cannot be performed.
Fixed and changed TermsQuery (This caused the major bump)
Removed benchmarks from travis.yml
Added doctests, examples for Database.Bloodhound.Client. Haddocks should be much nicer.
Various fixes, reformatting
Term and date aggregation - thanks to Christopher Guiney! (@chrisguiney)
Following three thanks to Liam Atkins (@latkins)
omitNulls changed to exclude empty lists and null values
BoolQuery must/mustNot/Should changed from Maybe (Query|[Query]) to [Query] thanks to @latkins
Added vector dependency so we can check for V.null/V.empty on JSON arrays
Highlighting, thanks to @latkins! See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-highlighting.html and http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/highlighting-intro.html for more
Added 1.4.0 support and CI integration
Can generate individual bulk operations, https://github.com/bitemyapp/bloodhound/issues/17, bulk requests should be more efficient now too - Vector instead of List.
Status "ok" changed from Bool to Maybe Bool thanks to @borisyukd
Elasticsearch 1.3.x compatibility fixed with changes to geo bounding boxes - thanks to Curtis Carter! (@ccarter)
CI coverage expanded to 1.0.x -> 1.3.x
Killed off maybeJson/mField/catMaybes in favor of omitNulls
Experimenting with RecordWildcards
Merged Types and Instances module into Types to prevent possibility of orphans and cull orphan instance warnings.
Added note about current supported Elasticsearch version.
Renamed createMapping to putMapping
Fixed and rebuilt documentation
RegexpFlags changed to a sum type instead of Text, thanks to @MichaelXavier!