git.iko.soy/typeable/bloodhound
on c9b16f8 help sign in
f93e1ce
swap
0 ahead, 344 behind
64 files changed+6021−9915
since splitsnapshots
unifiedsplit
.gitignore−9 .hlint.yaml−66 .travis.yml+20−21 DSL.org+1−1 Makefile+16−123 README.md+837−17 bloodhound.cabal+98 changelog.md+2−194 docker-compose.yml−35 elasticsearch/Dockerfile−3 elasticsearch/config/elasticsearch.yml−3 examples/LICENSE−12 examples/Makefile−5 examples/README.md−6 examples/Setup.hs−2 examples/Tweet.hs−108 examples/package.yaml−37 examples/stack.yaml−20 package.yaml−74 src/Bloodhound/Import.hs−85 src/Database/Bloodhound/Client.hs+124−476 src/Database/Bloodhound/Common/Script.hs−220 src/Database/Bloodhound/Internal/Aggregation.hs−479 src/Database/Bloodhound/Internal/Analysis.hs−379 src/Database/Bloodhound/Internal/Client.hs−2431 src/Database/Bloodhound/Internal/Highlight.hs−164 src/Database/Bloodhound/Internal/Newtypes.hs−237 src/Database/Bloodhound/Internal/Query.hs−1640 src/Database/Bloodhound/Internal/Sort.hs−107 src/Database/Bloodhound/Internal/StringlyTyped.hs−51 src/Database/Bloodhound/Internal/Suggest.hs−270 src/Database/Bloodhound/Types.hs+3306−232 src/Database/Bloodhound/Types/Class.hs+17 src/Database/Bloodhound/Types/Internal.hs+56 stack-7.10.yaml+15 stack-7.8.yaml+14 stack-8.0.yaml−12 stack-8.2.yaml−15 stack-8.2.yaml.lock−40 stack-8.4.yaml−15 stack-8.4.yaml.lock−12 stack-8.6.yaml−14 stack-8.6.yaml.lock−33 stack.yaml+1−1 stack.yaml.lock−12 tests/Test/Aggregation.hs−147 tests/Test/ApproxEq.hs−63 tests/Test/BulkAPI.hs−95 tests/Test/Common.hs−292 tests/Test/Documents.hs−51 tests/Test/Generators.hs−563 tests/Test/Highlights.hs−32 tests/Test/Import.hs−58 tests/Test/Indices.hs−173 tests/Test/JSON.hs−213 tests/Test/Query.hs−132 tests/Test/Script.hs−36 tests/Test/Snapshots.hs−201 tests/Test/Sorting.hs−22 tests/Test/SourceFiltering.hs−38 tests/Test/Suggest.hs−23 tests/Test/Templates.hs−26 tests/doctests.hs+4 tests/tests.hs+1510−89
.gitignore−9
@@ -1,11 +1,9 @@
11cabal.sandbox.config
22.cabal-sandbox/
33dist/
4−dist-newstyle/
54.project
65.dist-buildwrapper/
76.DS_Store
8−TAGS
97*.hi
108*.o
119bloodhound-*-docs/
@@ -13,10 +11,3 @@ bloodhound-*-docs.tar.gz
1311bloodhound.iml
1412.idea/
1513.stack-work/
16−.hg/00changelog.i
17−.hg
18−.hgignore
19−examples/bloodhound-examples.cabal
20−/.ghc.environment.*
21−.hspec-failures
22−bloodhound.cabal
.hlint.yamldeleted−66
@@ -1,66 +0,0 @@
1−# HLint configuration file
2−# https://github.com/ndmitchell/hlint
3−##########################
4−
5−# This file contains a template configuration file, which is typically
6−# placed as .hlint.yaml in the root of your project
7−
8−
9−# Specify additional command line arguments
10−#
11−# - arguments: [--color, --cpp-simple, -XQuasiQuotes]
12−
13−
14−# Control which extensions/flags/modules/functions can be used
15−#
16−# - extensions:
17−# - default: false # all extension are banned by default
18−# - name: [PatternGuards, ViewPatterns] # only these listed extensions can be used
19−# - {name: CPP, within: CrossPlatform} # CPP can only be used in a given module
20−#
21−# - flags:
22−# - {name: -w, within: []} # -w is allowed nowhere
23−#
24−# - modules:
25−# - {name: [Data.Set, Data.HashSet], as: Set} # if you import Data.Set qualified, it must be as 'Set'
26−# - {name: Control.Arrow, within: []} # Certain modules are banned entirely
27−#
28−# - functions:
29−# - {name: unsafePerformIO, within: []} # unsafePerformIO can only appear in no modules
30−
31−
32−# Add custom hints for this project
33−#
34−# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"
35−# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}
36−
37−
38−# Turn on hints that are off by default
39−#
40−# Ban "module X(module X) where", to require a real export list
41−# - warn: {name: Use explicit module export list}
42−#
43−# Replace a $ b $ c with a . b $ c
44−# - group: {name: dollar, enabled: true}
45−#
46−# Generalise map to fmap, ++ to <>
47−# - group: {name: generalise, enabled: true}
48−
49−
50−# Ignore some builtin hints
51−- ignore: {name: "Use <$>"}
52−- ignore: {name: "Use lambda-case"}
53−# When we don't use camelCase it's to match ES.
54−# Possibly this is a mistake.
55−- ignore: {name: "Use camelCase"}
56−- ignore: {name: "Eta reduce"}
57−# - ignore: {name: Use let}
58−# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules
59−
60−
61−# Define some custom infix operators
62−# - fixity: infixr 3 ~^#^~
63−
64−
65−# To generate a suitable file for HLint do:
66−# $ hlint --default > .hlint.yaml
.travis.yml+20−21
@@ -1,43 +1,42 @@
11sudo: false
2−language: generic
3−
4−jdk:
5− - oraclejdk11
62
73addons:
84 apt:
95 packages:
106 - libgmp-dev
7+ - openjdk-6-jre
118
129env:
13− matrix:
14− - GHCVER=8.6 ESVER=5.6.0 STACK_YAML=stack.yaml DLINK=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch ES_JAVA_OPTS="-Xms500m -Xmx750m"
10+ # - GHCVER=7.6.3 ESVER=1.6.0 # Deprecated
11+ # - GHCVER=7.8.3 ESVER=1.0.3 # Deprecated
12+ # - GHCVER=7.8.3 ESVER=1.1.2 # Deprecated
13+ - GHCVER=7.8 ESVER=1.2.4
14+ - GHCVER=7.8 ESVER=1.3.6
15+ - GHCVER=7.8 ESVER=1.4.1
16+ - GHCVER=7.10 ESVER=1.5.2
17+ - GHCVER=7.10 ESVER=1.6.0
18+ - GHCVER=7.10 ESVER=1.7.2
1519
1620install:
1721 # stack
22+ - export STACK_YAML=stack-$GHCVER.yaml
1823 - mkdir -p ~/.local/bin
19− - travis_retry curl -L https://github.com/commercialhaskell/stack/releases/download/v2.1.3/stack-2.1.3-linux-x86_64.tar.gz | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
24+ - travis_retry curl -L https://github.com/commercialhaskell/stack/releases/download/v0.1.4.0/stack-0.1.4.0-x86_64-linux.tar.gz | tar -xvzf -
25+ - mv stack ~/.local/bin
2026 - export PATH=~/.local/bin:$PATH
21− - stack --no-terminal --version
27+ - stack --version
28+
2229 # elasticsearch
23− - wget --no-check-certificate $DLINK-$ESVER.tar.gz
30+ - wget --no-check-certificate https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-$ESVER.tar.gz
2431 - tar xzf elasticsearch-$ESVER.tar.gz
25− # set up a repo for snapshot testing. Required in ES >= 1.6
26− - echo "path.repo = [\"/tmp\"]" >> ./elasticsearch-$ESVER/elasticsearch.yml
2732 - ./elasticsearch-$ESVER/bin/elasticsearch &
2833
2934script:
30− - stack setup --no-terminal
31− - stack update --no-terminal
32− - stack build -j2 --fast --no-terminal
33− - travis_wait 60 sleep 1800 &
34− - stack test --fast --no-terminal bloodhound:bloodhound-tests --test-arguments="--qc-max-success 500"
35+ - stack setup
36+ - stack update
37+ - stack build
38+ - stack test
3539
3640cache:
37− timeout: 1500
3841 directories:
39− - $HOME/.cabal
40− - $HOME/.ghc
4142 - $HOME/.stack
42− - .stack-work/
43− apt: true
DSL.org+1−1
@@ -1,4 +1,4 @@
1−* Elasticsearch DSL
1+* ElasticSearch DSL
22
33** Grouping
44
Makefile+16−123
@@ -1,129 +1,22 @@
1−.PHONY : build build-validate ghci test test-rerun test-ghci ghcid ghcid-validate \
2− weeder hlint hlint-watch mod-build
1+install-with-test-support:
2+ cabal install --enable-tests
3+ echo "Make certain you have an elasticsearch instance on localhost:9200 !"
4+ cabal test
35
4−.DEFAULT_GOAL = help
6+test:
7+ echo "Make certain you have an elasticsearch instance on localhost:9200 !"
8+ cabal clean
9+ cabal test
510
6−stack = STACK_YAML='stack.yaml' stack
7−ghc_perf_options = --ghc-options '+RTS -A128M -RTS'
8−build = build $(ghc_perf_options)
9−ghci = ghci $(ghc_perf_options)
10−test = test $(ghc_perf_options)
11−stack-8.0 = STACK_YAML="stack-8.0.yaml" stack
12−stack-8.2 = STACK_YAML="stack-8.2.yaml" stack
13−stack-8.4 = STACK_YAML="stack-8.4.yaml" stack
14−stack-8.6 = STACK_YAML="stack-8.6.yaml" stack
15−elasticsearch_directory = elasticsearch
16−
17−# stack build --ghc-options '+RTS -A128M -RTS'
18−
19−## run build
2011build:
21− $(stack) $(build)
22−
23−## build with validation options (Wall, Werror)
24−build-validate:
25− $(stack) build --fast --ghc-options '-Wall -Werror +RTS -A128M -RTS'
26−
27−## run ghci
28−ghci:
29− $(stack) $(ghci)
30−
31−## run tests
32−test: echo-warn
33− $(stack) $(test)
34−
35−## run tests with forced re-run via "-r"
36−test-rerun: echo-warn
37− $(stack) $(test) --test-arguments "-r"
38−
39−## run ghci with test stanza
40−test-ghci:
41− $(stack) $(ghci) bloodhound:test:bloodhound-tests
42−
43−## run ghcid
44−ghcid:
45− ghcid -c "$(stack) ghci bloodhound:lib --test --ghci-options='-fobject-code -fno-warn-unused-do-bind' --main-is bloodhound:test:bloodhound-tests"
46−
47−## run ghcid with validate options (Werror, etc.)
48−ghcid-validate:
49− ghcid -c "$(stack) ghci bloodhound:lib --test --ghci-options='-Werror -fobject-code -fno-warn-unused-do-bind' --main-is bloodhound:test:bloodhound-tests"
50−
51−## run weeder
52−weeder:
53− weeder . --build
54−
55−## run hlint
56−hlint:
57− hlint .
58−
59−## hlint watch with `sos`
60−hlint-watch:
61− sos src/ -c "hlint ." -p "src/(.*)\.hs"
62−
63−# mod-build:
64−# stack build --ghc-options '+RTS -A128M -RTS'
65−
66−echo-warn:
67− @echo "Make certain you have an elasticsearch instance on localhost:9200 !"
68−
69−## Test with GHC 8.0 and ES 5.x
70−test-8.0:
71− STACK_YAML="stack-8.0.yaml" stack test --fast bloodhound:test:bloodhound-tests --test-arguments="--qc-max-success 500"
72−
73−## Test with GHC 8.2 and ES 5.x
74−test-8.2:
75− STACK_YAML="stack.yaml" stack test --fast bloodhound:test:bloodhound-tests --test-arguments="--qc-max-success 500"
76−
77−## Build with the GHC 8.0 Stack YAML
78−build-8.0:
79− $(stack-8.0) $(build)
80−
81−## Build with the GHC 8.2 Stack YAML
82−build-8.2:
83− $(stack-8.2) $(build)
84−
85−## Build with the GHC 8.4 Stack YAML
86−build-8.4:
87− $(stack-8.4) $(build)
88−
89−## Build with the GHC 8.6 Stack YAML
90−build-8.6:
91− $(stack-8.6) $(build)
92−
93−## Upload the package to Hackage
94−upload:
95− stack upload --no-signature .
96−
97−# Create ES5 instance
98−
99−## Run test environment
100−compose-ES5:
101− @LOCAL_USER_ID=${LOCAL_USER_ID} docker-compose -f docker-compose.yml --project-directory $(elasticsearch_directory) up
102−
103−## Run test environment in detach mode
104−compose-ES5-detach-up:
105− @LOCAL_USER_ID=${LOCAL_USER_ID} docker-compose -f docker-compose.yml --project-directory $(elasticsearch_directory) up -d
106−
107−## Close test environment if run on detach mode
108−compose-ES5-detach-down:
109− @LOCAL_USER_ID=${LOCAL_USER_ID} docker-compose -f docker-compose.yml --project-directory $(elasticsearch_directory) down
12+ cabal build
11013
111−## build the docker compose images
112−compose-build:
113− @LOCAL_USER_ID=${LOCAL_USER_ID} docker-compose -f docker-compose.yml --project-directory $(elasticsearch_directory) build
14+test-repl:
15+ cabal repl tests
11416
115−## Spawn bash shell in ES5 test container
116−ES5-shell:
117− @LOCAL_USER_ID=${LOCAL_USER_ID} docker-compose -f docker-compose.yml --project-directory $(elasticsearch_directory) exec elasticsearch1 bash
17+repl:
18+ cabal repl
11819
119−help:
120− @echo "Please use \`make <target>' where <target> is one of\n\n"
121− @awk '/^[a-zA-Z\-\_0-9]+:/ { \
122− helpMessage = match(lastLine, /^## (.*)/); \
123− if (helpMessage) { \
124− helpCommand = substr($$1, 0, index($$1, ":")); \
125− helpMessage = substr(lastLine, RSTART + 3, RLENGTH); \
126− printf "%-30s %s\n", helpCommand, helpMessage; \
127− } \
128− } \
129− { lastLine = $$0 }' $(MAKEFILE_LIST)
20+reset:
21+ rm -rf .cabal-sandbox
22+ cabal sandbox init
README.md+837−17
@@ -21,19 +21,9 @@ Endorsements
2121Version compatibility
2222---------------------
2323
24−As of version 0.13.0.0, Bloodhound has 2 separate module trees for
25−Elasticsearch versions 1 and 5. Import the module that is appropriate
26−for your use case. If you would like to add support for another major
27−version, open a ticket expressing your intend and follow the pattern
28−used for other versions. We weighed the idea of sharing code between
29−versions but it just got too messy, especially considering the
30−instability of the Elasticsearch API. We switched to a model which
31−would allow the persons responsible for a particular protocol version
32−to maintain that version while avoiding conflict with other versions.
33−
34−See our [TravisCI](https://travis-ci.org/bitemyapp/bloodhound) for a
35−listing of Elasticsearch version we test against.
24+Elasticsearch \>=1.0 && \<2.0 is recommended. Bloodhound mostly works with 0.9.x, but I don't recommend it if you expect everything to work. As of Bloodhound 0.3 all \>=1.0 && \<2.0 versions of Elasticsearch work. Some (or even most?) features will work with versions \>=2.0, but it is not officially supported yet.
3625
26+Current versions we test against are 1.2.4, 1.3.6, 1.4.1, 1.5.2, 1.6.0, and 1.7.2. We also check that GHC 7.6 and 7.8 both build and pass tests. See our [TravisCI](https://travis-ci.org/bitemyapp/bloodhound) to learn more.
3727
3828Stability
3929---------
@@ -43,15 +33,15 @@ Bloodhound is stable for production use. I will strive to avoid breaking API com
4333Testing
4434---------
4535
46−The TravisCI tests are run using [Stack](http://docs.haskellstack.org/en/stable/README.html). 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.
36+The TravisCI tests are run using [Stack](http://docs.haskellstack.org/en/stable/README.html). 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.
4737
4838Steps to run the tests locally:
49− 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.
39+ 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.
5040 2. Install [Stack] (http://docs.haskellstack.org/en/stable/README.html#how-to-install)
5141 3. In your local Bloodhound directory, run `stack setup && stack build`
52− 4. Start the desired version of Elasticsearch at `localhost:9200`, which should be the default.
42+ 4. Start the desired version of ElasticSearch at `localhost:9200`, which should be the default.
5343 5. Run `stack test` in your local Bloodhound directory.
54− 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 `stack test`.
44+ 6. The unit tests will pass if you re-execute `stack test`, but some of the doctests might fail due to existing data in ElasticSearch. 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 `stack test`.
5545
5646
5747Hackage page and Haddock documentation
@@ -67,7 +57,837 @@ It's not using Bloodhound, but if you need an introduction to or overview of Ela
6757Examples
6858========
6959
70−See the [examples](htts://github.com/bitemyapp/bloodhound/tree/master/examples) directory for example code.
60+Index Operations
61+----------------
62+
63+### Create Index
64+
65+``` {.haskell}
66+
67+-- Formatted for use in ghci, so there are "let"s in front of the decls.
68+
69+-- if you see :{ and :}, they're so you can copy-paste
70+-- the multi-line examples into your ghci REPL.
71+
72+:set -XDeriveGeneric
73+:{
74+import Control.Applicative
75+import Database.Bloodhound
76+import Data.Aeson
77+import Data.Either (Either(..))
78+import Data.Maybe (fromJust)
79+import Data.Time.Calendar (Day(..))
80+import Data.Time.Clock (secondsToDiffTime, UTCTime(..))
81+import Data.Text (Text)
82+import GHC.Generics (Generic)
83+import Network.HTTP.Client
84+import qualified Network.HTTP.Types.Status as NHTS
85+
86+-- no trailing slashes in servers, library handles building the path.
87+let testServer = (Server "http://localhost:9200")
88+let testIndex = IndexName "twitter"
89+let testMapping = MappingName "tweet"
90+let withBH' = withBH defaultManagerSettings testServer
91+
92+-- defaultIndexSettings is exported by Database.Bloodhound as well
93+let defaultIndexSettings = IndexSettings (ShardCount 3) (ReplicaCount 2)
94+
95+-- createIndex returns MonadBH m => m Reply. You can use withBH for
96+ one-off commands or you can use runBH to group together commands
97+ and to pass in your own HTTP manager for pipelining.
98+
99+-- response :: Reply, Reply is a synonym for Network.HTTP.Conduit.Response
100+response <- withBH' $ createIndex defaultIndexSettings testIndex
101+:}
102+
103+```
104+
105+### Delete Index
106+
107+#### Code
108+
109+``` {.haskell}
110+
111+-- response :: Reply
112+response <- withBH' $ deleteIndex testIndex
113+
114+```
115+
116+#### Example Response
117+
118+``` {.haskell}
119+
120+-- print response if it was a success
121+Response {responseStatus = Status {statusCode = 200, statusMessage = "OK"}
122+ , responseVersion = HTTP/1.1
123+ , responseHeaders = [("Content-Type", "application/json; charset=UTF-8")
124+ , ("Content-Length", "21")]
125+ , responseBody = "{\"acknowledged\":true}"
126+ , responseCookieJar = CJ {expose = []}
127+ , responseClose' = ResponseClose}
128+
129+-- if the index to be deleted didn't exist anyway
130+Response {responseStatus = Status {statusCode = 404, statusMessage = "Not Found"}
131+ , responseVersion = HTTP/1.1
132+ , responseHeaders = [("Content-Type", "application/json; charset=UTF-8")
133+ , ("Content-Length","65")]
134+ , responseBody = "{\"error\":\"IndexMissingException[[twitter] missing]\",\"status\":404}"
135+ , responseCookieJar = CJ {expose = []}
136+ , responseClose' = ResponseClose}
137+
138+```
139+
140+### Refresh Index
141+
142+#### Note, you **have** to do this if you expect to read what you just wrote
143+
144+``` {.haskell}
145+
146+resp <- withBH' $ refreshIndex testIndex
147+
148+```
149+
150+#### Example Response
151+
152+``` {.haskell}
153+
154+-- print resp on success
155+Response {responseStatus = Status {statusCode = 200, statusMessage = "OK"}
156+ , responseVersion = HTTP/1.1
157+ , responseHeaders = [("Content-Type", "application/json; charset=UTF-8")
158+ , ("Content-Length","50")]
159+ , responseBody = "{\"_shards\":{\"total\":10,\"successful\":5,\"failed\":0}}"
160+ , responseCookieJar = CJ {expose = []}
161+ , responseClose' = ResponseClose}
162+
163+```
164+
165+Mapping Operations
166+------------------
167+
168+### Create Mapping
169+
170+``` {.haskell}
171+
172+-- don't forget imports and the like at the top.
173+
174+data TweetMapping = TweetMapping deriving (Eq, Show)
175+
176+-- I know writing the JSON manually sucks.
177+-- I don't have a proper data type for Mappings yet.
178+-- Let me know if this is something you need.
179+
180+:{
181+instance ToJSON TweetMapping where
182+ toJSON TweetMapping =
183+ object ["tweet" .=
184+ object ["properties" .=
185+ object ["location" .=
186+ object ["type" .= ("geo_point" :: Text)]]]]
187+:}
188+
189+resp <- withBH' $ putMapping testIndex testMapping TweetMapping
190+
191+```
192+
193+### Delete Mapping
194+
195+``` {.haskell}
196+
197+resp <- withBH' $ deleteMapping testIndex testMapping
198+
199+```
200+
201+Document Operations
202+-------------------
203+
204+### Indexing Documents
205+
206+``` {.haskell}
207+
208+-- don't forget the imports and derive generic setting for ghci
209+-- at the beginning of the examples.
210+
211+:{
212+data Location = Location { lat :: Double
213+ , lon :: Double } deriving (Eq, Generic, Show)
214+
215+data Tweet = Tweet { user :: Text
216+ , postDate :: UTCTime
217+ , message :: Text
218+ , age :: Int
219+ , location :: Location } deriving (Eq, Generic, Show)
220+
221+exampleTweet = Tweet { user = "bitemyapp"
222+ , postDate = UTCTime
223+ (ModifiedJulianDay 55000)
224+ (secondsToDiffTime 10)
225+ , message = "Use haskell!"
226+ , age = 10000
227+ , location = Location 40.12 (-71.34) }
228+
229+-- automagic (generic) derivation of instances because we're lazy.
230+instance ToJSON Tweet
231+instance FromJSON Tweet
232+instance ToJSON Location
233+instance FromJSON Location
234+:}
235+
236+-- Should be able to toJSON and encode the data structures like this:
237+-- λ> toJSON $ Location 10.0 10.0
238+-- Object fromList [("lat",Number 10.0),("lon",Number 10.0)]
239+-- λ> encode $ Location 10.0 10.0
240+-- "{\"lat\":10,\"lon\":10}"
241+
242+resp <- withBH' $ indexDocument testIndex testMapping defaultIndexDocumentSettings exampleTweet (DocId "1")
243+
244+```
245+
246+#### Example Response
247+
248+``` {.haskell}
249+
250+Response {responseStatus =
251+ Status {statusCode = 200, statusMessage = "OK"}
252+ , responseVersion = HTTP/1.1, responseHeaders =
253+ [("Content-Type","application/json; charset=UTF-8"),
254+ ("Content-Length","75")]
255+ , responseBody = "{\"_index\":\"twitter\",\"_type\":\"tweet\",\"_id\":\"1\",\"_version\":2,\"created\":false}"
256+ , responseCookieJar = CJ {expose = []}, responseClose' = ResponseClose}
257+
258+```
259+
260+### Deleting Documents
261+
262+``` {.haskell}
263+
264+resp <- withBH' $ deleteDocument testIndex testMapping (DocId "1")
265+
266+```
267+
268+### Getting Documents
269+
270+``` {.haskell}
271+
272+-- n.b., you'll need the earlier imports. responseBody is from http-conduit
273+
274+resp <- withBH' $ getDocument testIndex testMapping (DocId "1")
275+
276+-- responseBody :: Response body -> body
277+let body = responseBody resp
278+
279+-- you have two options, you use decode and just get Maybe (EsResult Tweet)
280+-- or you can use eitherDecode and get Either String (EsResult Tweet)
281+
282+let maybeResult = decode body :: Maybe (EsResult Tweet)
283+-- the explicit typing is so Aeson knows how to parse the JSON.
284+
285+-- use either if you want to know why something failed to parse.
286+-- (string errors, sadly)
287+let eitherResult = eitherDecode body :: Either String (EsResult Tweet)
288+
289+-- print eitherResult should look like:
290+Right (EsResult {_index = "twitter"
291+ , _type = "tweet"
292+ , _id = "1"
293+ , foundResult = Just (EsResultFound { _version = 2
294+ , _source = Tweet {user = "bitemyapp"
295+ , postDate = 2009-06-18 00:00:10 UTC
296+ , message = "Use haskell!"
297+ , age = 10000
298+ , location = Location {lat = 40.12, lon = -71.34}}})})
299+
300+-- _source in EsResultFound is parametric, we dispatch the type by passing in what we expect (Tweet) as a parameter to EsResult.
301+
302+-- use the _source record accessor to get at your document
303+fmap (fmap _source . foundResult) eitherResult
304+Right (Just (Tweet {user = "bitemyapp"
305+ , postDate = 2009-06-18 00:00:10 UTC
306+ , message = "Use haskell!"
307+ , age = 10000
308+ , location = Location {lat = 40.12, lon = -71.34}}))
309+
310+```
311+
312+Bulk Operations
313+---------------
314+
315+### Bulk create, index
316+
317+``` {.haskell}
318+
319+-- don't forget the imports and derive generic setting for ghci
320+-- at the beginning of the examples.
321+
322+:{
323+-- Using the earlier Tweet datatype and exampleTweet data
324+
325+-- just changing up the data a bit.
326+let bulkTest = exampleTweet { user = "blah" }
327+let bulkTestTwo = exampleTweet { message = "woohoo!" }
328+
329+-- create only bulk operation
330+-- BulkCreate :: IndexName -> MappingName -> DocId -> Value -> BulkOperation
331+let firstOp = BulkCreate testIndex
332+ testMapping (DocId "3") (toJSON bulkTest)
333+
334+-- index operation "create or update"
335+let sndOp = BulkIndex testIndex
336+ testMapping (DocId "4") (toJSON bulkTestTwo)
337+
338+-- Some explanation, the final "Value" type that BulkIndex,
339+-- BulkCreate, and BulkUpdate accept is the actual document
340+-- data that your operation applies to. BulkDelete doesn't
341+-- take a value because it's just deleting whatever DocId
342+-- you pass.
343+
344+-- list of bulk operations
345+let stream = [firstDoc, secondDoc]
346+
347+-- Fire off the actual bulk request
348+-- bulk :: Vector BulkOperation -> IO Reply
349+resp <- withBH' $ bulk stream
350+:}
351+
352+```
353+
354+### Encoding individual bulk API operations
355+
356+``` {.haskell}
357+-- the following functions are exported in Bloodhound so
358+-- you can build up bulk operations yourself
359+encodeBulkOperations :: V.Vector BulkOperation -> L.ByteString
360+encodeBulkOperation :: BulkOperation -> L.ByteString
361+
362+-- How to use the above:
363+data BulkTest = BulkTest { name :: Text } deriving (Eq, Generic, Show)
364+instance FromJSON BulkTest
365+instance ToJSON BulkTest
366+
367+_ <- insertData
368+let firstTest = BulkTest "blah"
369+let secondTest = BulkTest "bloo"
370+let firstDoc = BulkIndex testIndex
371+ testMapping (DocId "2") (toJSON firstTest)
372+let secondDoc = BulkCreate testIndex
373+ testMapping (DocId "3") (toJSON secondTest)
374+let stream = V.fromList [firstDoc, secondDoc] :: V.Vector BulkOperation
375+
376+-- to encode yourself
377+let firstDocEncoded = encode firstDoc :: L.ByteString
378+
379+-- to encode a vector of bulk operations
380+let encodedOperations = encodeBulkOperations stream
381+
382+-- to insert into a particular server
383+-- bulk :: V.Vector BulkOperation -> IO Reply
384+_ <- withBH' $ bulk streamp
385+
386+```
387+
388+Search
389+------
390+
391+### Querying
392+
393+#### Term Query
394+
395+``` {.haskell}
396+
397+-- exported by the Client module, just defaults some stuff.
398+-- mkSearch :: Maybe Query -> Maybe Filter -> Search
399+-- mkSearch query filter = Search query filter Nothing False (From 0) (Size 10) Nothing
400+
401+let query = TermQuery (Term "user" "bitemyapp") Nothing
402+
403+-- AND'ing identity filter with itself and then tacking it onto a query
404+-- search should be a null-operation. I include it for the sake of example.
405+-- <||> (or/plus) should make it into a search that returns everything.
406+
407+let filter = IdentityFilter <&&> IdentityFilter
408+
409+-- constructing the search object the searchByIndex function dispatches on.
410+let search = mkSearch (Just query) (Just filter)
411+
412+-- you can also searchByType and specify the mapping name.
413+reply <- withBH' $ searchByIndex testIndex search
414+
415+let result = eitherDecode (responseBody reply) :: Either String (SearchResult Tweet)
416+
417+λ> fmap (hits . searchHits) result
418+Right [Hit {hitIndex = IndexName "twitter"
419+ , hitType = MappingName "tweet"
420+ , hitDocId = DocId "1"
421+ , hitScore = 0.30685282
422+ , hitSource = Tweet {user = "bitemyapp"
423+ , postDate = 2009-06-18 00:00:10 UTC
424+ , message = "Use haskell!"
425+ , age = 10000
426+ , location = Location {lat = 40.12, lon = -71.34}}}]
427+
428+```
429+
430+#### Match Query
431+
432+``` {.haskell}
433+
434+let query = QueryMatchQuery $ mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
435+let search = mkSearch (Just query) Nothing
436+
437+```
438+
439+#### Multi-Match Query
440+
441+``` {.haskell}
442+
443+let fields = [FieldName "user", FieldName "message"]
444+let query = QueryMultiMatchQuery $ mkMultiMatchQuery fields (QueryString "bitemyapp")
445+let search = mkSearch (Just query) Nothing
446+
447+```
448+
449+#### Bool Query
450+
451+``` {.haskell}
452+
453+let innerQuery = QueryMatchQuery $
454+ mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
455+let query = QueryBoolQuery $
456+ mkBoolQuery [innerQuery] [] []
457+let search = mkSearch (Just query) Nothing
458+
459+```
460+
461+#### Boosting Query
462+
463+``` {.haskell}
464+
465+let posQuery = QueryMatchQuery $
466+ mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
467+let negQuery = QueryMatchQuery $
468+ mkMatchQuery (FieldName "user") (QueryString "notmyapp")
469+let query = QueryBoostingQuery $
470+ BoostingQuery posQuery negQuery (Boost 0.2)
471+
472+```
473+
474+#### Rest of the query/filter types
475+
476+Just follow the pattern you've seen here and check the Hackage API documentation.
477+
478+### Sorting
479+
480+``` {.haskell}
481+
482+let sortSpec = DefaultSortSpec $ mkSort (FieldName "age") Ascending
483+
484+-- mkSort is a shortcut function that takes a FieldName and a SortOrder
485+-- to generate a vanilla DefaultSort.
486+-- checkt the DefaultSort type for the full list of customizable options.
487+
488+-- From and size are integers for pagination.
489+
490+-- When sorting on a field, scores are not computed. By setting TrackSortScores to true, scores will still be computed and tracked.
491+
492+-- type Sort = [SortSpec]
493+-- type TrackSortScores = Bool
494+-- type From = Int
495+-- type Size = Int
496+
497+-- Search takes Maybe Query
498+-- -> Maybe Filter
499+-- -> Maybe Sort
500+-- -> TrackSortScores
501+-- -> From -> Size
502+-- -> Maybe [FieldName]
503+
504+-- just add more sortspecs to the list if you want tie-breakers.
505+let search = Search Nothing (Just IdentityFilter) (Just [sortSpec]) False (From 0) (Size 10) Nothing
506+
507+```
508+
509+### Field selection
510+
511+If you only want certain fields from the source document returned, you can
512+set the "fields" field of the Search record.
513+
514+``` {.haskell}
515+
516+let search' = mkSearch (Just (MatchAllQuery Nothing)) Nothing
517+ search = search' { fields = Just [FieldName "updated"] }
518+
519+```
520+
521+### Filtering
522+
523+#### And, Not, and Or filters
524+
525+Filters form a monoid and seminearring.
526+
527+``` {.haskell}
528+
529+instance Monoid Filter where
530+ mempty = IdentityFilter
531+ mappend a b = AndFilter [a, b] defaultCache
532+
533+instance Seminearring Filter where
534+ a <||> b = OrFilter [a, b] defaultCache
535+
536+-- AndFilter and OrFilter take [Filter] as an argument.
537+
538+-- This will return anything, because IdentityFilter returns everything
539+OrFilter [IdentityFilter, someOtherFilter] False
540+
541+-- This will return exactly what someOtherFilter returns
542+AndFilter [IdentityFilter, someOtherFilter] False
543+
544+-- Thanks to the seminearring and monoid, the above can be expressed as:
545+
546+-- "and"
547+IdentityFilter <&&> someOtherFilter
548+
549+-- "or"
550+IdentityFilter <||> someOtherFilter
551+
552+-- Also there is a NotFilter, it only accepts a single filter, not a list.
553+
554+NotFilter someOtherFilter False
555+
556+```
557+
558+#### Identity Filter
559+
560+``` {.haskell}
561+
562+-- And'ing two Identity
563+let queryFilter = IdentityFilter <&&> IdentityFilter
564+
565+let search = mkSearch Nothing (Just queryFilter)
566+
567+reply <- withBH' $ searchByType testIndex testMapping search
568+
569+```
570+
571+#### Boolean Filter
572+
573+Similar to boolean queries.
574+
575+``` {.haskell}
576+
577+-- Will return only items whose "user" field contains the term "bitemyapp"
578+let queryFilter = BoolFilter (MustMatch (Term "user" "bitemyapp") False)
579+
580+-- Will return only items whose "user" field does not contain the term "bitemyapp"
581+let queryFilter = BoolFilter (MustNotMatch (Term "user" "bitemyapp") False)
582+
583+-- The clause (query) should appear in the matching document.
584+-- In a boolean query with no must clauses, one or more should
585+-- clauses must match a document. The minimum number of should
586+-- clauses to match can be set using the minimum_should_match parameter.
587+let queryFilter = BoolFilter (ShouldMatch [(Term "user" "bitemyapp")] False)
588+
589+```
590+
591+#### Exists Filter
592+
593+``` {.haskell}
594+
595+-- Will filter for documents that have the field "user"
596+let existsFilter = ExistsFilter (FieldName "user")
597+
598+```
599+
600+#### Geo BoundingBox Filter
601+
602+``` {.haskell}
603+
604+-- topLeft and bottomRight
605+let box = GeoBoundingBox (LatLon 40.73 (-74.1)) (LatLon 40.10 (-71.12))
606+
607+let constraint = GeoBoundingBoxConstraint (FieldName "tweet.location") box False GeoFilterMemory
608+
609+```
610+
611+#### Geo Distance Filter
612+
613+``` {.haskell}
614+
615+let geoPoint = GeoPoint (FieldName "tweet.location") (LatLon 40.12 (-71.34))
616+
617+-- coefficient and units
618+let distance = Distance 10.0 Miles
619+
620+-- GeoFilterType or NoOptimizeBbox
621+let optimizeBbox = OptimizeGeoFilterType GeoFilterMemory
622+
623+-- SloppyArc is the usual/default optimization in Elasticsearch today
624+-- but pre-1.0 versions will need to pick Arc or Plane.
625+
626+let geoFilter = GeoDistanceFilter geoPoint distance SloppyArc optimizeBbox False
627+
628+```
629+
630+#### Geo Distance Range Filter
631+
632+Think of a donut and you won't be far off.
633+
634+``` {.haskell}
635+
636+let geoPoint = GeoPoint (FieldName "tweet.location") (LatLon 40.12 (-71.34))
637+
638+let distanceRange = DistanceRange (Distance 0.0 Miles) (Distance 10.0 Miles)
639+
640+let geoFilter = GeoDistanceRangeFilter geoPoint distanceRange
641+
642+```
643+
644+#### Geo Polygon Filter
645+
646+``` {.haskell}
647+
648+-- I think I drew a square here.
649+let points = [LatLon 40.0 (-70.00),
650+ LatLon 40.0 (-72.00),
651+ LatLon 41.0 (-70.00),
652+ LatLon 41.0 (-72.00)]
653+
654+let geoFilter = GeoPolygonFilter (FieldName "tweet.location") points
655+
656+```
657+
658+#### Document IDs filter
659+
660+``` {.haskell}
661+
662+-- takes a mapping name and a list of DocIds
663+IdsFilter (MappingName "tweet") [DocId "1"]
664+
665+```
666+
667+#### Range Filter
668+
669+``` {.haskell}
670+
671+-- RangeFilter :: FieldName
672+-- -> RangeValue
673+-- -> RangeExecution
674+-- -> Cache -> Filter
675+
676+let filter = RangeFilter (FieldName "age")
677+ (RangeGtLt (GreaterThan 1000.0) (LessThan 100000.0))
678+ RangeExecutionIndex False
679+
680+```
681+
682+``` {.haskell}
683+
684+let filter = RangeFilter (FieldName "age")
685+ (RangeLte (LessThanEq 100000.0))
686+ RangeExecutionIndex False
687+
688+```
689+
690+##### Date Ranges
691+
692+Date ranges are expressed in UTCTime. Date ranges use the same range bound constructors as numerics, except that they end in "D".
693+
694+Note that compatibility with ES is tested only down to seconds.
695+
696+``` {.haskell}
697+
698+let filter = RangeFilter (FieldName "postDate")
699+ (RangeDateGtLte
700+ (GreaterThanD (UTCTime
701+ (ModifiedJulianDay 55000)
702+ (secondsToDiffTime 9)))
703+ (LessThanEqD (UTCTime
704+ (ModifiedJulianDay 55000)
705+ (secondsToDiffTime 11))))
706+ RangeExecutionIndex False
707+```
708+
709+#### Regexp Filter
710+
711+``` {.haskell}
712+
713+-- RegexpFilter
714+-- :: FieldName
715+-- -> Regexp
716+-- -> RegexpFlags
717+-- -> CacheName
718+-- -> Cache
719+-- -> CacheKey
720+-- -> Filter
721+let filter = RegexpFilter (FieldName "user") (Regexp "bite.*app")
722+ AllRegexpFlags (CacheName "test") False (CacheKey "key")
723+
724+-- n.b.
725+-- data RegexpFlags = AllRegexpFlags
726+-- | NoRegexpFlags
727+-- | SomeRegexpFlags (NonEmpty RegexpFlag) deriving (Eq, Show)
728+
729+-- data RegexpFlag = AnyString
730+-- | Automaton
731+-- | Complement
732+-- | Empty
733+-- | Intersection
734+-- | Interval deriving (Eq, Show)
735+
736+```
737+
738+### Aggregations
739+
740+#### Adding aggregations to search
741+
742+Aggregations can now be added to search queries, or made on their own.
743+
744+``` {.haskell}
745+type Aggregations = M.Map Text Aggregation
746+data Aggregation
747+ = TermsAgg TermsAggregation
748+ | DateHistogramAgg DateHistogramAggregation
749+```
750+
751+For convenience, \`\`\`mkAggregations\`\`\` exists, that will create an \`\`\`Aggregations\`\`\` with the aggregation provided.
752+
753+For example:
754+
755+``` {.haskell}
756+ let a = mkAggregations "users" $ TermsAgg $ mkTermsAggregation "user"
757+ let search = mkAggregateSearch Nothing a
758+```
759+
760+Aggregations can be added to an existing search, using the \`\`\`aggBody\`\`\` field
761+
762+``` {.haskell}
763+ let search = mkSearch (Just (MatchAllQuery Nothing)) Nothing
764+ let search' = search {aggBody = Just a}
765+```
766+
767+Since the \`\`\`Aggregations\`\`\` structure is just a Map Text Aggregation, M.insert can be used to add additional aggregations.
768+
769+``` {.haskell}
770+ let a' = M.insert "age" (TermsAgg $ mkTermsAggregation "age") a
771+```
772+
773+#### Extracting aggregations from results
774+
775+Aggregations are part of the reply structure of every search, in the
776+form of `Maybe AggregationResults`
777+
778+``` {.haskell}
779+-- Lift decode and response body to be in the IO monad.
780+let decode' = liftM decode
781+let responseBody' = liftM responseBody
782+let reply = withBH' $ searchByIndex testIndex search
783+let response = decode' $ responseBody' reply :: IO (Maybe (SearchResult Tweet))
784+
785+-- Now that we have our response, we can extract our terms aggregation result -- which is a list of buckets.
786+
787+let terms = do { response' <- response; return $ response' >>= aggregations >>= toTerms "users" }
788+terms
789+Just (Bucket {buckets = [TermsResult {termKey = "bitemyapp", termsDocCount = 1, termsAggs = Nothing}]})
790+```
791+
792+Note that bucket aggregation results, such as the TermsResult is a member of the type class `BucketAggregation`:
793+
794+``` {.haskell}
795+class BucketAggregation a where
796+ key :: a -> Text
797+ docCount :: a -> Int
798+ aggs :: a -> Maybe AggregationResults
799+```
800+
801+You can use the `aggs` function to get any nested results, if there
802+were any. For example, if there were a nested terms aggregation keyed
803+to "age" in a TermsResult named `termresult` , you would call `aggs
804+termresult >>= toTerms "age"`
805+
806+#### Terms Aggregation
807+
808+``` {.haskell}
809+data TermsAggregation
810+ = TermsAggregation {term :: Either Text Text,
811+ termInclude :: Maybe TermInclusion,
812+ termExclude :: Maybe TermInclusion,
813+ termOrder :: Maybe TermOrder,
814+ termMinDocCount :: Maybe Int,
815+ termSize :: Maybe Int,
816+ termShardSize :: Maybe Int,
817+ termCollectMode :: Maybe CollectionMode,
818+ termExecutionHint :: Maybe ExecutionHint,
819+ termAggs :: Maybe Aggregations}
820+```
821+
822+Term Aggregations have two factory functions, `mkTermsAggregation`, and
823+`mkTermsScriptAggregation`, and can be used as follows:
824+
825+``` {.haskell}
826+let ta = TermsAgg $ mkTermsAggregation "user"
827+```
828+
829+There are of course other options that can be added to a Terms Aggregation, such as the collection mode:
830+
831+``` {.haskell}
832+let ta = mkTermsAggregation "user"
833+let ta' = ta { termCollectMode = Just BreadthFirst }
834+let ta'' = TermsAgg ta'
835+```
836+
837+For more documentation on how the Terms Aggregation works, see <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html>
838+
839+#### Date Histogram Aggregation
840+
841+``` {.haskell}
842+data DateHistogramAggregation
843+ = DateHistogramAggregation {dateField :: FieldName,
844+ dateInterval :: Interval,
845+ dateFormat :: Maybe Text,
846+ datePreZone :: Maybe Text,
847+ datePostZone :: Maybe Text,
848+ datePreOffset :: Maybe Text,
849+ datePostOffset :: Maybe Text,
850+ dateAggs :: Maybe Aggregations}
851+```
852+
853+The Date Histogram Aggregation works much the same as the Terms Aggregation.
854+
855+Relevant functions include `mkDateHistogram`, and `toDateHistogram`
856+
857+``` {.haskell}
858+let dh = DateHistogramAgg (mkDateHistogram (FieldName "postDate") Minute)
859+```
860+
861+Date histograms also accept a `FractionalInterval`:
862+
863+``` {.haskell}
864+FractionalInterval :: Float -> TimeInterval -> Interval
865+-- TimeInterval is the following:
866+data TimeInterval = Weeks | Days | Hours | Minutes | Seconds
867+```
868+
869+It can be used as follows:
870+
871+``` {.haskell}
872+let dh = DateHistogramAgg (mkDateHistogram (FieldName "postDate") (FractionalInterval 1.5 Minutes))
873+```
874+
875+The `DateHistogramResult` is defined as:
876+
877+``` {.haskell}
878+data DateHistogramResult
879+ = DateHistogramResult {dateKey :: Int,
880+ dateKeyStr :: Maybe Text,
881+ dateDocCount :: Int,
882+ dateHistogramAggs :: Maybe AggregationResults}
883+```
884+
885+It is an instance of `BucketAggregation`, and can have nested aggregations in each bucket.
886+
887+Buckets can be extracted from an `AggregationResult` using
888+`toDateHistogram name`
889+
890+For more information on the Date Histogram Aggregation, see: <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html>
71891
72892
73893Contributors
bloodhound.cabalnew file+98
@@ -0,0 +1,98 @@
1+name: bloodhound
2+version: 0.10.0.0
3+synopsis: ElasticSearch client library for Haskell
4+description: ElasticSearch made awesome for Haskell hackers
5+homepage: https://github.com/bitemyapp/bloodhound
6+license: BSD3
7+license-file: LICENSE
8+author: Chris Allen
9+maintainer: cma@bitemyapp.com
10+copyright: 2015, Chris Allen
11+category: Database, Search
12+build-type: Custom
13+cabal-version: >=1.10
14+
15+extra-source-files:
16+ README.md
17+ changelog.md
18+
19+
20+source-repository head
21+ type: git
22+ location: https://github.com/bitemyapp/bloodhound.git
23+
24+library
25+ ghc-options: -Wall
26+ exposed-modules: Database.Bloodhound
27+ Database.Bloodhound.Client
28+ Database.Bloodhound.Types
29+ Database.Bloodhound.Types.Class
30+ Database.Bloodhound.Types.Internal
31+ hs-source-dirs: src
32+ build-depends: base >= 4.3 && <5,
33+ bytestring >= 0.10.0 && <0.11,
34+ containers >= 0.5.0.0 && <0.6,
35+ aeson >= 0.11.1 && <0.12,
36+ http-client >= 0.3 && <0.5,
37+ network-uri >= 2.6 && <2.7,
38+ semigroups >= 0.15 && <0.19,
39+ time >= 1.4 && <1.7,
40+ text >= 0.11 && <1.3,
41+ mtl >= 1.0 && <2.3,
42+ transformers >= 0.2 && <0.6,
43+ http-types >= 0.8 && <0.10,
44+ vector >= 0.10.9 && <0.12,
45+ scientific >= 0.3.0.0 && <0.4.0.0,
46+ exceptions,
47+ data-default-class,
48+ blaze-builder,
49+ unordered-containers,
50+ mtl-compat,
51+ hashable
52+ default-language: Haskell2010
53+
54+test-suite tests
55+ ghc-options: -Wall -fno-warn-orphans
56+ type: exitcode-stdio-1.0
57+ main-is: tests.hs
58+ hs-source-dirs: tests
59+ build-depends: base,
60+ bloodhound,
61+ bytestring,
62+ http-client,
63+ http-types,
64+ containers,
65+ hspec >= 1.8 && <2.3,
66+ text,
67+ time,
68+ aeson,
69+ semigroups,
70+ QuickCheck,
71+ vector,
72+ unordered-containers >= 0.2.5.0 && <0.3,
73+ mtl,
74+ quickcheck-properties,
75+ derive,
76+ errors
77+ default-language: Haskell2010
78+
79+test-suite doctests
80+ ghc-options: -threaded -Wall
81+ default-language: Haskell2010
82+ type: exitcode-stdio-1.0
83+ main-is: doctests.hs
84+ hs-source-dirs: tests, src
85+ if impl(ghc >= 7.8)
86+ build-depends: base,
87+ aeson,
88+ bloodhound,
89+ directory,
90+ doctest >= 0.10.1,
91+ doctest-prop,
92+ filepath
93+ else
94+ buildable: False
95+
96+Source-Repository head
97+ Type: git
98+ Location: git://github.com/bitemyapp/bloodhound.git
changelog.md+2−194
@@ -1,195 +1,3 @@
1−0.17.0.0
2−========
3−- @bitemyapp
4− - Removed V1 modules and support.
5− - Removed the cabal file, replaced with an Hpack `package.yaml`.
6−- @JoseD92
7− - Removed the disused `Seminearring` class.
8− - Added Docker Compose support.
9−
10−0.16.0.0
11−========
12−- @bitemyapp
13− - Reorganized V5 modules internally, ripped out Generic,
14− rewrote part of the test suite.
15− - Added message field to EsProtocolException
16− - Switch from Data.Version to Data.SemVer to support parsing broader version format.
17− - Drop support for GHC < 8.0
18− - Remove upper bound on aeson.
19−- @mxavier
20− - Reorganized V1 modules, mirroring the work done on V5.
21−- @andrewthad
22− - Added support for autogenerated elasticsearch ids in the bulk API
23− - Added support for token filters
24− - Added action for searching multiple indices
25−- @lunaris
26− - Added support for scripts fields and function score queries
27−- @bermanjosh
28− - Added support for direct generators
29−- @rvl
30− - Add [character filters][] to the `AnalyzerDefinition` type.
31− - Add the "stemmer" and "stop" [token filters][] to `TokenFilterDefinition`.
32−- @ahodgen
33− - Add support for wildcard queries
34−- @ashutoshrishi
35− - Added [fuzziness][] option to a Match Query
36− - Added support for "AUTO" Fuzziness alongside a numeric value.
37−
38−[Character Filters]: https://www.elastic.co/guide/en/elasticsearch/reference/5.6/analysis-charfilters.html
39−[Token Filters]: https://www.elastic.co/guide/en/elasticsearch/reference/5.6/analysis-tokenfilters.html
40−[Fuzziness]: https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness
41−
42−0.15.0.2
43−========
44−- @michaelxavier
45− - Allow http-types 0.12
46−
47−0.15.0.1
48−========
49−- @bitemyapp
50− - Allow http-types 0.11
51− - Removed unused `oPath` function
52−
53−0.15.0.0
54−===================
55−
56−- @jagare
57− - #204 Fix bug where Location was used instad of LatLon
58− - #207 Add instructions on how to run example code
59−
60−- @andrewthad
61− - #200 Add function for deleting alias
62− - #201 Add BulkCreateEncoding, which allows use of aeson's Encoding for faster bulk creates
63− - #203 Add support for total fields limit
64−
65−- @chrissound
66− - #196 Add missing import to example
67−
68−- @tmcgilchrist
69− - #186 Fix warnings and drop redundant constraints
70−
71−- @23Skidoo
72− - #183 Bump dependencies to support GHC 8.2
73−
74−- @bermanjosh
75− - #182 Support for Suggesters and Template Queries
76−
77−- @dawei-dev
78− - #181 Fix typo
79−
80−
81−0.14.0.0
82−===================
83−
84−- @bitemyapp
85− - Aeson 1.2
86−
87−- @shmish111
88− - #177 Added stats aggregation
89−
90−- @justinwhite
91− - #176 Fixed typo
92−
93−- @WraithM
94− - #175 Sorted version of getInitialScroll for V5 client
95−
96−0.13.0.0
97−===================
98−
99−- @michaelxavier
100− - #174 doctests are bad
101− - #171 Added Semigroup instances
102− - #165 Aeson 1.1
103−
104−- @bermanjosh
105− - #168 Sub-aggregation support
106− - #167 Limit QuickCheck to 500 checks
107−
108−0.12.1.0
109−===================
110−* @michaelxavier
111− - #162 Allow Aeson 1.1
112−* @bermanjosh
113− - #159 Fix bug with tie breaker json instance for MultiMatchQuery
114−
115−0.12.0.0
116−===================
117−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!
118−
119−* @bermanjosh
120− - #139 Make `nodeOSLoad` record a `Maybe` for Windows compatibility
121− - #138 Change the `nodePluginVersion` record to deal with plugins which report `NA` as their version.
122−* @phadej
123− - #155 Shed `derive` dependency in test.
124− - #154 Switch to `Simple` build type.
125− - #153 Loosen deps on aeson, hspec.
126−* @andrewthad
127− - #151 Add `waitForYellowIndex`
128−* @michaelxavier
129− - #150 Fix some failing QuickCheck tests.
130− - #147 Drop dependency on deprecated doctest-prop.
131− - #137 Add node stats API.
132− - #128 Add nodes API.
133− - #127 Add haddock sections to break up API.
134− - #126 Add snapshot/restore API.
135− - #125 Set lower bound for http-client
136− - #123 Allow replica count of 0 in smart constructor.
137−* @23Skidoo
138− - #143 Fix an example.
139− - #142 Docs cleanup.
140−* @alistair
141− - #135 Changes date formatting to have leading zeroes to bring us closer to ES 2.0 support.
142− - #133 Fix parent child tests for ES 2.0.
143− - #132 Parse status API from ES 2.0.
144− - #131 Add cardinality aggregations.
145−* @dinnu93
146− - #130 Add OverloadedStrings to first example.
147−* @MaxGabriel
148− - #117 Fix haddocks italicizing forward slashes.
149−
150−0.11.1.0
151−===================
152−* @bitemyapp
153− - Add http-client-0.5.0 support
154−
155−0.11.0.0
156−===================
157−
158−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.
159−
160−* @MichaelXavier
161− - #112 List indices support
162− - #94 Implement index optimization
163− - #91 Make `respIsTwoHunna` more semantic
164− - More detail: This is actually the cause of a bug in real code. If you happen to be
165− using parseEsResponse (which uses respIsTwoHunna) to parse the result of
166− certain operations such as creating an index, those operations return a
167− 201 and unjustly are deemed to be a failure.
168− - Cleaned up errant Haskell tokens in README
169− - #84 Added request auth hooks
170−
171−* @dzhus / @MailOnline
172− - #85 Add updateDocument
173−
174−* @ReadmeCritic
175− - #108 Update README URLs based on HTTP redirects
176−
177−* @MHova
178− - #105 Add helper data types and functions for Missing Aggregations
179− - Removed unused server versions from the tests
180− - Updated readme to reflect actual ES versions supported and tested
181− - Added support for parsing results of Missing Aggregations
182− - #104 Export BucketValue
183− - #102 Add local testing instructions to the README
184− - #89 Support Bool and Numeric keys in TermsResults
185− - Added Missing Aggregation support
186− - #98 Improve EsProtocolException documentation for human error
187− - Updated README to warn about 2.0 compatibility
188− - Fix docs specifying an incorrect terminating condition
189−
190−* @bitemyapp
191− - Merge monkey, puzzled over spurious local doctest failures
192−
19310.10.0.0
1942===================
1953
@@ -233,7 +41,7 @@ Thanks to the following people, Bloodhound 0.8.0.0 is being released!
23341 - #61: Filter aggregation support
23442 - #60: Add value_count aggregation support
23543 - #58: Eliminate partiality in EsResult
236−
44+
23745* @centromere
23846 - #59: Fixed bug with IndexSettings serialization
23947 - #56: Added fields support to Search
@@ -242,7 +50,7 @@ Thanks to the following people, Bloodhound 0.8.0.0 is being released!
24250 - #52: Added ability to manipulate templates
24351 - #51: Fixed mapping API
24452 - #50: Fixed problem with put sending POST
245−
53+
24654* @bermanjosh
24755 - #63: Url query encoding bug
24856 - #53: Scan type
docker-compose.ymldeleted−35
@@ -1,35 +0,0 @@
1−version: "2"
2−services:
3− elasticsearch1:
4− build: .
5− container_name: elasticsearch1
6− environment:
7− - cluster.name=docker-cluster
8− - bootstrap.memory_lock=true
9− - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
10− ulimits:
11− memlock:
12− soft: -1
13− hard: -1
14− mem_limit: 1g
15− ports:
16− - 9200:9200
17− networks:
18− - esnet
19− elasticsearch2:
20− build: .
21− environment:
22− - cluster.name=docker-cluster
23− - bootstrap.memory_lock=true
24− - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
25− - "discovery.zen.ping.unicast.hosts=elasticsearch1"
26− ulimits:
27− memlock:
28− soft: -1
29− hard: -1
30− mem_limit: 1g
31− networks:
32− - esnet
33−
34−networks:
35− esnet: {}
elasticsearch/Dockerfiledeleted−3
@@ -1,3 +0,0 @@
1−FROM docker.elastic.co/elasticsearch/elasticsearch:5.6.0
2−
3−COPY config /usr/share/elasticsearch/config/
elasticsearch/config/elasticsearch.ymldeleted−3
@@ -1,3 +0,0 @@
1−xpack.security.enabled: false
2−cluster.name: "docker-cluster"
3−network.host: 0.0.0.0
examples/LICENSEdeleted−12
@@ -1,12 +0,0 @@
1−Copyright (c) 2014, Chris Allen
2−All rights reserved.
3−
4−Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5−
6−1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7−
8−2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
9−
10−3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11−
12−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
examples/Makefiledeleted−5
@@ -1,5 +0,0 @@
1−build:
2− stack build
3−
4−ghci:
5− stack ghci
examples/README.mddeleted−6
@@ -1,6 +0,0 @@
1−# Bloodhound Examples
2−
3−These examples can be built via `stack build`.
4−To run them start an Elasticsearch 5.x server at `localhost:9200`
5−
6−Run with `stack exec tweet-example`
examples/Setup.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Distribution.Simple
2−main = defaultMain
examples/Tweet.hsdeleted−108
@@ -1,108 +0,0 @@
1−{-# LANGUAGE DeriveGeneric #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Main
4− ( main
5− ) where
6−
7−
8−import Control.Monad.IO.Class (liftIO)
9−import Data.Aeson (FromJSON (..), defaultOptions,
10− genericParseJSON, genericToJSON,
11− object, (.=))
12−import Data.List.NonEmpty (NonEmpty (..))
13−import Data.Text (Text)
14−import Data.Time.Calendar (Day (..))
15−import Data.Time.Clock (UTCTime (..), secondsToDiffTime)
16−import qualified Data.Vector as V
17−import Database.Bloodhound
18−import GHC.Generics (Generic)
19−import Network.HTTP.Client (defaultManagerSettings)
20−
21−
22−data TweetMapping = TweetMapping deriving (Eq, Show)
23−
24−instance ToJSON TweetMapping where
25− toJSON TweetMapping =
26− object
27− [ "properties" .=
28− object ["location" .= object ["type" .= ("geo_point" :: Text)]]
29− ]
30−
31−data Tweet = Tweet
32− { user :: Text
33− , postDate :: UTCTime
34− , message :: Text
35− , age :: Int
36− , location :: LatLon
37− } deriving (Eq, Generic, Show)
38−
39−
40−exampleTweet :: Tweet
41−exampleTweet =
42− Tweet
43− { user = "bitemyapp"
44− , postDate = UTCTime (ModifiedJulianDay 55000) (secondsToDiffTime 10)
45− , message = "Use haskell!"
46− , age = 10000
47− , location = loc
48− }
49− where
50− loc = LatLon {lat = 40.12, lon = -71.3}
51−
52−instance ToJSON Tweet where
53− toJSON = genericToJSON defaultOptions
54−instance FromJSON Tweet where
55− parseJSON = genericParseJSON defaultOptions
56−
57−
58−main :: IO ()
59−main = runBH' $ do
60− -- set up index
61− _ <- createIndex indexSettings testIndex
62− True <- indexExists testIndex
63− _ <- putMapping testIndex testMapping TweetMapping
64−
65− -- create a tweet
66− resp <- indexDocument testIndex testMapping defaultIndexDocumentSettings exampleTweet (DocId "1")
67− liftIO (print resp)
68− -- Response {responseStatus = Status {statusCode = 201, statusMessage = "Created"}, responseVersion = HTTP/1.1, responseHeaders = [("Content-Type","application/json; charset=UTF-8"),("Content-Length","74")], responseBody = "{\"_index\":\"twitter\",\"_type\":\"tweet\",\"_id\":\"1\",\"_version\":1,\"created\":true}", responseCookieJar = CJ {expose = []}, responseClose' = ResponseClose}
69−
70− -- bulk load
71− let stream = V.fromList [BulkIndex testIndex testMapping (DocId "2") (toJSON exampleTweet)]
72− _ <- bulk stream
73− -- Bulk loads require an index refresh before new data is loaded.
74− _ <- refreshIndex testIndex
75−
76− -- set up some aliases
77− let aliasName = IndexName "twitter-alias"
78− let iAlias = IndexAlias testIndex (IndexAliasName aliasName)
79− let aliasRouting = Nothing
80− let aliasFiltering = Nothing
81− let aliasCreate = IndexAliasCreate aliasRouting aliasFiltering
82− _ <- updateIndexAliases (AddAlias iAlias aliasCreate :| [])
83− True <- indexExists aliasName
84−
85− -- create a template so that if we just write into an index named tweet-2017-01-02, for instance, the index will be automatically created with the given mapping. This is a great idea for any ongoing indices because it makes them much easier to manage and rotate.
86− let idxTpl = IndexTemplate (TemplatePattern "tweet-*") (Just (IndexSettings (ShardCount 1) (ReplicaCount 1))) [object ["tweet" .= toJSON TweetMapping]]
87− let templateName = TemplateName "tweet-tpl"
88− _ <- putTemplate idxTpl templateName
89− True <- templateExists templateName
90−
91− -- do a search
92− let boost = Nothing
93− let query = TermQuery (Term "user" "bitemyapp") boost
94− let search = mkSearch (Just query) boost
95− _ <- searchByType testIndex testMapping search
96−
97− -- clean up
98− _ <- deleteTemplate templateName
99− _ <- deleteIndex testIndex
100− False <- indexExists testIndex
101−
102− return ()
103− where
104− testServer = Server "http://localhost:9200"
105− runBH' = withBH defaultManagerSettings testServer
106− testIndex = IndexName "twitter"
107− testMapping = MappingName "tweet"
108− indexSettings = IndexSettings (ShardCount 1) (ReplicaCount 0)
examples/package.yamldeleted−37
@@ -1,37 +0,0 @@
1−name: bloodhound-examples
2−version: '0.0.0.0'
3−category: Web
4−author: Chris Allen
5−maintainer: cma@bitemyapp.com
6−copyright: 2017, Chris Allen
7−license: BSD3
8−github: bitemyapp/bloodhound
9−extra-source-files:
10−- README.md
11−dependencies:
12−- base
13−- bloodhound
14−- time
15−- aeson
16−- text
17−- http-client
18−- vector
19−- semigroups
20−ghc-options:
21−- -Wall
22−- -threaded
23−- -rtsopts
24−- -with-rtsopts=-N
25−when:
26−- condition: flag(werror)
27− ghc-options: -Werror
28−
29−executables:
30− tweet-example:
31− main: Tweet.hs
32−
33−flags:
34− werror:
35− description: "Treat warnings as errors"
36− manual: true
37− default: false
examples/stack.yamldeleted−20
@@ -1,20 +0,0 @@
1−flags:
2− bloodhound-examples:
3− werror: false
4−
5−packages:
6−- '.'
7−- '..'
8−# extra-deps:
9−# - http-client-0.5.0
10−# - aeson-1.2.0.0
11−# - fail-4.9.0.0
12−# - http-types-0.9
13−# - attoparsec-0.13.0.1
14−# - quickcheck-properties-0.1
15−# - semigroups-0.18.3
16−# - uri-bytestring-0.1.9
17−# - temporary-resourcet-0.1.0.0
18−# - transformers-compat-0.5.1.4
19−
20−resolver: lts-8.14
package.yamldeleted−74
@@ -1,74 +0,0 @@
1−name: bloodhound
2−version: '0.17.0.0'
3−synopsis: Elasticsearch client library for Haskell
4−description: Elasticsearch made awesome for Haskell hackers
5−category: Database, Search
6−author: Chris Allen
7−maintainer: cma@bitemyapp.com
8−copyright: 2018 Chris Allen
9−license: BSD3
10−github: bitemyapp/bloodhound.git
11−
12−extra-source-files:
13− - README.md
14− - changelog.md
15− - tests/tests.hs
16−
17−dependencies:
18− - aeson >=0.11.1
19− - base >=4.3 && <5
20− - blaze-builder
21− - bytestring >=0.10.0
22− - containers >=0.5.0.0
23− - exceptions
24− - hashable
25− - http-client >=0.4.30
26− - http-types >=0.8
27− - mtl >=1.0
28− - network-uri >=2.6
29− - scientific >=0.3.0.0
30− - semigroups >=0.15
31− - semver
32− - text >=0.11
33− - time >=1.4
34− - transformers >=0.2
35− - unordered-containers
36− - vector >=0.10.9
37−
38−library:
39− source-dirs: src
40− ghc-options: -Wall
41− exposed-modules:
42− - Database.Bloodhound
43− - Database.Bloodhound.Client
44− - Database.Bloodhound.Types
45− - Database.Bloodhound.Internal.Aggregation
46− - Database.Bloodhound.Internal.Analysis
47− - Database.Bloodhound.Internal.Client
48− - Database.Bloodhound.Internal.Highlight
49− - Database.Bloodhound.Internal.Newtypes
50− - Database.Bloodhound.Internal.Query
51− - Database.Bloodhound.Internal.Sort
52− - Database.Bloodhound.Internal.StringlyTyped
53− - Database.Bloodhound.Internal.Suggest
54−
55−tests:
56− bloodhound-tests:
57− source-dirs: tests
58− main: tests.hs
59− ghc-options:
60− - -Wall
61− - -fno-warn-orphans
62− dependencies:
63− - QuickCheck
64− - base
65− - bloodhound
66− - errors
67− - hspec >=1.8
68− - microlens
69− - microlens-aeson
70− - pretty-simple
71− - quickcheck-arbitrary-template
72− - quickcheck-properties
73− - temporary
74− - unix-compat
src/Bloodhound/Import.hsdeleted−85
@@ -1,85 +0,0 @@
1−module Bloodhound.Import
2− ( module X
3− , LByteString
4− , Method
5− , omitNulls
6− , parseNEJSON
7− , parseReadText
8− , readMay
9− , showText
10− , deleteSeveral
11− , oPath
12− , tshow
13− ) where
14−
15−import Control.Applicative as X (Alternative (..), optional)
16−import Control.Exception as X (Exception)
17−import Control.Monad as X (MonadPlus (..), forM, (<=<))
18−import Control.Monad.Catch as X (MonadCatch, MonadMask,
19− MonadThrow)
20−import Control.Monad.Except as X (MonadError)
21−import Control.Monad.Fix as X (MonadFix)
22−import Control.Monad.IO.Class as X (MonadIO (..))
23−import Control.Monad.Reader as X (MonadReader (..),
24− MonadTrans (..), ReaderT (..))
25−import Control.Monad.State as X (MonadState)
26−import Control.Monad.Writer as X (MonadWriter)
27−import Data.Aeson as X
28−import Data.Aeson.Types as X (Pair, Parser, emptyObject,
29− parseEither, parseMaybe,
30− typeMismatch)
31−import Data.Bifunctor as X (first)
32−import Data.Char as X (isNumber)
33−import Data.Hashable as X (Hashable)
34−import qualified Data.HashMap.Strict as HM
35−import Data.List as X (foldl', intercalate, nub)
36−import Data.List.NonEmpty as X (NonEmpty (..), toList)
37−import Data.Maybe as X (catMaybes, fromMaybe,
38− isNothing, maybeToList)
39−import Data.Scientific as X (Scientific)
40−import Data.Semigroup as X (Semigroup (..))
41−import Data.Text as X (Text)
42−import Data.Time.Calendar as X (Day (..), showGregorian)
43−import Data.Time.Clock as X (NominalDiffTime, UTCTime)
44−import Data.Time.Clock.POSIX as X
45−
46−import qualified Data.ByteString.Lazy as BL
47−import qualified Data.Text as T
48−import qualified Data.Traversable as DT
49−import qualified Data.Vector as V
50−import qualified Network.HTTP.Types.Method as NHTM
51−
52−type LByteString = BL.ByteString
53−
54−type Method = NHTM.Method
55−
56−readMay :: Read a => String -> Maybe a
57−readMay s = case reads s of
58− (a, ""):_ -> Just a
59− _ -> Nothing
60−
61−parseReadText :: Read a => Text -> Parser a
62−parseReadText = maybe mzero return . readMay . T.unpack
63−
64−showText :: Show a => a -> Text
65−showText = T.pack . show
66−
67−omitNulls :: [(Text, Value)] -> Value
68−omitNulls = object . filter notNull where
69− notNull (_, Null) = False
70− notNull (_, Array a) = (not . V.null) a
71− notNull _ = True
72−
73−parseNEJSON :: (FromJSON a) => [Value] -> Parser (NonEmpty a)
74−parseNEJSON [] = fail "Expected non-empty list"
75−parseNEJSON (x:xs) = DT.mapM parseJSON (x :| xs)
76−
77−deleteSeveral :: (Eq k, Hashable k) => [k] -> HM.HashMap k v -> HM.HashMap k v
78−deleteSeveral ks hm = foldr HM.delete hm ks
79−
80−oPath :: ToJSON a => NonEmpty Text -> a -> Value
81−oPath (k :| []) v = object [k .= v]
82−oPath (k:| (h:t)) v = object [k .= oPath (h :| t) v]
83−
84−tshow :: Show a => a -> Text
85−tshow = T.pack . show
src/Database/Bloodhound/Client.hs+124−476
@@ -5,9 +5,9 @@
55-------------------------------------------------------------------------------
66-- |
77-- Module : Database.Bloodhound.Client
8−-- Copyright : (C) 2014, 2018 Chris Allen
8+-- Copyright : (C) 2014 Chris Allen
99-- License : BSD-style (see the file LICENSE)
10−-- Maintainer : Chris Allen <cma@bitemyapp.com>
10+-- Maintainer : Chris Allen <cma@bitemyapp.com
1111-- Stability : provisional
1212-- Portability : OverloadedStrings
1313--
@@ -23,43 +23,32 @@ module Database.Bloodhound.Client
2323
2424 -- $setup
2525 withBH
26− -- ** Indices
2726 , createIndex
28− , createIndexWith
29− , flushIndex
3027 , deleteIndex
3128 , updateIndexSettings
3229 , getIndexSettings
33− , forceMergeIndex
30+ , optimizeIndex
3431 , indexExists
3532 , openIndex
3633 , closeIndex
3734 , listIndices
38− , waitForYellowIndex
39− -- *** Index Aliases
4035 , updateIndexAliases
4136 , getIndexAliases
42− , deleteIndexAlias
43− -- *** Index Templates
4437 , putTemplate
4538 , templateExists
4639 , deleteTemplate
47− -- ** Mapping
4840 , putMapping
49− -- ** Documents
41+ , deleteMapping
5042 , indexDocument
5143 , updateDocument
5244 , getDocument
5345 , documentExists
5446 , deleteDocument
55− -- ** Searching
5647 , searchAll
5748 , searchByIndex
58− , searchByIndices
5949 , searchByType
6050 , scanSearch
6151 , getInitialScroll
62− , getInitialSortedScroll
6352 , advanceScroll
6453 , refreshIndex
6554 , mkSearch
@@ -70,22 +59,6 @@ module Database.Bloodhound.Client
7059 , mkShardCount
7160 , mkReplicaCount
7261 , getStatus
73− -- ** Snapshot/Restore
74− -- *** Snapshot Repos
75− , getSnapshotRepos
76− , updateSnapshotRepo
77− , verifySnapshotRepo
78− , deleteSnapshotRepo
79− -- *** Snapshots
80− , createSnapshot
81− , getSnapshots
82− , deleteSnapshot
83− -- *** Restoring Snapshots
84− , restoreSnapshot
85− -- ** Nodes
86− , getNodesInfo
87− , getNodesStats
88− -- ** Request Utilities
8962 , encodeBulkOperations
9063 , encodeBulkOperation
9164 -- * Authentication
@@ -99,7 +72,7 @@ module Database.Bloodhound.Client
9972 where
10073
10174import qualified Blaze.ByteString.Builder as BB
102−import Control.Applicative as A
75+import Control.Applicative
10376import Control.Monad
10477import Control.Monad.Catch
10578import Control.Monad.IO.Class
@@ -131,24 +104,24 @@ import Database.Bloodhound.Types
131104-- >>> :set -XOverloadedStrings
132105-- >>> :set -XDeriveGeneric
133106-- >>> import Database.Bloodhound
134−-- >>> import Network.HTTP.Client
107+-- >>> import Test.DocTest.Prop (assert)
135108-- >>> let testServer = (Server "http://localhost:9200")
136109-- >>> let runBH' = withBH defaultManagerSettings testServer
137110-- >>> let testIndex = IndexName "twitter"
138111-- >>> let testMapping = MappingName "tweet"
139112-- >>> let defaultIndexSettings = IndexSettings (ShardCount 1) (ReplicaCount 0)
140113-- >>> data TweetMapping = TweetMapping deriving (Eq, Show)
141−-- >>> _ <- runBH' $ deleteIndex testIndex
142−-- >>> _ <- runBH' $ deleteIndex (IndexName "didimakeanindex")
114+-- >>> _ <- runBH' $ deleteIndex testIndex >> deleteMapping testIndex testMapping
143115-- >>> import GHC.Generics
144116-- >>> import Data.Time.Calendar (Day (..))
145117-- >>> import Data.Time.Clock (UTCTime (..), secondsToDiffTime)
146118-- >>> :{
147119--instance ToJSON TweetMapping where
148120-- toJSON TweetMapping =
149−-- object ["properties" .=
150−-- object ["location" .=
151−-- object ["type" .= ("geo_point" :: Text)]]]
121+-- object ["tweet" .=
122+-- object ["properties" .=
123+-- object ["location" .=
124+-- object ["type" .= ("geo_point" :: Text)]]]]
152125--data Location = Location { lat :: Double
153126-- , lon :: Double } deriving (Eq, Generic, Show)
154127--data Tweet = Tweet { user :: Text
@@ -190,38 +163,28 @@ mkShardCount n
190163 | otherwise = Just (ShardCount n)
191164
192165-- | 'mkReplicaCount' is a straight-forward smart constructor for 'ReplicaCount'
193−-- which rejects 'Int' values below 0 and above 1000.
166+-- which rejects 'Int' values below 1 and above 1000.
194167--
195168-- >>> mkReplicaCount 10
196169-- Just (ReplicaCount 10)
197170mkReplicaCount :: Int -> Maybe ReplicaCount
198171mkReplicaCount n
199− | n < 0 = Nothing
172+ | n < 1 = Nothing
200173 | n > 1000 = Nothing -- ...
201174 | otherwise = Just (ReplicaCount n)
202175
203176emptyBody :: L.ByteString
204177emptyBody = L.pack ""
205178
206−dispatch :: MonadBH m
207− => Method
208− -> Text
209− -> Maybe L.ByteString
210− -> m Reply
179+dispatch :: MonadBH m => Method -> Text -> Maybe L.ByteString
180+ -> m Reply
211181dispatch dMethod url body = do
212182 initReq <- liftIO $ parseUrl' url
213− reqHook <- bhRequestHook A.<$> getBHEnv
183+ reqHook <- bhRequestHook <$> getBHEnv
214184 let reqBody = RequestBodyLBS $ fromMaybe emptyBody body
215− req <- liftIO
216− $ reqHook
217− $ setRequestIgnoreStatus
218− $ initReq { method = dMethod
219− , requestHeaders =
220− -- "application/x-ndjson" for bulk
221− ("Content-Type", "application/json") : requestHeaders initReq
222− , requestBody = reqBody }
223− -- req <- liftIO $ reqHook $ setRequestIgnoreStatus $ initReq { method = dMethod
224− -- , requestBody = reqBody }
185+ req <- liftIO $ reqHook $ initReq { method = dMethod
186+ , requestBody = reqBody
187+ , checkStatus = \_ _ _ -> Nothing}
225188 mgr <- bhManager <$> getBHEnv
226189 liftIO $ httpLbs req mgr
227190
@@ -238,8 +201,12 @@ appendSearchTypeParam originalUrl st = addQuery params originalUrl
238201 where stText = "search_type"
239202 params
240203 | st == SearchTypeDfsQueryThenFetch = [(stText, Just "dfs_query_then_fetch")]
204+ | st == SearchTypeCount = [(stText, Just "count")]
205+ | st == SearchTypeScan = [(stText, Just "scan"), ("scroll", Just "1m")]
206+ | st == SearchTypeQueryAndFetch = [(stText, Just "query_and_fetch")]
207+ | st == SearchTypeDfsQueryAndFetch = [(stText, Just "dfs_query_and_fetch")]
241208 -- used to catch 'SearchTypeQueryThenFetch', which is also the default
242− | otherwise = []
209+ | otherwise = [(stText, Just "query_then_fetch")]
243210
244211-- | Severely dumbed down query renderer. Assumes your data doesn't
245212-- need any encoding
@@ -283,226 +250,14 @@ post = dispatch NHTM.methodPost
283250-- | 'getStatus' fetches the 'Status' of a 'Server'
284251--
285252-- >>> serverStatus <- runBH' getStatus
286−-- >>> fmap tagline (serverStatus)
287−-- Just "You Know, for Search"
253+-- >>> fmap status (serverStatus)
254+-- Just 200
288255getStatus :: MonadBH m => m (Maybe Status)
289256getStatus = do
290257 response <- get =<< url
291258 return $ decode (responseBody response)
292259 where url = joinPath []
293260
294−-- | 'getSnapshotRepos' gets the definitions of a subset of the
295−-- defined snapshot repos.
296−getSnapshotRepos
297− :: ( MonadBH m
298− , MonadThrow m
299− )
300− => SnapshotRepoSelection
301− -> m (Either EsError [GenericSnapshotRepo])
302−getSnapshotRepos sel = fmap (fmap unGSRs) . parseEsResponse =<< get =<< url
303− where
304− url = joinPath ["_snapshot", selectorSeg]
305− selectorSeg = case sel of
306− AllSnapshotRepos -> "_all"
307− SnapshotRepoList (p :| ps) -> T.intercalate "," (renderPat <$> (p:ps))
308− renderPat (RepoPattern t) = t
309− renderPat (ExactRepo (SnapshotRepoName t)) = t
310−
311−
312−-- | Wrapper to extract the list of 'GenericSnapshotRepo' in the
313−-- format they're returned in
314−newtype GSRs = GSRs { unGSRs :: [GenericSnapshotRepo] }
315−
316−
317−instance FromJSON GSRs where
318− parseJSON = withObject "Collection of GenericSnapshotRepo" parse
319− where
320− parse = fmap GSRs . mapM (uncurry go) . HM.toList
321− go rawName = withObject "GenericSnapshotRepo" $ \o ->
322− GenericSnapshotRepo (SnapshotRepoName rawName) <$> o .: "type"
323− <*> o .: "settings"
324−
325−
326−-- | Create or update a snapshot repo
327−updateSnapshotRepo
328− :: ( MonadBH m
329− , SnapshotRepo repo
330− )
331− => SnapshotRepoUpdateSettings
332− -- ^ Use 'defaultSnapshotRepoUpdateSettings' if unsure
333− -> repo
334− -> m Reply
335−updateSnapshotRepo SnapshotRepoUpdateSettings {..} repo =
336− bindM2 put url (return (Just body))
337− where
338− url = addQuery params <$> joinPath ["_snapshot", snapshotRepoName gSnapshotRepoName]
339− params
340− | repoUpdateVerify = []
341− | otherwise = [("verify", Just "false")]
342− body = encode $ object [ "type" .= gSnapshotRepoType
343− , "settings" .= gSnapshotRepoSettings
344− ]
345− GenericSnapshotRepo {..} = toGSnapshotRepo repo
346−
347−
348−
349−-- | Verify if a snapshot repo is working. __NOTE:__ this API did not
350−-- make it into Elasticsearch until 1.4. If you use an older version,
351−-- you will get an error here.
352−verifySnapshotRepo
353− :: ( MonadBH m
354− , MonadThrow m
355− )
356− => SnapshotRepoName
357− -> m (Either EsError SnapshotVerification)
358−verifySnapshotRepo (SnapshotRepoName n) =
359− parseEsResponse =<< bindM2 post url (return Nothing)
360− where
361− url = joinPath ["_snapshot", n, "_verify"]
362−
363−
364−deleteSnapshotRepo :: MonadBH m => SnapshotRepoName -> m Reply
365−deleteSnapshotRepo (SnapshotRepoName n) = delete =<< url
366− where
367− url = joinPath ["_snapshot", n]
368−
369−
370−-- | Create and start a snapshot
371−createSnapshot
372− :: (MonadBH m)
373− => SnapshotRepoName
374− -> SnapshotName
375− -> SnapshotCreateSettings
376− -> m Reply
377−createSnapshot (SnapshotRepoName repoName)
378− (SnapshotName snapName)
379− SnapshotCreateSettings {..} =
380− bindM2 put url (return (Just body))
381− where
382− url = addQuery params <$> joinPath ["_snapshot", repoName, snapName]
383− params = [("wait_for_completion", Just (boolQP snapWaitForCompletion))]
384− body = encode $ object prs
385− prs = catMaybes [ ("indices" .=) . indexSelectionName <$> snapIndices
386− , Just ("ignore_unavailable" .= snapIgnoreUnavailable)
387− , Just ("ignore_global_state" .= snapIncludeGlobalState)
388− , Just ("partial" .= snapPartial)
389− ]
390−
391−
392−indexSelectionName :: IndexSelection -> Text
393−indexSelectionName AllIndexes = "_all"
394−indexSelectionName (IndexList (i :| is)) = T.intercalate "," (renderIndex <$> (i:is))
395− where
396− renderIndex (IndexName n) = n
397−
398−
399−-- | Get info about known snapshots given a pattern and repo name.
400−getSnapshots
401− :: ( MonadBH m
402− , MonadThrow m
403− )
404− => SnapshotRepoName
405− -> SnapshotSelection
406− -> m (Either EsError [SnapshotInfo])
407−getSnapshots (SnapshotRepoName repoName) sel =
408− fmap (fmap unSIs) . parseEsResponse =<< get =<< url
409− where
410− url = joinPath ["_snapshot", repoName, snapPath]
411− snapPath = case sel of
412− AllSnapshots -> "_all"
413− SnapshotList (s :| ss) -> T.intercalate "," (renderPath <$> (s:ss))
414− renderPath (SnapPattern t) = t
415− renderPath (ExactSnap (SnapshotName t)) = t
416−
417−
418−newtype SIs = SIs { unSIs :: [SnapshotInfo] }
419−
420−
421−instance FromJSON SIs where
422− parseJSON = withObject "Collection of SnapshotInfo" parse
423− where
424− parse o = SIs <$> o .: "snapshots"
425−
426−
427−-- | Delete a snapshot. Cancels if it is running.
428−deleteSnapshot :: MonadBH m => SnapshotRepoName -> SnapshotName -> m Reply
429−deleteSnapshot (SnapshotRepoName repoName) (SnapshotName snapName) =
430− delete =<< url
431− where
432− url = joinPath ["_snapshot", repoName, snapName]
433−
434−
435−-- | Restore a snapshot to the cluster See
436−-- <https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html#_restore>
437−-- for more details.
438−restoreSnapshot
439− :: MonadBH m
440− => SnapshotRepoName
441− -> SnapshotName
442− -> SnapshotRestoreSettings
443− -- ^ Start with 'defaultSnapshotRestoreSettings' and customize
444− -- from there for reasonable defaults.
445− -> m Reply
446−restoreSnapshot (SnapshotRepoName repoName)
447− (SnapshotName snapName)
448− SnapshotRestoreSettings {..} = bindM2 post url (return (Just body))
449− where
450− url = addQuery params <$> joinPath ["_snapshot", repoName, snapName, "_restore"]
451− params = [("wait_for_completion", Just (boolQP snapRestoreWaitForCompletion))]
452− body = encode (object prs)
453−
454−
455− prs = catMaybes [ ("indices" .=) . indexSelectionName <$> snapRestoreIndices
456− , Just ("ignore_unavailable" .= snapRestoreIgnoreUnavailable)
457− , Just ("include_global_state" .= snapRestoreIncludeGlobalState)
458− , ("rename_pattern" .=) <$> snapRestoreRenamePattern
459− , ("rename_replacement" .=) . renderTokens <$> snapRestoreRenameReplacement
460− , Just ("include_aliases" .= snapRestoreIncludeAliases)
461− , ("index_settings" .= ) <$> snapRestoreIndexSettingsOverrides
462− , ("ignore_index_settings" .= ) <$> snapRestoreIgnoreIndexSettings
463− ]
464− renderTokens (t :| ts) = mconcat (renderToken <$> (t:ts))
465− renderToken (RRTLit t) = t
466− renderToken RRSubWholeMatch = "$0"
467− renderToken (RRSubGroup g) = T.pack (show (rrGroupRefNum g))
468−
469−
470−getNodesInfo
471− :: ( MonadBH m
472− , MonadThrow m
473− )
474− => NodeSelection
475− -> m (Either EsError NodesInfo)
476−getNodesInfo sel = parseEsResponse =<< get =<< url
477− where
478− url = joinPath ["_nodes", selectionSeg]
479− selectionSeg = case sel of
480− LocalNode -> "_local"
481− NodeList (l :| ls) -> T.intercalate "," (selToSeg <$> (l:ls))
482− AllNodes -> "_all"
483− selToSeg (NodeByName (NodeName n)) = n
484− selToSeg (NodeByFullNodeId (FullNodeId i)) = i
485− selToSeg (NodeByHost (Server s)) = s
486− selToSeg (NodeByAttribute (NodeAttrName a) v) = a <> ":" <> v
487−
488−getNodesStats
489− :: ( MonadBH m
490− , MonadThrow m
491− )
492− => NodeSelection
493− -> m (Either EsError NodesStats)
494−getNodesStats sel = parseEsResponse =<< get =<< url
495− where
496− url = joinPath ["_nodes", selectionSeg, "stats"]
497− selectionSeg = case sel of
498− LocalNode -> "_local"
499− NodeList (l :| ls) -> T.intercalate "," (selToSeg <$> (l:ls))
500− AllNodes -> "_all"
501− selToSeg (NodeByName (NodeName n)) = n
502− selToSeg (NodeByFullNodeId (FullNodeId i)) = i
503− selToSeg (NodeByHost (Server s)) = s
504− selToSeg (NodeByAttribute (NodeAttrName a) v) = a <> ":" <> v
505−
506261-- | 'createIndex' will create an index given a 'Server', 'IndexSettings', and an 'IndexName'.
507262--
508263-- >>> response <- runBH' $ createIndex defaultIndexSettings (IndexName "didimakeanindex")
@@ -516,38 +271,14 @@ createIndex indexSettings (IndexName indexName) =
516271 where url = joinPath [indexName]
517272 body = Just $ encode indexSettings
518273
519−-- | Create an index, providing it with any number of settings. This
520−-- is more expressive than 'createIndex' but makes is more verbose
521−-- for the common case of configuring only the shard count and
522−-- replica count.
523−createIndexWith :: MonadBH m
524− => [UpdatableIndexSetting]
525− -> Int -- ^ shard count
526− -> IndexName
527− -> m Reply
528−createIndexWith updates shards (IndexName indexName) =
529− bindM2 put url (return (Just body))
530− where url = joinPath [indexName]
531− body = encode $ object
532− ["settings" .= deepMerge
533− ( HM.singleton "index.number_of_shards" (toJSON shards) :
534− [u | Object u <- toJSON <$> updates]
535− )
536− ]
537−
538−-- | 'flushIndex' will flush an index given a 'Server' and an 'IndexName'.
539−flushIndex :: MonadBH m => IndexName -> m Reply
540−flushIndex (IndexName indexName) = do
541− path <- joinPath [indexName, "_flush"]
542− post path Nothing
543−
544−-- | 'deleteIndex' will delete an index given a 'Server' and an 'IndexName'.
274+
275+-- | 'deleteIndex' will delete an index given a 'Server', and an 'IndexName'.
545276--
546277-- >>> _ <- runBH' $ createIndex defaultIndexSettings (IndexName "didimakeanindex")
547278-- >>> response <- runBH' $ deleteIndex (IndexName "didimakeanindex")
548279-- >>> respIsTwoHunna response
549280-- True
550−-- >>> runBH' $ indexExists (IndexName "didimakeanindex")
281+-- >>> runBH' $ indexExists testIndex
551282-- False
552283deleteIndex :: MonadBH m => IndexName -> m Reply
553284deleteIndex (IndexName indexName) =
@@ -562,57 +293,60 @@ deleteIndex (IndexName indexName) =
562293updateIndexSettings :: MonadBH m => NonEmpty UpdatableIndexSetting -> IndexName -> m Reply
563294updateIndexSettings updates (IndexName indexName) =
564295 bindM2 put url (return body)
565− where
566− url = joinPath [indexName, "_settings"]
567− body = Just (encode jsonBody)
568− jsonBody = Object (deepMerge [u | Object u <- toJSON <$> toList updates])
296+ where url = joinPath [indexName, "_settings"]
297+ body = Just (encode jsonBody)
298+ jsonBody = Object (deepMerge [u | Object u <- toJSON <$> toList updates])
569299
570300
571301getIndexSettings :: (MonadBH m, MonadThrow m) => IndexName
572302 -> m (Either EsError IndexSettingsSummary)
573−getIndexSettings (IndexName indexName) =
303+getIndexSettings (IndexName indexName) = do
574304 parseEsResponse =<< get =<< url
575− where
576− url = joinPath [indexName, "_settings"]
305+ where url = joinPath [indexName, "_settings"]
577306
578−-- | 'forceMergeIndex'
579−--
580−-- The force merge API allows to force merging of one or more indices through
581−-- an API. The merge relates to the number of segments a Lucene index holds
582−-- within each shard. The force merge operation allows to reduce the number of
583−-- segments by merging them.
584−--
585−-- This call will block until the merge is complete. If the http connection is
586−-- lost, the request will continue in the background, and any new requests will
587−-- block until the previous force merge is complete.
588307
589−-- For more information see
590−-- <https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html#indices-forcemerge>.
591−-- Nothing
308+-- | 'optimizeIndex' will optimize a single index, list of indexes or
309+-- all indexes. Note that this call will block until finishing but
310+-- will continue even if the request times out. Concurrent requests to
311+-- optimize an index while another is performing will block until the
312+-- previous one finishes. For more information see
313+-- <https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-optimize.html>. Nothing
592314-- worthwhile comes back in the reply body, so matching on the status
593315-- should suffice.
594316--
595−-- 'forceMergeIndex' with a maxNumSegments of 1 and onlyExpungeDeletes
317+-- 'optimizeIndex' with a maxNumSegments of 1 and onlyExpungeDeletes
596318-- to True is the main way to release disk space back to the OS being
597319-- held by deleted documents.
598320--
321+-- Note that this API was deprecated in ElasticSearch 2.1 for the
322+-- almost completely identical forcemerge API. Adding support to that
323+-- API would be trivial but due to the significant breaking changes,
324+-- this library cannot currently be used with >= 2.0, so that feature was omitted.
325+--
599326-- >>> let ixn = IndexName "unoptimizedindex"
600327-- >>> _ <- runBH' $ deleteIndex ixn >> createIndex defaultIndexSettings ixn
601−-- >>> response <- runBH' $ forceMergeIndex (IndexList (ixn :| [])) (defaultIndexOptimizationSettings { maxNumSegments = Just 1, onlyExpungeDeletes = True })
328+-- >>> response <- runBH' $ optimizeIndex (IndexList (ixn :| [])) (defaultIndexOptimizationSettings { maxNumSegments = Just 1, onlyExpungeDeletes = True })
602329-- >>> respIsTwoHunna response
603330-- True
604−forceMergeIndex :: MonadBH m => IndexSelection -> ForceMergeIndexSettings -> m Reply
605−forceMergeIndex ixs ForceMergeIndexSettings {..} =
331+optimizeIndex :: MonadBH m => IndexSelection -> IndexOptimizationSettings -> m Reply
332+optimizeIndex ixs IndexOptimizationSettings {..} =
606333 bindM2 post url (return body)
607− where url = addQuery params <$> joinPath [indexName, "_forcemerge"]
334+ where url = addQuery params <$> joinPath [indexName, "_optimize"]
608335 params = catMaybes [ ("max_num_segments",) . Just . showText <$> maxNumSegments
609336 , Just ("only_expunge_deletes", Just (boolQP onlyExpungeDeletes))
610337 , Just ("flush", Just (boolQP flushAfterOptimize))
611338 ]
612339 indexName = indexSelectionName ixs
340+ boolQP True = "true"
341+ boolQP False = "false"
613342 body = Nothing
614343
615344
345+-------------------------------------------------------------------------------
346+indexSelectionName :: IndexSelection -> Text
347+indexSelectionName (IndexList names) = T.intercalate "," [n | IndexName n <- toList names]
348+indexSelectionName AllIndexes = "_all"
349+
616350deepMerge :: [Object] -> Object
617351deepMerge = LS.foldl' go mempty
618352 where go acc = LS.foldl' go' acc . HM.toList
@@ -638,25 +372,20 @@ existentialQuery url = do
638372-- responses from elasticsearch should fall into these two
639373-- categories. If they don't, a 'EsProtocolException' will be
640374-- thrown. If you encounter this, please report the full body it
641−-- reports along with your Elasticsearch verison.
642−parseEsResponse :: ( MonadThrow m
643− , FromJSON a
644− )
645− => Reply
375+-- reports along with your ElasticSearch verison.
376+parseEsResponse :: (MonadThrow m, FromJSON a) => Reply
646377 -> m (Either EsError a)
647378parseEsResponse reply
648379 | respIsTwoHunna reply = case eitherDecode body of
649380 Right a -> return (Right a)
650− Left err ->
651− tryParseError err
652− | otherwise = tryParseError "Non-200 status code"
381+ Left _ -> tryParseError
382+ | otherwise = tryParseError
653383 where body = responseBody reply
654− tryParseError originalError
655− = case eitherDecode body of
656− Right e -> return (Left e)
657− -- Failed to parse the error message.
658− Left err -> explode ("Original error was: " <> originalError <> " Error parse failure was: " <> err)
659− explode errorMsg = throwM (EsProtocolException (T.pack errorMsg) body)
384+ tryParseError = case eitherDecode body of
385+ Right e -> return (Left e)
386+ -- this case should not be possible
387+ Left _ -> explode
388+ explode = throwM (EsProtocolException body)
660389
661390-- | 'indexExists' enables you to check if an index exists. Returns 'Bool'
662391-- in IO
@@ -677,14 +406,6 @@ refreshIndex (IndexName indexName) =
677406 bindM2 post url (return Nothing)
678407 where url = joinPath [indexName, "_refresh"]
679408
680−-- | Block until the index becomes available for indexing
681−-- documents. This is useful for integration tests in which
682−-- indices are rapidly created and deleted.
683−waitForYellowIndex :: MonadBH m => IndexName -> m Reply
684−waitForYellowIndex (IndexName indexName) = get =<< url
685− where url = addQuery q <$> joinPath ["_cluster","health",indexName]
686− q = [("wait_for_status",Just "yellow"),("timeout",Just "10s")]
687−
688409stringifyOCIndex :: OpenCloseIndex -> Text
689410stringifyOCIndex oci = case oci of
690411 OpenIndex -> "_open"
@@ -715,16 +436,14 @@ listIndices :: (MonadThrow m, MonadBH m) => m [IndexName]
715436listIndices =
716437 parse . responseBody =<< get =<< url
717438 where
718− url = joinPath ["_cat/indices?format=json"]
719− parse body = either (\msg -> (throwM (EsProtocolException (T.pack msg) body))) return $ do
720− vals <- eitherDecode body
721− forM vals $ \val ->
722− case val of
723− Object obj ->
724− case HM.lookup "index" obj of
725− (Just (String txt)) -> Right (IndexName txt)
726− v -> Left $ "indexVal in listIndices failed on non-string, was: " <> show v
727− v -> Left $ "One of the values parsed in listIndices wasn't an object, it was: " <> show v
439+ url = joinPath ["_cat/indices?v"]
440+ -- parses the tabular format the indices api provides
441+ parse body = case T.lines (T.decodeUtf8 (L.toStrict body)) of
442+ (hdr:rows) -> let ks = T.words hdr
443+ keyedRows = [ HM.fromList (zip ks (T.words row)) | row <- rows ]
444+ names = catMaybes (HM.lookup "index" <$> keyedRows)
445+ in return (IndexName <$> names)
446+ [] -> throwM (EsProtocolException body)
728447
729448-- | 'updateIndexAliases' updates the server's index alias
730449-- table. Operations are atomic. Explained in further detail at
@@ -755,12 +474,6 @@ getIndexAliases :: (MonadBH m, MonadThrow m)
755474getIndexAliases = parseEsResponse =<< get =<< url
756475 where url = joinPath ["_aliases"]
757476
758−-- | Delete a single alias, removing it from all indices it
759−-- is currently associated with.
760−deleteIndexAlias :: MonadBH m => IndexAliasName -> m Reply
761−deleteIndexAlias (IndexAliasName (IndexName name)) = delete =<< url
762− where url = joinPath ["_all","_alias",name]
763−
764477-- | 'putTemplate' creates a template given an 'IndexTemplate' and a 'TemplateName'.
765478-- Explained in further detail at
766479-- <https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-templates.html>
@@ -796,7 +509,7 @@ deleteTemplate (TemplateName templateName) =
796509-- >>> _ <- runBH' $ createIndex defaultIndexSettings testIndex
797510-- >>> resp <- runBH' $ putMapping testIndex testMapping TweetMapping
798511-- >>> print resp
799−-- Response {responseStatus = Status {statusCode = 200, statusMessage = "OK"}, responseVersion = HTTP/1.1, responseHeaders = [("content-type","application/json; charset=UTF-8"),("content-encoding","gzip"),("transfer-encoding","chunked")], responseBody = "{\"acknowledged\":true}", responseCookieJar = CJ {expose = []}, responseClose' = ResponseClose}
512+-- Response {responseStatus = Status {statusCode = 200, statusMessage = "OK"}, responseVersion = HTTP/1.1, responseHeaders = [("Content-Type","application/json; charset=UTF-8"),("Content-Length","21")], responseBody = "{\"acknowledged\":true}", responseCookieJar = CJ {expose = []}, responseClose' = ResponseClose}
800513putMapping :: (MonadBH m, ToJSON a) => IndexName
801514 -> MappingName -> a -> m Reply
802515putMapping (IndexName indexName) (MappingName mappingName) mapping =
@@ -806,6 +519,21 @@ putMapping (IndexName indexName) (MappingName mappingName) mapping =
806519 -- erroneously. The correct API call is: "/INDEX/_mapping/MAPPING_NAME"
807520 body = Just $ encode mapping
808521
522+-- | 'deleteMapping' is an HTTP DELETE and deletes a mapping for a given index.
523+-- Mappings are schemas for documents in indexes.
524+--
525+-- >>> _ <- runBH' $ createIndex defaultIndexSettings testIndex
526+-- >>> _ <- runBH' $ putMapping testIndex testMapping TweetMapping
527+-- >>> resp <- runBH' $ deleteMapping testIndex testMapping
528+-- >>> print resp
529+-- Response {responseStatus = Status {statusCode = 200, statusMessage = "OK"}, responseVersion = HTTP/1.1, responseHeaders = [("Content-Type","application/json; charset=UTF-8"),("Content-Length","21")], responseBody = "{\"acknowledged\":true}", responseCookieJar = CJ {expose = []}, responseClose' = ResponseClose}
530+deleteMapping :: MonadBH m => IndexName -> MappingName -> m Reply
531+deleteMapping (IndexName indexName)
532+ (MappingName mappingName) =
533+ -- "_mapping" and mappingName below were originally transposed
534+ -- erroneously. The correct API call is: "/INDEX/_mapping/MAPPING_NAME"
535+ delete =<< joinPath [indexName, "_mapping", mappingName]
536+
809537versionCtlParams :: IndexDocumentSettings -> [(Text, Maybe Text)]
810538versionCtlParams cfg =
811539 case idsVersionControl cfg of
@@ -823,14 +551,11 @@ versionCtlParams cfg =
823551-- | 'indexDocument' is the primary way to save a single document in
824552-- Elasticsearch. The document itself is simply something we can
825553-- convert into a JSON 'Value'. The 'DocId' will function as the
826−-- primary key for the document. You are encouraged to generate
827−-- your own id's and not rely on Elasticsearch's automatic id
828−-- generation. Read more about it here:
829−-- https://github.com/bitemyapp/bloodhound/issues/107
554+-- primary key for the document.
830555--
831556-- >>> resp <- runBH' $ indexDocument testIndex testMapping defaultIndexDocumentSettings exampleTweet (DocId "1")
832557-- >>> print resp
833−-- Response {responseStatus = Status {statusCode = 201, statusMessage = "Created"}, responseVersion = HTTP/1.1, responseHeaders = [("Location","/twitter/tweet/1"),("content-type","application/json; charset=UTF-8"),("content-encoding","gzip"),("transfer-encoding","chunked")], responseBody = "{\"_index\":\"twitter\",\"_type\":\"tweet\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"_shards\":{\"total\":2,\"successful\":1,\"failed\":0},\"created\":true}", responseCookieJar = CJ {expose = []}, responseClose' = ResponseClose}
558+-- Response {responseStatus = Status {statusCode = 201, statusMessage = "Created"}, responseVersion = HTTP/1.1, responseHeaders = [("Content-Type","application/json; charset=UTF-8"),("Content-Length","74")], responseBody = "{\"_index\":\"twitter\",\"_type\":\"tweet\",\"_id\":\"1\",\"_version\":1,\"created\":true}", responseCookieJar = CJ {expose = []}, responseClose' = ResponseClose}
834559indexDocument :: (ToJSON doc, MonadBH m) => IndexName -> MappingName
835560 -> IndexDocumentSettings -> doc -> DocId -> m Reply
836561indexDocument (IndexName indexName)
@@ -866,7 +591,7 @@ deleteDocument (IndexName indexName)
866591-- | 'bulk' uses
867592-- <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html Elasticsearch's bulk API>
868593-- to perform bulk operations. The 'BulkOperation' data type encodes the
869−-- index\/update\/delete\/create operations. You pass a 'V.Vector' of 'BulkOperation's
594+-- index/update/delete/create operations. You pass a 'V.Vector' of 'BulkOperation's
870595-- and a 'Server' to 'bulk' in order to send those operations up to your Elasticsearch
871596-- server to be performed. I changed from [BulkOperation] to a Vector due to memory overhead.
872597--
@@ -874,11 +599,9 @@ deleteDocument (IndexName indexName)
874599-- >>> _ <- runBH' $ bulk stream
875600-- >>> _ <- runBH' $ refreshIndex testIndex
876601bulk :: MonadBH m => V.Vector BulkOperation -> m Reply
877−bulk bulkOps =
878− bindM2 post url (return body)
879− where
880− url = joinPath ["_bulk"]
881− body = Just $ encodeBulkOperations bulkOps
602+bulk bulkOps = bindM2 post url (return body)
603+ where url = joinPath ["_bulk"]
604+ body = Just $ encodeBulkOperations bulkOps
882605
883606-- | 'encodeBulkOperations' is a convenience function for dumping a vector of 'BulkOperation'
884607-- into an 'L.ByteString'
@@ -888,15 +611,12 @@ bulk bulkOps =
888611-- "\n{\"index\":{\"_type\":\"tweet\",\"_id\":\"2\",\"_index\":\"twitter\"}}\n{\"name\":\"blah\"}\n"
889612encodeBulkOperations :: V.Vector BulkOperation -> L.ByteString
890613encodeBulkOperations stream = collapsed where
891− blobs =
892− fmap encodeBulkOperation stream
893− mashedTaters =
894− mash (mempty :: Builder) blobs
895− collapsed =
896− toLazyByteString $ mappend mashedTaters (byteString "\n")
614+ blobs = fmap encodeBulkOperation stream
615+ mashedTaters = mash (mempty :: Builder) blobs
616+ collapsed = toLazyByteString $ mappend mashedTaters (byteString "\n")
897617
898618mash :: Builder -> V.Vector L.ByteString -> Builder
899−mash = V.foldl' (\b x -> b <> byteString "\n" <> lazyByteString x)
619+mash = V.foldl' (\b x -> b `mappend` (byteString "\n") `mappend` (lazyByteString x))
900620
901621mkBulkStreamValue :: Text -> Text -> Text -> Text -> Value
902622mkBulkStreamValue operation indexName mappingName docId =
@@ -905,12 +625,6 @@ mkBulkStreamValue operation indexName mappingName docId =
905625 , "_type" .= mappingName
906626 , "_id" .= docId]]
907627
908−mkBulkStreamValueAuto :: Text -> Text -> Text -> Value
909−mkBulkStreamValueAuto operation indexName mappingName =
910− object [operation .=
911− object [ "_index" .= indexName
912− , "_type" .= mappingName]]
913−
914628-- | 'encodeBulkOperation' is a convenience function for dumping a single 'BulkOperation'
915629-- into an 'L.ByteString'
916630--
@@ -924,18 +638,6 @@ encodeBulkOperation (BulkIndex (IndexName indexName)
924638 where metadata = mkBulkStreamValue "index" indexName mappingName docId
925639 blob = encode metadata `mappend` "\n" `mappend` encode value
926640
927−encodeBulkOperation (BulkIndexAuto (IndexName indexName)
928− (MappingName mappingName)
929− value) = blob
930− where metadata = mkBulkStreamValueAuto "index" indexName mappingName
931− blob = encode metadata `mappend` "\n" `mappend` encode value
932−
933−encodeBulkOperation (BulkIndexEncodingAuto (IndexName indexName)
934− (MappingName mappingName)
935− encoding) = toLazyByteString blob
936− where metadata = toEncoding (mkBulkStreamValueAuto "index" indexName mappingName)
937− blob = fromEncoding metadata <> "\n" <> fromEncoding encoding
938−
939641encodeBulkOperation (BulkCreate (IndexName indexName)
940642 (MappingName mappingName)
941643 (DocId docId) value) = blob
@@ -955,12 +657,6 @@ encodeBulkOperation (BulkUpdate (IndexName indexName)
955657 doc = object ["doc" .= value]
956658 blob = encode metadata `mappend` "\n" `mappend` encode doc
957659
958−encodeBulkOperation (BulkCreateEncoding (IndexName indexName)
959− (MappingName mappingName)
960− (DocId docId) encoding) = toLazyByteString blob
961− where metadata = toEncoding (mkBulkStreamValue "create" indexName mappingName docId)
962− blob = fromEncoding metadata <> "\n" <> fromEncoding encoding
963−
964660-- | 'getDocument' is a straight-forward way to fetch a single document from
965661-- Elasticsearch using a 'Server', 'IndexName', 'MappingName', and a 'DocId'.
966662-- The 'DocId' is the primary key for your Elasticsearch document.
@@ -1010,15 +706,6 @@ searchByIndex :: MonadBH m => IndexName -> Search -> m Reply
1010706searchByIndex (IndexName indexName) = bindM2 dispatchSearch url . return
1011707 where url = joinPath [indexName, "_search"]
1012708
1013−-- | 'searchByIndices' is a variant of 'searchByIndex' that executes a
1014−-- 'Search' over many indices. This is much faster than using
1015−-- 'mapM' to 'searchByIndex' over a collection since it only
1016−-- causes a single HTTP request to be emitted.
1017−searchByIndices :: MonadBH m => NonEmpty IndexName -> Search -> m Reply
1018−searchByIndices ixs = bindM2 dispatchSearch url . return
1019− where url = joinPath [renderedIxs, "_search"]
1020− renderedIxs = T.intercalate (T.singleton ',') (map (\(IndexName t) -> t) (toList ixs))
1021−
1022709-- | 'searchByType', given a 'Search', 'IndexName', and 'MappingName', will perform that
1023710-- search against a specific mapping within an index on an Elasticsearch server.
1024711--
@@ -1031,40 +718,20 @@ searchByType (IndexName indexName)
1031718 (MappingName mappingName) = bindM2 dispatchSearch url . return
1032719 where url = joinPath [indexName, mappingName, "_search"]
1033720
1034−-- | For a given search, request a scroll for efficient streaming of
721+-- | For a given scearch, request a scroll for efficient streaming of
1035722-- search results. Note that the search is put into 'SearchTypeScan'
1036723-- mode and thus results will not be sorted. Combine this with
1037724-- 'advanceScroll' to efficiently stream through the full result set
1038−getInitialScroll ::
1039− (FromJSON a, MonadThrow m, MonadBH m) => IndexName ->
1040− MappingName ->
1041− Search ->
1042− m (Either EsError (SearchResult a))
1043−getInitialScroll (IndexName indexName) (MappingName mappingName) search' = do
1044− let url = addQuery params <$> joinPath [indexName, mappingName, "_search"]
1045− params = [("scroll", Just "1m")]
1046− sorting = Just [DefaultSortSpec $ mkSort (FieldName "_doc") Descending]
1047− search = search' { sortBody = sorting }
1048− resp' <- bindM2 dispatchSearch url (return search)
1049− parseEsResponse resp'
1050−
1051−-- | For a given search, request a scroll for efficient streaming of
1052−-- search results. Combine this with 'advanceScroll' to efficiently
1053−-- stream through the full result set. Note that this search respects
1054−-- sorting and may be less efficient than 'getInitialScroll'.
1055−getInitialSortedScroll ::
1056− (FromJSON a, MonadThrow m, MonadBH m) => IndexName ->
1057− MappingName ->
1058− Search ->
1059− m (Either EsError (SearchResult a))
1060−getInitialSortedScroll (IndexName indexName) (MappingName mappingName) search = do
1061− let url = addQuery params <$> joinPath [indexName, mappingName, "_search"]
1062− params = [("scroll", Just "1m")]
1063− resp' <- bindM2 dispatchSearch url (return search)
1064− parseEsResponse resp'
1065−
1066−scroll' :: (FromJSON a, MonadBH m, MonadThrow m) => Maybe ScrollId ->
1067− m ([Hit a], Maybe ScrollId)
725+getInitialScroll :: MonadBH m => IndexName -> MappingName -> Search -> m (Maybe ScrollId)
726+getInitialScroll (IndexName indexName) (MappingName mappingName) search = do
727+ let url = joinPath [indexName, mappingName, "_search"]
728+ search' = search { searchType = SearchTypeScan }
729+ resp' <- bindM2 dispatchSearch url (return search')
730+ let msr = decode' $ responseBody resp' :: Maybe (SearchResult ())
731+ msid = maybe Nothing scrollId msr
732+ return msid
733+
734+scroll' :: (FromJSON a, MonadBH m, MonadThrow m) => Maybe ScrollId -> m ([Hit a], Maybe ScrollId)
1068735scroll' Nothing = return ([], Nothing)
1069736scroll' (Just sid) = do
1070737 res <- advanceScroll sid 60
@@ -1084,29 +751,20 @@ advanceScroll
1084751 -- ^ How long should the snapshot of data be kept around? This timeout is updated every time 'advanceScroll' is used, so don't feel the need to set it to the entire duration of your search processing. Note that durations < 1s will be rounded up. Also note that 'NominalDiffTime' is an instance of Num so literals like 60 will be interpreted as seconds. 60s is a reasonable default.
1085752 -> m (Either EsError (SearchResult a))
1086753advanceScroll (ScrollId sid) scroll = do
1087− url <- joinPath ["_search", "scroll"]
1088− resp <- post url (Just $ encode scrollObject)
1089− parseEsResponse resp
754+ url <- joinPath ["_search/scroll?scroll=" <> scrollTime]
755+ parseEsResponse =<< post url (Just . L.fromStrict $ T.encodeUtf8 sid)
1090756 where scrollTime = showText secs <> "s"
1091757 secs :: Integer
1092758 secs = round scroll
1093759
1094− scrollObject = object [ "scroll" .= scrollTime
1095− , "scroll_id" .= sid
1096− ]
1097−
1098−simpleAccumulator ::
1099− (FromJSON a, MonadBH m, MonadThrow m) =>
1100− [Hit a] ->
1101− ([Hit a], Maybe ScrollId) ->
1102− m ([Hit a], Maybe ScrollId)
760+simpleAccumulator :: (FromJSON a, MonadBH m, MonadThrow m) => [Hit a] -> ([Hit a], Maybe ScrollId) -> m ([Hit a], Maybe ScrollId)
1103761simpleAccumulator oldHits (newHits, Nothing) = return (oldHits ++ newHits, Nothing)
1104762simpleAccumulator oldHits ([], _) = return (oldHits, Nothing)
1105763simpleAccumulator oldHits (newHits, msid) = do
1106764 (newHits', msid') <- scroll' msid
1107765 simpleAccumulator (oldHits ++ newHits) (newHits', msid')
1108766
1109−-- | 'scanSearch' uses the 'scroll' API of elastic,
767+-- | 'scanSearch' uses the 'scan&scroll' API of elastic,
1110768-- for a given 'IndexName' and 'MappingName'. Note that this will
1111769-- consume the entire search result set and will be doing O(n) list
1112770-- appends so this may not be suitable for large result sets. In that
@@ -1115,16 +773,11 @@ simpleAccumulator oldHits (newHits, msid) = do
1115773-- pipes, or your favorite streaming IO abstraction of choice. Note
1116774-- that ordering on the search would destroy performance and thus is
1117775-- ignored.
1118−scanSearch :: (FromJSON a, MonadBH m, MonadThrow m) => IndexName
1119− -> MappingName
1120− -> Search
1121− -> m [Hit a]
776+scanSearch :: (FromJSON a, MonadBH m, MonadThrow m) => IndexName -> MappingName -> Search -> m [Hit a]
1122777scanSearch indexName mappingName search = do
1123− initialSearchResult <- getInitialScroll indexName mappingName search
1124− let (hits', josh) = case initialSearchResult of
1125− Right SearchResult {..} -> (hits searchHits, scrollId)
1126− Left _ -> ([], Nothing)
1127− (totalHits, _) <- simpleAccumulator [] (hits', josh)
778+ msid <- getInitialScroll indexName mappingName search
779+ (hits, msid') <- scroll' msid
780+ (totalHits, _) <- simpleAccumulator [] (hits, msid')
1128781 return totalHits
1129782
1130783-- | 'mkSearch' is a helper function for defaulting additional fields of a 'Search'
@@ -1134,9 +787,9 @@ scanSearch indexName mappingName search = do
1134787--
1135788-- >>> let query = TermQuery (Term "user" "bitemyapp") Nothing
1136789-- >>> mkSearch (Just query) Nothing
1137−-- Search {queryBody = Just (TermQuery (Term {termField = "user", termValue = "bitemyapp"}) Nothing), filterBody = Nothing, searchAfterKey = Nothing, sortBody = Nothing, aggBody = Nothing, highlight = Nothing, trackSortScores = False, from = From 0, size = Size 10, searchType = SearchTypeQueryThenFetch, fields = Nothing, source = Nothing}
790+-- Search {queryBody = Just (TermQuery (Term {termField = "user", termValue = "bitemyapp"}) Nothing), filterBody = Nothing, sortBody = Nothing, aggBody = Nothing, highlight = Nothing, trackSortScores = False, from = From 0, size = Size 10, searchType = SearchTypeQueryThenFetch, fields = Nothing, source = Nothing}
1138791mkSearch :: Maybe Query -> Maybe Filter -> Search
1139−mkSearch query filter = Search query filter Nothing Nothing Nothing False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing Nothing Nothing Nothing
792+mkSearch query filter = Search query filter Nothing Nothing Nothing False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing
1140793
1141794-- | 'mkAggregateSearch' is a helper function that defaults everything in a 'Search' except for
1142795-- the 'Query' and the 'Aggregation'.
@@ -1146,7 +799,7 @@ mkSearch query filter = Search query filter Nothing Nothing Nothing False (From
1146799-- TermsAgg (TermsAggregation {term = Left "user", termInclude = Nothing, termExclude = Nothing, termOrder = Nothing, termMinDocCount = Nothing, termSize = Nothing, termShardSize = Nothing, termCollectMode = Just BreadthFirst, termExecutionHint = Nothing, termAggs = Nothing})
1147800-- >>> let myAggregation = mkAggregateSearch Nothing $ mkAggregations "users" terms
1148801mkAggregateSearch :: Maybe Query -> Aggregations -> Search
1149−mkAggregateSearch query mkSearchAggs = Search query Nothing Nothing (Just mkSearchAggs) Nothing False (From 0) (Size 0) SearchTypeQueryThenFetch Nothing Nothing Nothing Nothing Nothing
802+mkAggregateSearch query mkSearchAggs = Search query Nothing Nothing (Just mkSearchAggs) Nothing False (From 0) (Size 0) SearchTypeQueryThenFetch Nothing Nothing
1150803
1151804-- | 'mkHighlightSearch' is a helper function that defaults everything in a 'Search' except for
1152805-- the 'Query' and the 'Aggregation'.
@@ -1155,7 +808,7 @@ mkAggregateSearch query mkSearchAggs = Search query Nothing Nothing (Just mkSear
1155808-- >>> let testHighlight = Highlights Nothing [FieldHighlight (FieldName "message") Nothing]
1156809-- >>> let search = mkHighlightSearch (Just query) testHighlight
1157810mkHighlightSearch :: Maybe Query -> Highlights -> Search
1158−mkHighlightSearch query searchHighlights = Search query Nothing Nothing Nothing (Just searchHighlights) False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing Nothing Nothing Nothing
811+mkHighlightSearch query searchHighlights = Search query Nothing Nothing Nothing (Just searchHighlights) False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing
1159812
1160813-- | 'pageSearch' is a helper function that takes a search and assigns the from
1161814-- and size fields for the search. The from parameter defines the offset
@@ -1175,7 +828,7 @@ pageSearch :: From -- ^ The result offset
1175828pageSearch resultOffset pageSize search = search { from = resultOffset, size = pageSize }
1176829
1177830parseUrl' :: MonadThrow m => Text -> m Request
1178−parseUrl' t = parseRequest (URI.escapeURIString URI.isAllowedInURI (T.unpack t))
831+parseUrl' t = parseUrl (URI.escapeURIString URI.isAllowedInURI (T.unpack t))
1179832
1180833-- | Was there an optimistic concurrency control conflict when
1181834-- indexing a document?
@@ -1201,8 +854,3 @@ basicAuthHook :: Monad m => EsUsername -> EsPassword -> Request -> m Request
1201854basicAuthHook (EsUsername u) (EsPassword p) = return . applyBasicAuth u' p'
1202855 where u' = T.encodeUtf8 u
1203856 p' = T.encodeUtf8 p
1204−
1205−
1206−boolQP :: Bool -> Text
1207−boolQP True = "true"
1208−boolQP False = "false"
src/Database/Bloodhound/Common/Script.hsdeleted−220
@@ -1,220 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−
4−module Database.Bloodhound.Common.Script where
5−
6−import Bloodhound.Import
7−
8−import qualified Data.HashMap.Strict as HM
9−
10−import Database.Bloodhound.Internal.Newtypes
11−
12−newtype ScriptFields =
13− ScriptFields (HM.HashMap ScriptFieldName ScriptFieldValue)
14− deriving (Eq, Show)
15−
16−type ScriptFieldName = Text
17−type ScriptFieldValue = Value
18−
19−data Script =
20− Script { scriptLanguage :: Maybe ScriptLanguage
21− , scriptInline :: Maybe ScriptInline
22− , scriptStored :: Maybe ScriptId
23− , scriptParams :: Maybe ScriptParams
24− } deriving (Eq, Show)
25−
26−newtype ScriptLanguage =
27− ScriptLanguage Text deriving (Eq, Show, FromJSON, ToJSON)
28−
29−newtype ScriptInline =
30− ScriptInline Text deriving (Eq, Show, FromJSON, ToJSON)
31−
32−newtype ScriptId =
33− ScriptId Text deriving (Eq, Show, FromJSON, ToJSON)
34−
35−newtype ScriptParams =
36− ScriptParams (HM.HashMap ScriptParamName ScriptParamValue)
37− deriving (Eq, Show)
38−
39−type ScriptParamName = Text
40−type ScriptParamValue = Value
41−
42−data BoostMode =
43− BoostModeMultiply
44− | BoostModeReplace
45− | BoostModeSum
46− | BoostModeAvg
47− | BoostModeMax
48− | BoostModeMin deriving (Eq, Show)
49−
50−data ScoreMode =
51− ScoreModeMultiply
52− | ScoreModeSum
53− | ScoreModeAvg
54− | ScoreModeFirst
55− | ScoreModeMax
56− | ScoreModeMin deriving (Eq, Show)
57−
58−data FunctionScoreFunction =
59− FunctionScoreFunctionScript Script
60− | FunctionScoreFunctionRandom Seed
61− | FunctionScoreFunctionFieldValueFactor FieldValueFactor
62− deriving (Eq, Show)
63−
64−newtype Weight =
65− Weight Float deriving (Eq, Show, FromJSON, ToJSON)
66−
67−newtype Seed =
68− Seed Float deriving (Eq, Show, FromJSON, ToJSON)
69−
70−data FieldValueFactor =
71− FieldValueFactor { fieldValueFactorField :: FieldName
72− , fieldValueFactor :: Maybe Factor
73− , fieldValueFactorModifier :: Maybe FactorModifier
74− , fieldValueFactorMissing :: Maybe FactorMissingFieldValue
75− } deriving (Eq, Show)
76−
77−newtype Factor =
78− Factor Float deriving (Eq, Show, FromJSON, ToJSON)
79−
80−data FactorModifier =
81− FactorModifierNone
82− | FactorModifierLog
83− | FactorModifierLog1p
84− | FactorModifierLog2p
85− | FactorModifierLn
86− | FactorModifierLn1p
87− | FactorModifierLn2p
88− | FactorModifierSquare
89− | FactorModifierSqrt
90− | FactorModifierReciprocal deriving (Eq, Show)
91−
92−newtype FactorMissingFieldValue =
93− FactorMissingFieldValue Float deriving (Eq, Show, FromJSON, ToJSON)
94−
95−instance ToJSON BoostMode where
96− toJSON BoostModeMultiply = "multiply"
97− toJSON BoostModeReplace = "replace"
98− toJSON BoostModeSum = "sum"
99− toJSON BoostModeAvg = "avg"
100− toJSON BoostModeMax = "max"
101− toJSON BoostModeMin = "min"
102−
103−instance FromJSON BoostMode where
104− parseJSON = withText "BoostMode" parse
105− where parse "multiply" = pure BoostModeMultiply
106− parse "replace" = pure BoostModeReplace
107− parse "sum" = pure BoostModeSum
108− parse "avg" = pure BoostModeAvg
109− parse "max" = pure BoostModeMax
110− parse "min" = pure BoostModeMin
111− parse bm = fail ("Unexpected BoostMode: " <> show bm)
112−
113−instance ToJSON ScoreMode where
114− toJSON ScoreModeMultiply = "multiply"
115− toJSON ScoreModeSum = "sum"
116− toJSON ScoreModeFirst = "first"
117− toJSON ScoreModeAvg = "avg"
118− toJSON ScoreModeMax = "max"
119− toJSON ScoreModeMin = "min"
120−
121−instance FromJSON ScoreMode where
122− parseJSON = withText "ScoreMode" parse
123− where parse "multiply" = pure ScoreModeMultiply
124− parse "sum" = pure ScoreModeSum
125− parse "first" = pure ScoreModeFirst
126− parse "avg" = pure ScoreModeAvg
127− parse "max" = pure ScoreModeMax
128− parse "min" = pure ScoreModeMin
129− parse sm = fail ("Unexpected ScoreMode: " <> show sm)
130−
131−functionScoreFunctionPair :: FunctionScoreFunction -> (Text, Value)
132−functionScoreFunctionPair (FunctionScoreFunctionScript functionScoreScript) =
133− ("script_score", toJSON functionScoreScript)
134−functionScoreFunctionPair (FunctionScoreFunctionRandom seed) =
135− ("random_score", omitNulls [ "seed" .= seed ])
136−functionScoreFunctionPair (FunctionScoreFunctionFieldValueFactor fvf) =
137− ("field_value_factor", toJSON fvf)
138−
139−parseFunctionScoreFunction :: Object -> Parser FunctionScoreFunction
140−parseFunctionScoreFunction o =
141− singleScript `taggedWith` "script_score"
142− <|> singleRandom `taggedWith` "random_score"
143− <|> singleFieldValueFactor `taggedWith` "field_value_factor"
144− where taggedWith parser k = parser =<< o .: k
145− singleScript = pure . FunctionScoreFunctionScript
146− singleRandom o' = FunctionScoreFunctionRandom <$> o' .: "seed"
147− singleFieldValueFactor = pure . FunctionScoreFunctionFieldValueFactor
148−
149−instance ToJSON ScriptFields where
150− toJSON (ScriptFields x) = Object x
151−
152−instance FromJSON ScriptFields where
153− parseJSON (Object o) = pure (ScriptFields o)
154− parseJSON _ = fail "error parsing ScriptFields"
155−
156−instance ToJSON Script where
157− toJSON (Script lang inline stored params) =
158− object [ "script" .= omitNulls base ]
159− where base = [ "lang" .= lang
160− , "inline" .= inline
161− , "stored" .= stored
162− , "params" .= params ]
163−
164−instance FromJSON Script where
165− parseJSON = withObject "Script" parse
166− where parse o = o .: "script" >>= \o' ->
167− Script
168− <$> o' .:? "lang"
169− <*> o' .:? "inline"
170− <*> o' .:? "stored"
171− <*> o' .:? "params"
172−
173−instance ToJSON ScriptParams where
174− toJSON (ScriptParams x) = Object x
175−
176−instance FromJSON ScriptParams where
177− parseJSON (Object o) = pure (ScriptParams o)
178− parseJSON _ = fail "error parsing ScriptParams"
179−
180−instance ToJSON FieldValueFactor where
181− toJSON (FieldValueFactor field factor modifier missing) =
182− omitNulls base
183− where base = [ "field" .= field
184− , "factor" .= factor
185− , "modifier" .= modifier
186− , "missing" .= missing ]
187−
188−instance FromJSON FieldValueFactor where
189− parseJSON = withObject "FieldValueFactor" parse
190− where parse o = FieldValueFactor
191− <$> o .: "field"
192− <*> o .:? "factor"
193− <*> o .:? "modifier"
194− <*> o .:? "missing"
195−
196−instance ToJSON FactorModifier where
197− toJSON FactorModifierNone = "none"
198− toJSON FactorModifierLog = "log"
199− toJSON FactorModifierLog1p = "log1p"
200− toJSON FactorModifierLog2p = "log2p"
201− toJSON FactorModifierLn = "ln"
202− toJSON FactorModifierLn1p = "ln1p"
203− toJSON FactorModifierLn2p = "ln2p"
204− toJSON FactorModifierSquare = "square"
205− toJSON FactorModifierSqrt = "sqrt"
206− toJSON FactorModifierReciprocal = "reciprocal"
207−
208−instance FromJSON FactorModifier where
209− parseJSON = withText "FactorModifier" parse
210− where parse "none" = pure FactorModifierNone
211− parse "log" = pure FactorModifierLog
212− parse "log1p" = pure FactorModifierLog1p
213− parse "log2p" = pure FactorModifierLog2p
214− parse "ln" = pure FactorModifierLn
215− parse "ln1p" = pure FactorModifierLn1p
216− parse "ln2p" = pure FactorModifierLn2p
217− parse "square" = pure FactorModifierSquare
218− parse "sqrt" = pure FactorModifierSqrt
219− parse "reciprocal" = pure FactorModifierReciprocal
220− parse fm = fail ("Unexpected FactorModifier: " <> show fm)
src/Database/Bloodhound/Internal/Aggregation.hsdeleted−479
@@ -1,479 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
4−
5−module Database.Bloodhound.Internal.Aggregation where
6−
7−import Bloodhound.Import
8−
9−import qualified Data.Aeson as Aeson
10−import qualified Data.HashMap.Strict as HM
11−import qualified Data.Map.Strict as M
12−import qualified Data.Text as T
13−
14−import Database.Bloodhound.Internal.Client
15−import Database.Bloodhound.Internal.Highlight (HitHighlight)
16−import Database.Bloodhound.Internal.Newtypes
17−import Database.Bloodhound.Internal.Query
18−import Database.Bloodhound.Internal.Sort
19−
20−type Aggregations = M.Map Text Aggregation
21−
22−emptyAggregations :: Aggregations
23−emptyAggregations = M.empty
24−
25−mkAggregations :: Text -> Aggregation -> Aggregations
26−mkAggregations name aggregation = M.insert name aggregation emptyAggregations
27−
28−data Aggregation = TermsAgg TermsAggregation
29− | CardinalityAgg CardinalityAggregation
30− | MaxAgg MaxAggregation
31− | DateHistogramAgg DateHistogramAggregation
32− | ValueCountAgg ValueCountAggregation
33− | FilterAgg FilterAggregation
34− | DateRangeAgg DateRangeAggregation
35− | MissingAgg MissingAggregation
36− | TopHitsAgg TopHitsAggregation
37− | StatsAgg StatisticsAggregation
38− deriving (Eq, Show)
39−
40−instance ToJSON Aggregation where
41− toJSON (TermsAgg (TermsAggregation term include exclude order minDocCount size shardSize collectMode executionHint termAggs)) =
42− omitNulls ["terms" .= omitNulls [ toJSON' term,
43− "include" .= include,
44− "exclude" .= exclude,
45− "order" .= order,
46− "min_doc_count" .= minDocCount,
47− "size" .= size,
48− "shard_size" .= shardSize,
49− "collect_mode" .= collectMode,
50− "execution_hint" .= executionHint
51− ],
52− "aggs" .= termAggs ]
53− where
54− toJSON' x = case x of { Left y -> "field" .= y; Right y -> "script" .= y }
55−
56− toJSON (CardinalityAgg (CardinalityAggregation field precisionThreshold)) =
57− object ["cardinality" .= omitNulls [ "field" .= field,
58− "precisionThreshold" .= precisionThreshold
59− ]
60− ]
61−
62− toJSON (MaxAgg (MaxAggregation field)) =
63− object ["max" .= omitNulls [ "field" .= field ]]
64−
65− toJSON (DateHistogramAgg
66− (DateHistogramAggregation field interval format
67− preZone postZone preOffset postOffset dateHistoAggs)) =
68− omitNulls ["date_histogram" .= omitNulls [ "field" .= field,
69− "interval" .= interval,
70− "format" .= format,
71− "pre_zone" .= preZone,
72− "post_zone" .= postZone,
73− "pre_offset" .= preOffset,
74− "post_offset" .= postOffset
75− ],
76− "aggs" .= dateHistoAggs ]
77− toJSON (ValueCountAgg a) = object ["value_count" .= v]
78− where v = case a of
79− (FieldValueCount (FieldName n)) ->
80− object ["field" .= n]
81− (ScriptValueCount s) ->
82− object ["script" .= s]
83− toJSON (FilterAgg (FilterAggregation filt ags)) =
84− omitNulls [ "filter" .= filt
85− , "aggs" .= ags]
86− toJSON (DateRangeAgg a) = object [ "date_range" .= a
87− ]
88− toJSON (MissingAgg (MissingAggregation{..})) =
89− object ["missing" .= object ["field" .= maField]]
90−
91− toJSON (TopHitsAgg (TopHitsAggregation mfrom msize msort)) =
92− omitNulls ["top_hits" .= omitNulls [ "size" .= msize
93− , "from" .= mfrom
94− , "sort" .= msort
95− ]
96− ]
97−
98− toJSON (StatsAgg (StatisticsAggregation typ field)) =
99− object [stType .= omitNulls [ "field" .= field ]]
100− where
101− stType | typ == Basic = "stats"
102− | otherwise = "extended_stats"
103−
104−data TopHitsAggregation = TopHitsAggregation
105− { taFrom :: Maybe From
106− , taSize :: Maybe Size
107− , taSort :: Maybe Sort
108− } deriving (Eq, Show)
109−
110−data MissingAggregation = MissingAggregation
111− { maField :: Text
112− } deriving (Eq, Show)
113−
114−data TermsAggregation = TermsAggregation
115− { term :: Either Text Text
116− , termInclude :: Maybe TermInclusion
117− , termExclude :: Maybe TermInclusion
118− , termOrder :: Maybe TermOrder
119− , termMinDocCount :: Maybe Int
120− , termSize :: Maybe Int
121− , termShardSize :: Maybe Int
122− , termCollectMode :: Maybe CollectionMode
123− , termExecutionHint :: Maybe ExecutionHint
124− , termAggs :: Maybe Aggregations
125− } deriving (Eq, Show)
126−
127−data CardinalityAggregation = CardinalityAggregation
128− { cardinalityField :: FieldName,
129− precisionThreshold :: Maybe Int
130− } deriving (Eq, Show)
131−
132−data MaxAggregation = MaxAggregation
133− { maxField :: FieldName
134− } deriving (Eq, Show)
135−
136−data DateHistogramAggregation = DateHistogramAggregation
137− { dateField :: FieldName
138− , dateInterval :: Interval
139− , dateFormat :: Maybe Text
140− -- pre and post deprecated in 1.5
141− , datePreZone :: Maybe Text
142− , datePostZone :: Maybe Text
143− , datePreOffset :: Maybe Text
144− , datePostOffset :: Maybe Text
145− , dateAggs :: Maybe Aggregations
146− } deriving (Eq, Show)
147−
148−data DateRangeAggregation = DateRangeAggregation
149− { draField :: FieldName
150− , draFormat :: Maybe Text
151− , draRanges :: NonEmpty DateRangeAggRange
152− } deriving (Eq, Show)
153−
154−instance ToJSON DateRangeAggregation where
155− toJSON DateRangeAggregation {..} =
156− omitNulls [ "field" .= draField
157− , "format" .= draFormat
158− , "ranges" .= toList draRanges
159− ]
160−
161−data DateRangeAggRange =
162− DateRangeFrom DateMathExpr
163− | DateRangeTo DateMathExpr
164− | DateRangeFromAndTo DateMathExpr DateMathExpr
165− deriving (Eq, Show)
166−
167−instance ToJSON DateRangeAggRange where
168− toJSON (DateRangeFrom e) = object [ "from" .= e ]
169− toJSON (DateRangeTo e) = object [ "to" .= e ]
170− toJSON (DateRangeFromAndTo f t) = object [ "from" .= f, "to" .= t ]
171−
172−-- | See <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html> for more information.
173−data ValueCountAggregation =
174− FieldValueCount FieldName
175− | ScriptValueCount Script
176− deriving (Eq, Show)
177−
178−-- | Single-bucket filter aggregations. See <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html#search-aggregations-bucket-filter-aggregation> for more information.
179−data FilterAggregation = FilterAggregation
180− { faFilter :: Filter
181− , faAggs :: Maybe Aggregations }
182− deriving (Eq, Show)
183−
184−data StatisticsAggregation = StatisticsAggregation
185− { statsType :: StatsType
186− , statsField :: FieldName }
187− deriving (Eq, Show)
188−
189−data StatsType
190− = Basic
191− | Extended
192− deriving (Eq, Show)
193−
194−mkTermsAggregation :: Text -> TermsAggregation
195−mkTermsAggregation t =
196− TermsAggregation (Left t)
197− Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing
198−
199−mkTermsScriptAggregation :: Text -> TermsAggregation
200−mkTermsScriptAggregation t = TermsAggregation (Right t) Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing
201−
202−mkDateHistogram :: FieldName -> Interval -> DateHistogramAggregation
203−mkDateHistogram t i = DateHistogramAggregation t i Nothing Nothing Nothing Nothing Nothing Nothing
204−
205−mkCardinalityAggregation :: FieldName -> CardinalityAggregation
206−mkCardinalityAggregation t = CardinalityAggregation t Nothing
207−
208−mkStatsAggregation :: FieldName -> StatisticsAggregation
209−mkStatsAggregation = StatisticsAggregation Basic
210−
211−mkExtendedStatsAggregation :: FieldName -> StatisticsAggregation
212−mkExtendedStatsAggregation = StatisticsAggregation Extended
213−
214−type AggregationResults = M.Map Text Value
215−
216−class BucketAggregation a where
217− key :: a -> BucketValue
218− docCount :: a -> Int
219− aggs :: a -> Maybe AggregationResults
220−
221−data Bucket a = Bucket
222− { buckets :: [a]
223− } deriving (Read, Show)
224−
225−instance (FromJSON a) => FromJSON (Bucket a) where
226− parseJSON (Object v) = Bucket <$>
227− v .: "buckets"
228− parseJSON _ = mempty
229−
230−data BucketValue = TextValue Text
231− | ScientificValue Scientific
232− | BoolValue Bool deriving (Read, Show)
233−
234−instance FromJSON BucketValue where
235− parseJSON (String t) = return $ TextValue t
236− parseJSON (Number s) = return $ ScientificValue s
237− parseJSON (Bool b) = return $ BoolValue b
238− parseJSON _ = mempty
239−
240−data TermInclusion = TermInclusion Text
241− | TermPattern Text Text deriving (Eq, Show)
242−
243−instance ToJSON TermInclusion where
244− toJSON (TermInclusion x) = toJSON x
245− toJSON (TermPattern pattern flags) =
246− omitNulls [ "pattern" .= pattern
247− , "flags" .= flags]
248−
249−data TermOrder = TermOrder
250− { termSortField :: Text
251− , termSortOrder :: SortOrder } deriving (Eq, Show)
252−
253−instance ToJSON TermOrder where
254− toJSON (TermOrder termSortField termSortOrder) =
255− object [termSortField .= termSortOrder]
256−
257−data CollectionMode = BreadthFirst
258− | DepthFirst deriving (Eq, Show)
259−
260−instance ToJSON CollectionMode where
261− toJSON BreadthFirst = "breadth_first"
262− toJSON DepthFirst = "depth_first"
263−
264−data ExecutionHint = Ordinals
265− | GlobalOrdinals
266− | GlobalOrdinalsHash
267− | GlobalOrdinalsLowCardinality
268− | Map deriving (Eq, Show)
269−
270−instance ToJSON ExecutionHint where
271− toJSON Ordinals = "ordinals"
272− toJSON GlobalOrdinals = "global_ordinals"
273− toJSON GlobalOrdinalsHash = "global_ordinals_hash"
274− toJSON GlobalOrdinalsLowCardinality = "global_ordinals_low_cardinality"
275− toJSON Map = "map"
276−
277−-- | See <https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#date-math> for more information.
278−data DateMathExpr =
279− DateMathExpr DateMathAnchor [DateMathModifier]
280− deriving (Eq, Show)
281−
282−instance ToJSON DateMathExpr where
283− toJSON (DateMathExpr a mods) = String (fmtA a <> mconcat (fmtMod <$> mods))
284− where fmtA DMNow = "now"
285− fmtA (DMDate date) = (T.pack $ showGregorian date) <> "||"
286− fmtMod (AddTime n u) = "+" <> showText n <> fmtU u
287− fmtMod (SubtractTime n u) = "-" <> showText n <> fmtU u
288− fmtMod (RoundDownTo u) = "/" <> fmtU u
289− fmtU DMYear = "y"
290− fmtU DMMonth = "M"
291− fmtU DMWeek = "w"
292− fmtU DMDay = "d"
293− fmtU DMHour = "h"
294− fmtU DMMinute = "m"
295− fmtU DMSecond = "s"
296−
297−-- | Starting point for a date range. This along with the 'DateMathModifiers' gets you the date ES will start from.
298−data DateMathAnchor =
299− DMNow
300− | DMDate Day
301− deriving (Eq, Show)
302−
303−data DateMathModifier =
304− AddTime Int DateMathUnit
305− | SubtractTime Int DateMathUnit
306− | RoundDownTo DateMathUnit
307− deriving (Eq, Show)
308−
309−data DateMathUnit =
310− DMYear
311− | DMMonth
312− | DMWeek
313− | DMDay
314− | DMHour
315− | DMMinute
316− | DMSecond
317− deriving (Eq, Show)
318−
319−data TermsResult = TermsResult
320− { termKey :: BucketValue
321− , termsDocCount :: Int
322− , termsAggs :: Maybe AggregationResults
323− } deriving (Read, Show)
324−
325−instance FromJSON TermsResult where
326− parseJSON (Object v) = TermsResult <$>
327− v .: "key" <*>
328− v .: "doc_count" <*>
329− (pure $ getNamedSubAgg v ["key", "doc_count"])
330− parseJSON _ = mempty
331−
332−instance BucketAggregation TermsResult where
333− key = termKey
334− docCount = termsDocCount
335− aggs = termsAggs
336−
337−data DateHistogramResult = DateHistogramResult
338− { dateKey :: Int
339− , dateKeyStr :: Maybe Text
340− , dateDocCount :: Int
341− , dateHistogramAggs :: Maybe AggregationResults
342− } deriving (Show)
343−
344−instance FromJSON DateHistogramResult where
345− parseJSON (Object v) = DateHistogramResult <$>
346− v .: "key" <*>
347− v .:? "key_as_string" <*>
348− v .: "doc_count" <*>
349− (pure $ getNamedSubAgg v [ "key"
350− , "doc_count"
351− , "key_as_string"
352− ]
353− )
354− parseJSON _ = mempty
355−
356−instance BucketAggregation DateHistogramResult where
357− key = TextValue . showText . dateKey
358− docCount = dateDocCount
359− aggs = dateHistogramAggs
360−
361−data DateRangeResult = DateRangeResult
362− { dateRangeKey :: Text
363− , dateRangeFrom :: Maybe UTCTime
364− , dateRangeFromAsString :: Maybe Text
365− , dateRangeTo :: Maybe UTCTime
366− , dateRangeToAsString :: Maybe Text
367− , dateRangeDocCount :: Int
368− , dateRangeAggs :: Maybe AggregationResults
369− } deriving (Eq, Show)
370−
371−instance FromJSON DateRangeResult where
372− parseJSON = withObject "DateRangeResult" parse
373− where parse v = DateRangeResult <$>
374− v .: "key" <*>
375− (fmap posixMS <$> v .:? "from") <*>
376− v .:? "from_as_string" <*>
377− (fmap posixMS <$> v .:? "to") <*>
378− v .:? "to_as_string" <*>
379− v .: "doc_count" <*>
380− (pure $ getNamedSubAgg v [ "key"
381− , "from"
382− , "from_as_string"
383− , "to"
384− , "to_as_string"
385− , "doc_count"
386− ]
387− )
388−
389−instance BucketAggregation DateRangeResult where
390− key = TextValue . dateRangeKey
391− docCount = dateRangeDocCount
392− aggs = dateRangeAggs
393−
394−toTerms :: Text -> AggregationResults -> Maybe (Bucket TermsResult)
395−toTerms = toAggResult
396−
397−toDateHistogram :: Text -> AggregationResults -> Maybe (Bucket DateHistogramResult)
398−toDateHistogram = toAggResult
399−
400−toMissing :: Text -> AggregationResults -> Maybe MissingResult
401−toMissing = toAggResult
402−
403−toTopHits :: (FromJSON a) => Text -> AggregationResults -> Maybe (TopHitResult a)
404−toTopHits = toAggResult
405−
406−toAggResult :: (FromJSON a) => Text -> AggregationResults -> Maybe a
407−toAggResult t a = M.lookup t a >>= deserialize
408− where deserialize = parseMaybe parseJSON
409−
410−-- Try to get an AggregationResults when we don't know the
411−-- field name. We filter out the known keys to try to minimize the noise.
412−getNamedSubAgg :: Object -> [Text] -> Maybe AggregationResults
413−getNamedSubAgg o knownKeys = maggRes
414− where unknownKeys = HM.filterWithKey (\k _ -> k `notElem` knownKeys) o
415− maggRes
416− | HM.null unknownKeys = Nothing
417− | otherwise = Just . M.fromList $ HM.toList unknownKeys
418−
419−data MissingResult = MissingResult
420− { missingDocCount :: Int
421− } deriving (Show)
422−
423−instance FromJSON MissingResult where
424− parseJSON = withObject "MissingResult" parse
425− where parse v = MissingResult <$> v .: "doc_count"
426−
427−data TopHitResult a = TopHitResult
428− { tarHits :: (SearchHits a)
429− } deriving Show
430−
431−instance (FromJSON a) => FromJSON (TopHitResult a) where
432− parseJSON (Object v) = TopHitResult <$>
433− v .: "hits"
434− parseJSON _ = fail "Failure in FromJSON (TopHitResult a)"
435−
436−data SearchHits a =
437− SearchHits { hitsTotal :: Int
438− , maxScore :: Score
439− , hits :: [Hit a] } deriving (Eq, Show)
440−
441−
442−instance (FromJSON a) => FromJSON (SearchHits a) where
443− parseJSON (Object v) = SearchHits <$>
444− v .: "total" <*>
445− v .: "max_score" <*>
446− v .: "hits"
447− parseJSON _ = empty
448−
449−instance Semigroup (SearchHits a) where
450− (SearchHits ta ma ha) <> (SearchHits tb mb hb) =
451− SearchHits (ta + tb) (max ma mb) (ha <> hb)
452−
453−instance Monoid (SearchHits a) where
454− mempty = SearchHits 0 Nothing mempty
455− mappend = (<>)
456−
457−type SearchAfterKey = [Aeson.Value]
458−
459−data Hit a =
460− Hit { hitIndex :: IndexName
461− , hitType :: MappingName
462− , hitDocId :: DocId
463− , hitScore :: Score
464− , hitSource :: Maybe a
465− , hitSort :: Maybe SearchAfterKey
466− , hitFields :: Maybe HitFields
467− , hitHighlight :: Maybe HitHighlight } deriving (Eq, Show)
468−
469−instance (FromJSON a) => FromJSON (Hit a) where
470− parseJSON (Object v) = Hit <$>
471− v .: "_index" <*>
472− v .: "_type" <*>
473− v .: "_id" <*>
474− v .: "_score" <*>
475− v .:? "_source" <*>
476− v .:? "sort" <*>
477− v .:? "fields" <*>
478− v .:? "highlight"
479− parseJSON _ = empty
src/Database/Bloodhound/Internal/Analysis.hsdeleted−379
@@ -1,379 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−
4−module Database.Bloodhound.Internal.Analysis where
5−
6−import Bloodhound.Import
7−
8−import qualified Data.Map.Strict as M
9−import qualified Data.Text as T
10−
11−import Database.Bloodhound.Internal.Newtypes
12−import Database.Bloodhound.Internal.StringlyTyped
13−
14−data Analysis = Analysis
15− { analysisAnalyzer :: M.Map Text AnalyzerDefinition
16− , analysisTokenizer :: M.Map Text TokenizerDefinition
17− , analysisTokenFilter :: M.Map Text TokenFilterDefinition
18− , analysisCharFilter :: M.Map Text CharFilterDefinition
19− } deriving (Eq, Show)
20−
21−instance ToJSON Analysis where
22− toJSON (Analysis analyzer tokenizer tokenFilter charFilter) = object
23− [ "analyzer" .= analyzer
24− , "tokenizer" .= tokenizer
25− , "filter" .= tokenFilter
26− , "char_filter" .= charFilter
27− ]
28−
29−instance FromJSON Analysis where
30− parseJSON = withObject "Analysis" $ \m -> Analysis
31− <$> m .: "analyzer"
32− <*> m .:? "tokenizer" .!= M.empty
33− <*> m .:? "filter" .!= M.empty
34− <*> m .:? "char_filter" .!= M.empty
35−
36−newtype Tokenizer =
37− Tokenizer Text
38− deriving (Eq, Show, ToJSON, FromJSON)
39−
40−data AnalyzerDefinition = AnalyzerDefinition
41− { analyzerDefinitionTokenizer :: Maybe Tokenizer
42− , analyzerDefinitionFilter :: [TokenFilter]
43− , analyzerDefinitionCharFilter :: [CharFilter]
44− } deriving (Eq,Show)
45−
46−instance ToJSON AnalyzerDefinition where
47− toJSON (AnalyzerDefinition tokenizer tokenFilter charFilter) =
48− object $ catMaybes
49− [ fmap ("tokenizer" .=) tokenizer
50− , Just $ "filter" .= tokenFilter
51− , Just $ "char_filter" .= charFilter
52− ]
53−
54−instance FromJSON AnalyzerDefinition where
55− parseJSON = withObject "AnalyzerDefinition" $ \m -> AnalyzerDefinition
56− <$> m .:? "tokenizer"
57− <*> m .:? "filter" .!= []
58− <*> m .:? "char_filter" .!= []
59−
60−-- | Character filters are used to preprocess the stream of characters
61−-- before it is passed to the tokenizer.
62−data CharFilterDefinition
63− = CharFilterDefinitionMapping (M.Map Text Text)
64− | CharFilterDefinitionPatternReplace
65− { charFilterDefinitionPatternReplacePattern :: Text
66− , charFilterDefinitionPatternReplaceReplacement :: Text
67− , charFilterDefinitionPatternReplaceFlags :: Maybe Text
68− }
69− deriving (Eq, Show)
70−
71−instance ToJSON CharFilterDefinition where
72− toJSON (CharFilterDefinitionMapping ms) = object
73− [ "type" .= ("mapping" :: Text)
74− , "mappings" .= [a <> " => " <> b | (a, b) <- M.toList ms] ]
75− toJSON (CharFilterDefinitionPatternReplace pat repl flags) = object $
76− [ "type" .= ("pattern_replace" :: Text)
77− , "pattern" .= pat
78− , "replacement" .= repl
79− ] ++ maybe [] (\f -> ["flags" .= f]) flags
80−
81−instance FromJSON CharFilterDefinition where
82− parseJSON = withObject "CharFilterDefinition" $ \m -> do
83− t <- m .: "type"
84− case (t :: Text) of
85− "mapping" -> CharFilterDefinitionMapping . M.fromList <$> ms
86− where
87− ms = m .: "mappings" >>= mapM parseMapping
88− parseMapping kv = case T.splitOn "=>" kv of
89− (k:vs) -> pure (T.strip k, T.strip $ T.concat vs)
90− _ -> fail "mapping is not of the format key => value"
91− "pattern_replace" -> CharFilterDefinitionPatternReplace
92− <$> m .: "pattern" <*> m .: "replacement" <*> m .:? "flags"
93− _ -> fail ("unrecognized character filter type: " ++ T.unpack t)
94−
95−newtype TokenizerDefinition =
96− TokenizerDefinitionNgram Ngram
97− deriving (Eq,Show)
98−
99−instance ToJSON TokenizerDefinition where
100− toJSON x = case x of
101− TokenizerDefinitionNgram (Ngram minGram maxGram tokenChars) -> object
102− [ "type" .= ("ngram" :: Text)
103− , "min_gram" .= minGram
104− , "max_gram" .= maxGram
105− , "token_chars" .= tokenChars
106− ]
107−
108−instance FromJSON TokenizerDefinition where
109− parseJSON = withObject "TokenizerDefinition" $ \m -> do
110− typ <- m .: "type" :: Parser Text
111− case typ of
112− "ngram" -> fmap TokenizerDefinitionNgram $ Ngram
113− <$> fmap unStringlyTypedInt (m .: "min_gram")
114− <*> fmap unStringlyTypedInt (m .: "max_gram")
115− <*> m .: "token_chars"
116− _ -> fail "invalid TokenizerDefinition"
117−
118−data Ngram = Ngram
119− { ngramMinGram :: Int
120− , ngramMaxGram :: Int
121− , ngramTokenChars :: [TokenChar]
122− } deriving (Eq,Show)
123−
124−data TokenChar =
125− TokenLetter
126− | TokenDigit
127− | TokenWhitespace
128− | TokenPunctuation
129− | TokenSymbol
130− deriving (Eq,Show)
131−
132−instance ToJSON TokenChar where
133− toJSON t = String $ case t of
134− TokenLetter -> "letter"
135− TokenDigit -> "digit"
136− TokenWhitespace -> "whitespace"
137− TokenPunctuation -> "punctuation"
138− TokenSymbol -> "symbol"
139−
140−instance FromJSON TokenChar where
141− parseJSON = withText "TokenChar" $ \t -> case t of
142− "letter" -> return TokenLetter
143− "digit" -> return TokenDigit
144− "whitespace" -> return TokenWhitespace
145− "punctuation" -> return TokenPunctuation
146− "symbol" -> return TokenSymbol
147− _ -> fail "invalid TokenChar"
148−
149−-- | Token filters are used to create custom analyzers.
150−data TokenFilterDefinition
151− = TokenFilterDefinitionLowercase (Maybe Language)
152− | TokenFilterDefinitionUppercase (Maybe Language)
153− | TokenFilterDefinitionApostrophe
154− | TokenFilterDefinitionReverse
155− | TokenFilterDefinitionSnowball Language
156− | TokenFilterDefinitionShingle Shingle
157− | TokenFilterDefinitionStemmer Language
158− | TokenFilterDefinitionStop (Either Language [StopWord])
159− deriving (Eq, Show)
160−
161−instance ToJSON TokenFilterDefinition where
162− toJSON x = case x of
163− TokenFilterDefinitionLowercase mlang -> object $ catMaybes
164− [ Just $ "type" .= ("lowercase" :: Text)
165− , fmap (\lang -> "language" .= languageToText lang) mlang
166− ]
167− TokenFilterDefinitionUppercase mlang -> object $ catMaybes
168− [ Just $ "type" .= ("uppercase" :: Text)
169− , fmap (\lang -> "language" .= languageToText lang) mlang
170− ]
171− TokenFilterDefinitionApostrophe -> object
172− [ "type" .= ("apostrophe" :: Text)
173− ]
174− TokenFilterDefinitionReverse -> object
175− [ "type" .= ("reverse" :: Text)
176− ]
177− TokenFilterDefinitionSnowball lang -> object
178− [ "type" .= ("snowball" :: Text)
179− , "language" .= languageToText lang
180− ]
181− TokenFilterDefinitionShingle s -> object
182− [ "type" .= ("shingle" :: Text)
183− , "max_shingle_size" .= shingleMaxSize s
184− , "min_shingle_size" .= shingleMinSize s
185− , "output_unigrams" .= shingleOutputUnigrams s
186− , "output_unigrams_if_no_shingles" .= shingleOutputUnigramsIfNoShingles s
187− , "token_separator" .= shingleTokenSeparator s
188− , "filler_token" .= shingleFillerToken s
189− ]
190− TokenFilterDefinitionStemmer lang -> object
191− [ "type" .= ("stemmer" :: Text)
192− , "language" .= languageToText lang
193− ]
194− TokenFilterDefinitionStop stop -> object
195− [ "type" .= ("stop" :: Text)
196− , "stopwords" .= case stop of
197− Left lang -> String $ "_" <> languageToText lang <> "_"
198− Right stops -> toJSON stops
199− ]
200−
201−instance FromJSON TokenFilterDefinition where
202− parseJSON = withObject "TokenFilterDefinition" $ \m -> do
203− t <- m .: "type"
204− case (t :: Text) of
205− "reverse" -> return TokenFilterDefinitionReverse
206− "apostrophe" -> return TokenFilterDefinitionApostrophe
207− "lowercase" -> TokenFilterDefinitionLowercase
208− <$> m .:? "language"
209− "uppercase" -> TokenFilterDefinitionUppercase
210− <$> m .:? "language"
211− "snowball" -> TokenFilterDefinitionSnowball
212− <$> m .: "language"
213− "shingle" -> fmap TokenFilterDefinitionShingle $ Shingle
214− <$> (fmap.fmap) unStringlyTypedInt (m .:? "max_shingle_size") .!= 2
215− <*> (fmap.fmap) unStringlyTypedInt (m .:? "min_shingle_size") .!= 2
216− <*> (fmap.fmap) unStringlyTypedBool (m .:? "output_unigrams") .!= True
217− <*> (fmap.fmap) unStringlyTypedBool (m .:? "output_unigrams_if_no_shingles") .!= False
218− <*> m .:? "token_separator" .!= " "
219− <*> m .:? "filler_token" .!= "_"
220− "stemmer" -> TokenFilterDefinitionStemmer
221− <$> m .: "language"
222− "stop" -> do
223− stop <- m .: "stopwords"
224− stop' <- case stop of
225− String lang ->
226− fmap Left
227− . parseJSON
228− . String
229− . T.drop 1
230− . T.dropEnd 1 $ lang
231− _ -> Right <$> parseJSON stop
232− return (TokenFilterDefinitionStop stop')
233− _ -> fail ("unrecognized token filter type: " ++ T.unpack t)
234−
235−-- | The set of languages that can be passed to various analyzers,
236−-- filters, etc. in Elasticsearch. Most data types in this module
237−-- that have a 'Language' field are actually only actually to
238−-- handle a subset of these languages. Consult the official
239−-- Elasticsearch documentation to see what is actually supported.
240−data Language
241− = Arabic
242− | Armenian
243− | Basque
244− | Bengali
245− | Brazilian
246− | Bulgarian
247− | Catalan
248− | Cjk
249− | Czech
250− | Danish
251− | Dutch
252− | English
253− | Finnish
254− | French
255− | Galician
256− | German
257− | German2
258− | Greek
259− | Hindi
260− | Hungarian
261− | Indonesian
262− | Irish
263− | Italian
264− | Kp
265− | Latvian
266− | Lithuanian
267− | Lovins
268− | Norwegian
269− | Persian
270− | Porter
271− | Portuguese
272− | Romanian
273− | Russian
274− | Sorani
275− | Spanish
276− | Swedish
277− | Thai
278− | Turkish
279− deriving (Eq, Show)
280−
281−instance ToJSON Language where
282− toJSON = String . languageToText
283−
284−instance FromJSON Language where
285− parseJSON = withText "Language" $ \t -> case languageFromText t of
286− Nothing -> fail "not a supported Elasticsearch language"
287− Just lang -> return lang
288−
289−languageToText :: Language -> Text
290−languageToText x = case x of
291− Arabic -> "arabic"
292− Armenian -> "armenian"
293− Basque -> "basque"
294− Bengali -> "bengali"
295− Brazilian -> "brazilian"
296− Bulgarian -> "bulgarian"
297− Catalan -> "catalan"
298− Cjk -> "cjk"
299− Czech -> "czech"
300− Danish -> "danish"
301− Dutch -> "dutch"
302− English -> "english"
303− Finnish -> "finnish"
304− French -> "french"
305− Galician -> "galician"
306− German -> "german"
307− German2 -> "german2"
308− Greek -> "greek"
309− Hindi -> "hindi"
310− Hungarian -> "hungarian"
311− Indonesian -> "indonesian"
312− Irish -> "irish"
313− Italian -> "italian"
314− Kp -> "kp"
315− Latvian -> "latvian"
316− Lithuanian -> "lithuanian"
317− Lovins -> "lovins"
318− Norwegian -> "norwegian"
319− Persian -> "persian"
320− Porter -> "porter"
321− Portuguese -> "portuguese"
322− Romanian -> "romanian"
323− Russian -> "russian"
324− Sorani -> "sorani"
325− Spanish -> "spanish"
326− Swedish -> "swedish"
327− Thai -> "thai"
328− Turkish -> "turkish"
329−
330−languageFromText :: Text -> Maybe Language
331−languageFromText x = case x of
332− "arabic" -> Just Arabic
333− "armenian" -> Just Armenian
334− "basque" -> Just Basque
335− "bengali" -> Just Bengali
336− "brazilian" -> Just Brazilian
337− "bulgarian" -> Just Bulgarian
338− "catalan" -> Just Catalan
339− "cjk" -> Just Cjk
340− "czech" -> Just Czech
341− "danish" -> Just Danish
342− "dutch" -> Just Dutch
343− "english" -> Just English
344− "finnish" -> Just Finnish
345− "french" -> Just French
346− "galician" -> Just Galician
347− "german" -> Just German
348− "german2" -> Just German2
349− "greek" -> Just Greek
350− "hindi" -> Just Hindi
351− "hungarian" -> Just Hungarian
352− "indonesian" -> Just Indonesian
353− "irish" -> Just Irish
354− "italian" -> Just Italian
355− "kp" -> Just Kp
356− "latvian" -> Just Latvian
357− "lithuanian" -> Just Lithuanian
358− "lovins" -> Just Lovins
359− "norwegian" -> Just Norwegian
360− "persian" -> Just Persian
361− "porter" -> Just Porter
362− "portuguese" -> Just Portuguese
363− "romanian" -> Just Romanian
364− "russian" -> Just Russian
365− "sorani" -> Just Sorani
366− "spanish" -> Just Spanish
367− "swedish" -> Just Swedish
368− "thai" -> Just Thai
369− "turkish" -> Just Turkish
370− _ -> Nothing
371−
372−data Shingle = Shingle
373− { shingleMaxSize :: Int
374− , shingleMinSize :: Int
375− , shingleOutputUnigrams :: Bool
376− , shingleOutputUnigramsIfNoShingles :: Bool
377− , shingleTokenSeparator :: Text
378− , shingleFillerToken :: Text
379− } deriving (Eq, Show)
src/Database/Bloodhound/Internal/Client.hsdeleted−2431
@@ -1,2431 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE FlexibleInstances #-}
3−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4−{-# LANGUAGE MultiParamTypeClasses #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE RecordWildCards #-}
7−{-# LANGUAGE UndecidableInstances #-}
8−
9−module Database.Bloodhound.Internal.Client where
10−
11−import Bloodhound.Import
12−
13−#if defined(MIN_VERSION_GLASGOW_HASKELL)
14−#if MIN_VERSION_GLASGOW_HASKELL(8,6,0,0)
15−import Control.Monad.Fail (MonadFail)
16−#endif
17−#endif
18−import qualified Data.Text as T
19−import qualified Data.Traversable as DT
20−import qualified Data.HashMap.Strict as HM
21−import qualified Data.SemVer as SemVer
22−import qualified Data.Vector as V
23−import GHC.Enum
24−import Network.HTTP.Client
25−import Text.Read (Read(..))
26−import qualified Text.Read as TR
27−
28−import Database.Bloodhound.Internal.Analysis
29−import Database.Bloodhound.Internal.Newtypes
30−import Database.Bloodhound.Internal.Query
31−import Database.Bloodhound.Internal.StringlyTyped
32−
33−{-| Common environment for Elasticsearch calls. Connections will be
34− pipelined according to the provided HTTP connection manager.
35−-}
36−data BHEnv = BHEnv { bhServer :: Server
37− , bhManager :: Manager
38− , bhRequestHook :: Request -> IO Request
39− -- ^ Low-level hook that is run before every request is sent. Used to implement custom authentication strategies. Defaults to 'return' with 'mkBHEnv'.
40− }
41−
42−instance (Functor m, Applicative m, MonadIO m) => MonadBH (ReaderT BHEnv m) where
43− getBHEnv = ask
44−
45−{-| 'Server' is used with the client functions to point at the ES instance
46−-}
47−newtype Server = Server Text deriving (Eq, Show, FromJSON)
48−
49−{-| All API calls to Elasticsearch operate within
50− MonadBH
51− . The idea is that it can be easily embedded in your
52− own monad transformer stack. A default instance for a ReaderT and
53− alias 'BH' is provided for the simple case.
54−-}
55−class (Functor m, Applicative m, MonadIO m) => MonadBH m where
56− getBHEnv :: m BHEnv
57−
58−-- | Create a 'BHEnv' with all optional fields defaulted. HTTP hook
59−-- will be a noop. You can use the exported fields to customize
60−-- it further, e.g.:
61−--
62−-- >> (mkBHEnv myServer myManager) { bhRequestHook = customHook }
63−mkBHEnv :: Server -> Manager -> BHEnv
64−mkBHEnv s m = BHEnv s m return
65−
66−newtype BH m a = BH {
67− unBH :: ReaderT BHEnv m a
68− } deriving ( Functor
69− , Applicative
70− , Monad
71− , MonadIO
72− , MonadState s
73− , MonadWriter w
74− , MonadError e
75− , Alternative
76− , MonadPlus
77− , MonadFix
78− , MonadThrow
79− , MonadCatch
80−#if defined(MIN_VERSION_GLASGOW_HASKELL)
81−#if MIN_VERSION_GLASGOW_HASKELL(8,6,0,0)
82− , MonadFail
83−#endif
84−#endif
85− , MonadMask)
86−
87−instance MonadTrans BH where
88− lift = BH . lift
89−
90−instance (MonadReader r m) => MonadReader r (BH m) where
91− ask = lift ask
92− local f (BH (ReaderT m)) = BH $ ReaderT $ \r ->
93− local f (m r)
94−
95−instance (Functor m, Applicative m, MonadIO m) => MonadBH (BH m) where
96− getBHEnv = BH getBHEnv
97−
98−runBH :: BHEnv -> BH m a -> m a
99−runBH e f = runReaderT (unBH f) e
100−
101−{-| 'Version' is embedded in 'Status' -}
102−data Version = Version { number :: VersionNumber
103− , build_hash :: BuildHash
104− , build_date :: UTCTime
105− , build_snapshot :: Bool
106− , lucene_version :: VersionNumber }
107− deriving (Eq, Show)
108−
109−-- | Traditional software versioning number
110−newtype VersionNumber = VersionNumber
111− { versionNumber :: SemVer.Version }
112− deriving (Eq, Ord, Show)
113−
114−{-| 'Status' is a data type for describing the JSON body returned by
115− Elasticsearch when you query its status. This was deprecated in 1.2.0.
116−
117− <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-status.html#indices-status>
118−-}
119−
120−data Status = Status
121− { name :: Text
122− , cluster_name :: Text
123− , cluster_uuid :: Text
124− , version :: Version
125− , tagline :: Text }
126− deriving (Eq, Show)
127−
128−instance FromJSON Status where
129− parseJSON (Object v) = Status <$>
130− v .: "name" <*>
131− v .: "cluster_name" <*>
132− v .: "cluster_uuid" <*>
133− v .: "version" <*>
134− v .: "tagline"
135− parseJSON _ = empty
136−
137−{-| 'IndexSettings' is used to configure the shards and replicas when
138− you create an Elasticsearch Index.
139−
140− <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html>
141−-}
142−
143−data IndexSettings = IndexSettings
144− { indexShards :: ShardCount
145− , indexReplicas :: ReplicaCount }
146− deriving (Eq, Show)
147−
148−instance ToJSON IndexSettings where
149− toJSON (IndexSettings s r) = object ["settings" .=
150− object ["index" .=
151− object ["number_of_shards" .= s, "number_of_replicas" .= r]
152− ]
153− ]
154−
155−instance FromJSON IndexSettings where
156− parseJSON = withObject "IndexSettings" parse
157− where parse o = do s <- o .: "settings"
158− i <- s .: "index"
159− IndexSettings <$> i .: "number_of_shards"
160− <*> i .: "number_of_replicas"
161−
162−{-| 'defaultIndexSettings' is an 'IndexSettings' with 3 shards and
163− 2 replicas. -}
164−defaultIndexSettings :: IndexSettings
165−defaultIndexSettings = IndexSettings (ShardCount 3) (ReplicaCount 2)
166−-- defaultIndexSettings is exported by Database.Bloodhound as well
167−-- no trailing slashes in servers, library handles building the path.
168−
169−
170−{-| 'ForceMergeIndexSettings' is used to configure index optimization. See
171− <https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html>
172− for more info.
173−-}
174−data ForceMergeIndexSettings =
175− ForceMergeIndexSettings { maxNumSegments :: Maybe Int
176− -- ^ Number of segments to optimize to. 1 will fully optimize the index. If omitted, the default behavior is to only optimize if the server deems it necessary.
177− , onlyExpungeDeletes :: Bool
178− -- ^ Should the optimize process only expunge segments with deletes in them? If the purpose of the optimization is to free disk space, this should be set to True.
179− , flushAfterOptimize :: Bool
180− -- ^ Should a flush be performed after the optimize.
181− } deriving (Eq, Show)
182−
183−
184−{-| 'defaultForceMergeIndexSettings' implements the default settings that
185− Elasticsearch uses for index optimization. 'maxNumSegments' is Nothing,
186− 'onlyExpungeDeletes' is False, and flushAfterOptimize is True.
187−-}
188−defaultForceMergeIndexSettings :: ForceMergeIndexSettings
189−defaultForceMergeIndexSettings = ForceMergeIndexSettings Nothing False True
190−
191−{-| 'UpdatableIndexSetting' are settings which may be updated after an index is created.
192−
193− <https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html>
194−-}
195−data UpdatableIndexSetting = NumberOfReplicas ReplicaCount
196− -- ^ The number of replicas each shard has.
197− | AutoExpandReplicas ReplicaBounds
198− | BlocksReadOnly Bool
199− -- ^ Set to True to have the index read only. False to allow writes and metadata changes.
200− | BlocksRead Bool
201− -- ^ Set to True to disable read operations against the index.
202− | BlocksWrite Bool
203− -- ^ Set to True to disable write operations against the index.
204− | BlocksMetaData Bool
205− -- ^ Set to True to disable metadata operations against the index.
206− | RefreshInterval NominalDiffTime
207− -- ^ The async refresh interval of a shard
208− | IndexConcurrency Int
209− | FailOnMergeFailure Bool
210− | TranslogFlushThresholdOps Int
211− -- ^ When to flush on operations.
212− | TranslogFlushThresholdSize Bytes
213− -- ^ When to flush based on translog (bytes) size.
214− | TranslogFlushThresholdPeriod NominalDiffTime
215− -- ^ When to flush based on a period of not flushing.
216− | TranslogDisableFlush Bool
217− -- ^ Disables flushing. Note, should be set for a short interval and then enabled.
218− | CacheFilterMaxSize (Maybe Bytes)
219− -- ^ The maximum size of filter cache (per segment in shard).
220− | CacheFilterExpire (Maybe NominalDiffTime)
221− -- ^ The expire after access time for filter cache.
222− | GatewaySnapshotInterval NominalDiffTime
223− -- ^ The gateway snapshot interval (only applies to shared gateways).
224− | RoutingAllocationInclude (NonEmpty NodeAttrFilter)
225− -- ^ A node matching any rule will be allowed to host shards from the index.
226− | RoutingAllocationExclude (NonEmpty NodeAttrFilter)
227− -- ^ A node matching any rule will NOT be allowed to host shards from the index.
228− | RoutingAllocationRequire (NonEmpty NodeAttrFilter)
229− -- ^ Only nodes matching all rules will be allowed to host shards from the index.
230− | RoutingAllocationEnable AllocationPolicy
231− -- ^ Enables shard allocation for a specific index.
232− | RoutingAllocationShardsPerNode ShardCount
233− -- ^ Controls the total number of shards (replicas and primaries) allowed to be allocated on a single node.
234− | RecoveryInitialShards InitialShardCount
235− -- ^ When using local gateway a particular shard is recovered only if there can be allocated quorum shards in the cluster.
236− | GCDeletes NominalDiffTime
237− | TTLDisablePurge Bool
238− -- ^ Disables temporarily the purge of expired docs.
239− | TranslogFSType FSType
240− | CompressionSetting Compression
241− | IndexCompoundFormat CompoundFormat
242− | IndexCompoundOnFlush Bool
243− | WarmerEnabled Bool
244− | MappingTotalFieldsLimit Int
245− | AnalysisSetting Analysis
246− -- ^ Analysis is not a dynamic setting and can only be performed on a closed index.
247− deriving (Eq, Show)
248−
249−attrFilterJSON :: NonEmpty NodeAttrFilter -> Value
250−attrFilterJSON fs = object [ n .= T.intercalate "," (toList vs)
251− | NodeAttrFilter (NodeAttrName n) vs <- toList fs]
252−
253−parseAttrFilter :: Value -> Parser (NonEmpty NodeAttrFilter)
254−parseAttrFilter = withObject "NonEmpty NodeAttrFilter" parse
255− where parse o = case HM.toList o of
256− [] -> fail "Expected non-empty list of NodeAttrFilters"
257− x:xs -> DT.mapM (uncurry parse') (x :| xs)
258− parse' n = withText "Text" $ \t ->
259− case T.splitOn "," t of
260− fv:fvs -> return (NodeAttrFilter (NodeAttrName n) (fv :| fvs))
261− [] -> fail "Expected non-empty list of filter values"
262−
263−instance ToJSON UpdatableIndexSetting where
264− toJSON (NumberOfReplicas x) = oPath ("index" :| ["number_of_replicas"]) x
265− toJSON (AutoExpandReplicas x) = oPath ("index" :| ["auto_expand_replicas"]) x
266− toJSON (RefreshInterval x) = oPath ("index" :| ["refresh_interval"]) (NominalDiffTimeJSON x)
267− toJSON (IndexConcurrency x) = oPath ("index" :| ["concurrency"]) x
268− toJSON (FailOnMergeFailure x) = oPath ("index" :| ["fail_on_merge_failure"]) x
269− toJSON (TranslogFlushThresholdOps x) = oPath ("index" :| ["translog", "flush_threshold_ops"]) x
270− toJSON (TranslogFlushThresholdSize x) = oPath ("index" :| ["translog", "flush_threshold_size"]) x
271− toJSON (TranslogFlushThresholdPeriod x) = oPath ("index" :| ["translog", "flush_threshold_period"]) (NominalDiffTimeJSON x)
272− toJSON (TranslogDisableFlush x) = oPath ("index" :| ["translog", "disable_flush"]) x
273− toJSON (CacheFilterMaxSize x) = oPath ("index" :| ["cache", "filter", "max_size"]) x
274− toJSON (CacheFilterExpire x) = oPath ("index" :| ["cache", "filter", "expire"]) (NominalDiffTimeJSON <$> x)
275− toJSON (GatewaySnapshotInterval x) = oPath ("index" :| ["gateway", "snapshot_interval"]) (NominalDiffTimeJSON x)
276− toJSON (RoutingAllocationInclude fs) = oPath ("index" :| ["routing", "allocation", "include"]) (attrFilterJSON fs)
277− toJSON (RoutingAllocationExclude fs) = oPath ("index" :| ["routing", "allocation", "exclude"]) (attrFilterJSON fs)
278− toJSON (RoutingAllocationRequire fs) = oPath ("index" :| ["routing", "allocation", "require"]) (attrFilterJSON fs)
279− toJSON (RoutingAllocationEnable x) = oPath ("index" :| ["routing", "allocation", "enable"]) x
280− toJSON (RoutingAllocationShardsPerNode x) = oPath ("index" :| ["routing", "allocation", "total_shards_per_node"]) x
281− toJSON (RecoveryInitialShards x) = oPath ("index" :| ["recovery", "initial_shards"]) x
282− toJSON (GCDeletes x) = oPath ("index" :| ["gc_deletes"]) (NominalDiffTimeJSON x)
283− toJSON (TTLDisablePurge x) = oPath ("index" :| ["ttl", "disable_purge"]) x
284− toJSON (TranslogFSType x) = oPath ("index" :| ["translog", "fs", "type"]) x
285− toJSON (CompressionSetting x) = oPath ("index" :| ["codec"]) x
286− toJSON (IndexCompoundFormat x) = oPath ("index" :| ["compound_format"]) x
287− toJSON (IndexCompoundOnFlush x) = oPath ("index" :| ["compound_on_flush"]) x
288− toJSON (WarmerEnabled x) = oPath ("index" :| ["warmer", "enabled"]) x
289− toJSON (BlocksReadOnly x) = oPath ("blocks" :| ["read_only"]) x
290− toJSON (BlocksRead x) = oPath ("blocks" :| ["read"]) x
291− toJSON (BlocksWrite x) = oPath ("blocks" :| ["write"]) x
292− toJSON (BlocksMetaData x) = oPath ("blocks" :| ["metadata"]) x
293− toJSON (MappingTotalFieldsLimit x) = oPath ("index" :| ["mapping","total_fields","limit"]) x
294− toJSON (AnalysisSetting x) = oPath ("index" :| ["analysis"]) x
295−
296−instance FromJSON UpdatableIndexSetting where
297− parseJSON = withObject "UpdatableIndexSetting" parse
298− where parse o = numberOfReplicas `taggedAt` ["index", "number_of_replicas"]
299− <|> autoExpandReplicas `taggedAt` ["index", "auto_expand_replicas"]
300− <|> refreshInterval `taggedAt` ["index", "refresh_interval"]
301− <|> indexConcurrency `taggedAt` ["index", "concurrency"]
302− <|> failOnMergeFailure `taggedAt` ["index", "fail_on_merge_failure"]
303− <|> translogFlushThresholdOps `taggedAt` ["index", "translog", "flush_threshold_ops"]
304− <|> translogFlushThresholdSize `taggedAt` ["index", "translog", "flush_threshold_size"]
305− <|> translogFlushThresholdPeriod `taggedAt` ["index", "translog", "flush_threshold_period"]
306− <|> translogDisableFlush `taggedAt` ["index", "translog", "disable_flush"]
307− <|> cacheFilterMaxSize `taggedAt` ["index", "cache", "filter", "max_size"]
308− <|> cacheFilterExpire `taggedAt` ["index", "cache", "filter", "expire"]
309− <|> gatewaySnapshotInterval `taggedAt` ["index", "gateway", "snapshot_interval"]
310− <|> routingAllocationInclude `taggedAt` ["index", "routing", "allocation", "include"]
311− <|> routingAllocationExclude `taggedAt` ["index", "routing", "allocation", "exclude"]
312− <|> routingAllocationRequire `taggedAt` ["index", "routing", "allocation", "require"]
313− <|> routingAllocationEnable `taggedAt` ["index", "routing", "allocation", "enable"]
314− <|> routingAllocationShardsPerNode `taggedAt` ["index", "routing", "allocation", "total_shards_per_node"]
315− <|> recoveryInitialShards `taggedAt` ["index", "recovery", "initial_shards"]
316− <|> gcDeletes `taggedAt` ["index", "gc_deletes"]
317− <|> ttlDisablePurge `taggedAt` ["index", "ttl", "disable_purge"]
318− <|> translogFSType `taggedAt` ["index", "translog", "fs", "type"]
319− <|> compressionSetting `taggedAt` ["index", "codec"]
320− <|> compoundFormat `taggedAt` ["index", "compound_format"]
321− <|> compoundOnFlush `taggedAt` ["index", "compound_on_flush"]
322− <|> warmerEnabled `taggedAt` ["index", "warmer", "enabled"]
323− <|> blocksReadOnly `taggedAt` ["blocks", "read_only"]
324− <|> blocksRead `taggedAt` ["blocks", "read"]
325− <|> blocksWrite `taggedAt` ["blocks", "write"]
326− <|> blocksMetaData `taggedAt` ["blocks", "metadata"]
327− <|> mappingTotalFieldsLimit `taggedAt` ["index", "mapping", "total_fields", "limit"]
328− <|> analysisSetting `taggedAt` ["index", "analysis"]
329− where taggedAt f ks = taggedAt' f (Object o) ks
330− taggedAt' f v [] =
331− f =<< (parseJSON v <|> parseJSON (unStringlyTypeJSON v))
332− taggedAt' f v (k:ks) =
333− withObject "Object" (\o -> do v' <- o .: k
334− taggedAt' f v' ks) v
335− numberOfReplicas = pure . NumberOfReplicas
336− autoExpandReplicas = pure . AutoExpandReplicas
337− refreshInterval = pure . RefreshInterval . ndtJSON
338− indexConcurrency = pure . IndexConcurrency
339− failOnMergeFailure = pure . FailOnMergeFailure
340− translogFlushThresholdOps = pure . TranslogFlushThresholdOps
341− translogFlushThresholdSize = pure . TranslogFlushThresholdSize
342− translogFlushThresholdPeriod = pure . TranslogFlushThresholdPeriod . ndtJSON
343− translogDisableFlush = pure . TranslogDisableFlush
344− cacheFilterMaxSize = pure . CacheFilterMaxSize
345− cacheFilterExpire = pure . CacheFilterExpire . fmap ndtJSON
346− gatewaySnapshotInterval = pure . GatewaySnapshotInterval . ndtJSON
347− routingAllocationInclude = fmap RoutingAllocationInclude . parseAttrFilter
348− routingAllocationExclude = fmap RoutingAllocationExclude . parseAttrFilter
349− routingAllocationRequire = fmap RoutingAllocationRequire . parseAttrFilter
350− routingAllocationEnable = pure . RoutingAllocationEnable
351− routingAllocationShardsPerNode = pure . RoutingAllocationShardsPerNode
352− recoveryInitialShards = pure . RecoveryInitialShards
353− gcDeletes = pure . GCDeletes . ndtJSON
354− ttlDisablePurge = pure . TTLDisablePurge
355− translogFSType = pure . TranslogFSType
356− compressionSetting = pure . CompressionSetting
357− compoundFormat = pure . IndexCompoundFormat
358− compoundOnFlush = pure . IndexCompoundOnFlush
359− warmerEnabled = pure . WarmerEnabled
360− blocksReadOnly = pure . BlocksReadOnly
361− blocksRead = pure . BlocksRead
362− blocksWrite = pure . BlocksWrite
363− blocksMetaData = pure . BlocksMetaData
364− mappingTotalFieldsLimit = pure . MappingTotalFieldsLimit
365− analysisSetting = pure . AnalysisSetting
366−
367−data ReplicaBounds = ReplicasBounded Int Int
368− | ReplicasLowerBounded Int
369− | ReplicasUnbounded
370− deriving (Eq, Show)
371−
372−
373−instance ToJSON ReplicaBounds where
374− toJSON (ReplicasBounded a b) = String (showText a <> "-" <> showText b)
375− toJSON (ReplicasLowerBounded a) = String (showText a <> "-all")
376− toJSON ReplicasUnbounded = Bool False
377−
378−instance FromJSON ReplicaBounds where
379− parseJSON v = withText "ReplicaBounds" parseText v
380− <|> withBool "ReplicaBounds" parseBool v
381− where parseText t = case T.splitOn "-" t of
382− [a, "all"] -> ReplicasLowerBounded <$> parseReadText a
383− [a, b] -> ReplicasBounded <$> parseReadText a
384− <*> parseReadText b
385− _ -> fail ("Could not parse ReplicaBounds: " <> show t)
386− parseBool False = pure ReplicasUnbounded
387− parseBool _ = fail "ReplicasUnbounded cannot be represented with True"
388−
389−data Compression
390− = CompressionDefault
391− -- ^ Compress with LZ4
392− | CompressionBest
393− -- ^ Compress with DEFLATE. Elastic
394− -- <https://www.elastic.co/blog/elasticsearch-storage-the-true-story-2.0 blogs>
395− -- that this can reduce disk use by 15%-25%.
396− deriving (Eq,Show)
397−
398−instance ToJSON Compression where
399− toJSON x = case x of
400− CompressionDefault -> toJSON ("default" :: Text)
401− CompressionBest -> toJSON ("best_compression" :: Text)
402−
403−instance FromJSON Compression where
404− parseJSON = withText "Compression" $ \t -> case t of
405− "default" -> return CompressionDefault
406− "best_compression" -> return CompressionBest
407− _ -> fail "invalid compression codec"
408−
409−-- | A measure of bytes used for various configurations. You may want
410−-- to use smart constructors like 'gigabytes' for larger values.
411−--
412−-- >>> gigabytes 9
413−-- Bytes 9000000000
414−--
415−-- >>> megabytes 9
416−-- Bytes 9000000
417−--
418−-- >>> kilobytes 9
419−-- Bytes 9000
420−newtype Bytes =
421− Bytes Int
422− deriving (Eq, Show, Ord, ToJSON, FromJSON)
423−
424−gigabytes :: Int -> Bytes
425−gigabytes n = megabytes (1000 * n)
426−
427−
428−megabytes :: Int -> Bytes
429−megabytes n = kilobytes (1000 * n)
430−
431−
432−kilobytes :: Int -> Bytes
433−kilobytes n = Bytes (1000 * n)
434−
435−
436−data FSType = FSSimple
437− | FSBuffered deriving (Eq, Show)
438−
439−instance ToJSON FSType where
440− toJSON FSSimple = "simple"
441− toJSON FSBuffered = "buffered"
442−
443−instance FromJSON FSType where
444− parseJSON = withText "FSType" parse
445− where parse "simple" = pure FSSimple
446− parse "buffered" = pure FSBuffered
447− parse t = fail ("Invalid FSType: " <> show t)
448−
449−data InitialShardCount = QuorumShards
450− | QuorumMinus1Shards
451− | FullShards
452− | FullMinus1Shards
453− | ExplicitShards Int
454− deriving (Eq, Show)
455−
456−instance FromJSON InitialShardCount where
457− parseJSON v = withText "InitialShardCount" parseText v
458− <|> ExplicitShards <$> parseJSON v
459− where parseText "quorum" = pure QuorumShards
460− parseText "quorum-1" = pure QuorumMinus1Shards
461− parseText "full" = pure FullShards
462− parseText "full-1" = pure FullMinus1Shards
463− parseText _ = mzero
464−
465−instance ToJSON InitialShardCount where
466− toJSON QuorumShards = String "quorum"
467− toJSON QuorumMinus1Shards = String "quorum-1"
468− toJSON FullShards = String "full"
469− toJSON FullMinus1Shards = String "full-1"
470− toJSON (ExplicitShards x) = toJSON x
471−
472−data NodeAttrFilter = NodeAttrFilter
473− { nodeAttrFilterName :: NodeAttrName
474− , nodeAttrFilterValues :: NonEmpty Text }
475− deriving (Eq, Ord, Show)
476−
477−newtype NodeAttrName = NodeAttrName Text deriving (Eq, Ord, Show)
478−
479−data CompoundFormat = CompoundFileFormat Bool
480− | MergeSegmentVsTotalIndex Double
481− -- ^ percentage between 0 and 1 where 0 is false, 1 is true
482− deriving (Eq, Show)
483−
484−instance ToJSON CompoundFormat where
485− toJSON (CompoundFileFormat x) = Bool x
486− toJSON (MergeSegmentVsTotalIndex x) = toJSON x
487−
488−instance FromJSON CompoundFormat where
489− parseJSON v = CompoundFileFormat <$> parseJSON v
490− <|> MergeSegmentVsTotalIndex <$> parseJSON v
491−
492−newtype NominalDiffTimeJSON =
493− NominalDiffTimeJSON { ndtJSON :: NominalDiffTime }
494−
495−instance ToJSON NominalDiffTimeJSON where
496− toJSON (NominalDiffTimeJSON t) = String (showText (round t :: Integer) <> "s")
497−
498−instance FromJSON NominalDiffTimeJSON where
499− parseJSON = withText "NominalDiffTime" parse
500− where parse t = case T.takeEnd 1 t of
501− "s" -> NominalDiffTimeJSON . fromInteger <$> parseReadText (T.dropEnd 1 t)
502− _ -> fail "Invalid or missing NominalDiffTime unit (expected s)"
503−
504−data IndexSettingsSummary = IndexSettingsSummary
505− { sSummaryIndexName :: IndexName
506− , sSummaryFixedSettings :: IndexSettings
507− , sSummaryUpdateable :: [UpdatableIndexSetting]}
508− deriving (Eq, Show)
509−
510−parseSettings :: Object -> Parser [UpdatableIndexSetting]
511−parseSettings o = do
512− o' <- o .: "index"
513− -- slice the index object into singleton hashmaps and try to parse each
514− parses <- forM (HM.toList o') $ \(k, v) -> do
515− -- blocks are now nested into the "index" key, which is not how they're serialized
516− let atRoot = Object (HM.singleton k v)
517− let atIndex = Object (HM.singleton "index" atRoot)
518− optional (parseJSON atRoot <|> parseJSON atIndex)
519− return (catMaybes parses)
520−
521−instance FromJSON IndexSettingsSummary where
522− parseJSON = withObject "IndexSettingsSummary" parse
523− where parse o = case HM.toList o of
524− [(ixn, v@(Object o'))] -> IndexSettingsSummary (IndexName ixn)
525− <$> parseJSON v
526− <*> (fmap (filter (not . redundant)) . parseSettings =<< o' .: "settings")
527− _ -> fail "Expected single-key object with index name"
528− redundant (NumberOfReplicas _) = True
529− redundant _ = False
530−
531−{-| 'Reply' and 'Method' are type synonyms from 'Network.HTTP.Types.Method.Method' -}
532−type Reply = Network.HTTP.Client.Response LByteString
533−
534−{-| 'OpenCloseIndex' is a sum type for opening and closing indices.
535−
536− <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html>
537−-}
538−data OpenCloseIndex = OpenIndex | CloseIndex deriving (Eq, Show)
539−
540−data FieldType = GeoPointType
541− | GeoShapeType
542− | FloatType
543− | IntegerType
544− | LongType
545− | ShortType
546− | ByteType deriving (Eq, Show)
547−
548−newtype FieldDefinition = FieldDefinition
549− { fieldType :: FieldType
550− } deriving (Eq, Show)
551−
552−{-| An 'IndexTemplate' defines a template that will automatically be
553− applied to new indices created. The templates include both
554− 'IndexSettings' and mappings, and a simple 'TemplatePattern' that
555− controls if the template will be applied to the index created.
556− Specify mappings as follows: @[toJSON TweetMapping, ...]@
557−
558− https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-templates.html
559−-}
560−data IndexTemplate =
561− IndexTemplate { templatePattern :: TemplatePattern
562− , templateSettings :: Maybe IndexSettings
563− , templateMappings :: [Value]
564− }
565−
566−instance ToJSON IndexTemplate where
567− toJSON (IndexTemplate p s m) = merge
568− (object [ "template" .= p
569− , "mappings" .= foldl' merge (object []) m
570− ])
571− (toJSON s)
572− where
573− merge (Object o1) (Object o2) = toJSON $ HM.union o1 o2
574− merge o Null = o
575− merge _ _ = undefined
576−
577−data MappingField =
578− MappingField { mappingFieldName :: FieldName
579− , fieldDefinition :: FieldDefinition }
580− deriving (Eq, Show)
581−
582−{-| Support for type reification of 'Mapping's is currently incomplete, for
583− now the mapping API verbiage expects a 'ToJSON'able blob.
584−
585− Indexes have mappings, mappings are schemas for the documents contained
586− in the index. I'd recommend having only one mapping per index, always
587− having a mapping, and keeping different kinds of documents separated
588− if possible.
589−-}
590−data Mapping =
591− Mapping { typeName :: TypeName
592− , mappingFields :: [MappingField] }
593− deriving (Eq, Show)
594−
595−data AllocationPolicy = AllocAll
596− -- ^ Allows shard allocation for all shards.
597− | AllocPrimaries
598− -- ^ Allows shard allocation only for primary shards.
599− | AllocNewPrimaries
600− -- ^ Allows shard allocation only for primary shards for new indices.
601− | AllocNone
602− -- ^ No shard allocation is allowed
603− deriving (Eq, Show)
604−
605−instance ToJSON AllocationPolicy where
606− toJSON AllocAll = String "all"
607− toJSON AllocPrimaries = String "primaries"
608− toJSON AllocNewPrimaries = String "new_primaries"
609− toJSON AllocNone = String "none"
610−
611−instance FromJSON AllocationPolicy where
612− parseJSON = withText "AllocationPolicy" parse
613− where parse "all" = pure AllocAll
614− parse "primaries" = pure AllocPrimaries
615− parse "new_primaries" = pure AllocNewPrimaries
616− parse "none" = pure AllocNone
617− parse t = fail ("Invlaid AllocationPolicy: " <> show t)
618−
619−{-| 'BulkOperation' is a sum type for expressing the four kinds of bulk
620− operation index, create, delete, and update. 'BulkIndex' behaves like an
621− "upsert", 'BulkCreate' will fail if a document already exists at the DocId.
622− Consult the <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html#docs-bulk Bulk API documentation>
623− for further explanation.
624− Warning: Bulk operations suffixed with @Auto@ rely on Elasticsearch to
625− generate the id. Often, people use auto-generated identifiers when
626− Elasticsearch is the only place that their data is stored. Do not let
627− Elasticsearch be the only place your data is stored. It does not guarantee
628− durability, and it may silently discard data.
629− This <https://github.com/elastic/elasticsearch/issues/10708 issue> is
630− discussed further on github.
631−-}
632−data BulkOperation =
633− BulkIndex IndexName MappingName DocId Value
634− -- ^ Create the document, replacing it if it already exists.
635− | BulkIndexAuto IndexName MappingName Value
636− -- ^ Create a document with an autogenerated id.
637− | BulkIndexEncodingAuto IndexName MappingName Encoding
638− -- ^ Create a document with an autogenerated id. Use fast JSON encoding.
639− | BulkCreate IndexName MappingName DocId Value
640− -- ^ Create a document, failing if it already exists.
641− | BulkCreateEncoding IndexName MappingName DocId Encoding
642− -- ^ Create a document, failing if it already exists. Use fast JSON encoding.
643− | BulkDelete IndexName MappingName DocId
644− -- ^ Delete the document
645− | BulkUpdate IndexName MappingName DocId Value
646− -- ^ Update the document, merging the new value with the existing one.
647− deriving (Eq, Show)
648−
649−{-| 'EsResult' describes the standard wrapper JSON document that you see in
650− successful Elasticsearch lookups or lookups that couldn't find the document.
651−-}
652−data EsResult a = EsResult { _index :: Text
653− , _type :: Text
654− , _id :: Text
655− , foundResult :: Maybe (EsResultFound a)} deriving (Eq, Show)
656−
657−{-| 'EsResultFound' contains the document and its metadata inside of an
658− 'EsResult' when the document was successfully found.
659−-}
660−data EsResultFound a =
661− EsResultFound { _version :: DocVersion
662− , _source :: a }
663− deriving (Eq, Show)
664−
665−instance (FromJSON a) => FromJSON (EsResult a) where
666− parseJSON jsonVal@(Object v) = do
667− found <- v .:? "found" .!= False
668− fr <- if found
669− then parseJSON jsonVal
670− else return Nothing
671− EsResult <$> v .: "_index" <*>
672− v .: "_type" <*>
673− v .: "_id" <*>
674− pure fr
675− parseJSON _ = empty
676−
677−instance (FromJSON a) => FromJSON (EsResultFound a) where
678− parseJSON (Object v) = EsResultFound <$>
679− v .: "_version" <*>
680− v .: "_source"
681− parseJSON _ = empty
682−
683−{-| 'EsError' is the generic type that will be returned when there was a
684− problem. If you can't parse the expected response, its a good idea to
685− try parsing this.
686−-}
687−data EsError =
688− EsError { errorStatus :: Int
689− , errorMessage :: Text }
690− deriving (Eq, Show)
691−
692−instance FromJSON EsError where
693− parseJSON (Object v) = EsError <$>
694− v .: "status" <*>
695− (v .: "error" <|> (v .: "error" >>= (.: "reason")))
696− parseJSON _ = empty
697−
698−{-| 'EsProtocolException' will be thrown if Bloodhound cannot parse a response
699−returned by the Elasticsearch server. If you encounter this error, please
700−verify that your domain data types and FromJSON instances are working properly
701−(for example, the 'a' of '[Hit a]' in 'SearchResult.searchHits.hits'). If you're
702−sure that your mappings are correct, then this error may be an indication of an
703−incompatibility between Bloodhound and Elasticsearch. Please open a bug report
704−and be sure to include the exception body.
705−-}
706−data EsProtocolException = EsProtocolException
707− { esProtoExMessage :: !Text
708− , esProtoExBody :: !LByteString
709− } deriving (Eq, Show)
710−
711−instance Exception EsProtocolException
712−
713−data IndexAlias = IndexAlias { srcIndex :: IndexName
714− , indexAlias :: IndexAliasName } deriving (Eq, Show)
715−
716−data IndexAliasAction =
717− AddAlias IndexAlias IndexAliasCreate
718− | RemoveAlias IndexAlias
719− deriving (Eq, Show)
720−
721−data IndexAliasCreate =
722− IndexAliasCreate { aliasCreateRouting :: Maybe AliasRouting
723− , aliasCreateFilter :: Maybe Filter}
724− deriving (Eq, Show)
725−
726−data AliasRouting =
727− AllAliasRouting RoutingValue
728− | GranularAliasRouting (Maybe SearchAliasRouting) (Maybe IndexAliasRouting)
729− deriving (Eq, Show)
730−
731−newtype SearchAliasRouting =
732− SearchAliasRouting (NonEmpty RoutingValue)
733− deriving (Eq, Show)
734−
735−instance ToJSON SearchAliasRouting where
736− toJSON (SearchAliasRouting rvs) = toJSON (T.intercalate "," (routingValue <$> toList rvs))
737−
738−instance FromJSON SearchAliasRouting where
739− parseJSON = withText "SearchAliasRouting" parse
740− where parse t = SearchAliasRouting <$> parseNEJSON (String <$> T.splitOn "," t)
741−
742−newtype IndexAliasRouting =
743− IndexAliasRouting RoutingValue
744− deriving (Eq, Show, ToJSON, FromJSON)
745−
746−newtype RoutingValue =
747− RoutingValue { routingValue :: Text }
748− deriving (Eq, Show, ToJSON, FromJSON)
749−
750−newtype IndexAliasesSummary =
751− IndexAliasesSummary { indexAliasesSummary :: [IndexAliasSummary] }
752− deriving (Eq, Show)
753−
754−instance FromJSON IndexAliasesSummary where
755− parseJSON = withObject "IndexAliasesSummary" parse
756− where parse o = IndexAliasesSummary . mconcat <$> mapM (uncurry go) (HM.toList o)
757− go ixn = withObject "index aliases" $ \ia -> do
758− aliases <- ia .:? "aliases" .!= mempty
759− forM (HM.toList aliases) $ \(aName, v) -> do
760− let indexAlias = IndexAlias (IndexName ixn) (IndexAliasName (IndexName aName))
761− IndexAliasSummary indexAlias <$> parseJSON v
762−
763−
764−instance ToJSON IndexAliasAction where
765− toJSON (AddAlias ia opts) = object ["add" .= (iaObj <> optsObj)]
766− where Object iaObj = toJSON ia
767− Object optsObj = toJSON opts
768− toJSON (RemoveAlias ia) = object ["remove" .= iaObj]
769− where Object iaObj = toJSON ia
770−
771−instance ToJSON IndexAlias where
772− toJSON IndexAlias {..} = object ["index" .= srcIndex
773− , "alias" .= indexAlias
774− ]
775−
776−instance ToJSON IndexAliasCreate where
777− toJSON IndexAliasCreate {..} = Object (filterObj <> routingObj)
778− where filterObj = maybe mempty (HM.singleton "filter" . toJSON) aliasCreateFilter
779− Object routingObj = maybe (Object mempty) toJSON aliasCreateRouting
780−
781−instance ToJSON AliasRouting where
782− toJSON (AllAliasRouting v) = object ["routing" .= v]
783− toJSON (GranularAliasRouting srch idx) = object (catMaybes prs)
784− where prs = [("search_routing" .=) <$> srch
785− ,("index_routing" .=) <$> idx]
786−
787−instance FromJSON AliasRouting where
788− parseJSON = withObject "AliasRouting" parse
789− where parse o = parseAll o <|> parseGranular o
790− parseAll o = AllAliasRouting <$> o .: "routing"
791− parseGranular o = do
792− sr <- o .:? "search_routing"
793− ir <- o .:? "index_routing"
794− if isNothing sr && isNothing ir
795− then fail "Both search_routing and index_routing can't be blank"
796− else return (GranularAliasRouting sr ir)
797−
798−instance FromJSON IndexAliasCreate where
799− parseJSON v = withObject "IndexAliasCreate" parse v
800− where parse o = IndexAliasCreate <$> optional (parseJSON v)
801− <*> o .:? "filter"
802−
803−{-| 'IndexAliasSummary' is a summary of an index alias configured for a server. -}
804−data IndexAliasSummary = IndexAliasSummary
805− { indexAliasSummaryAlias :: IndexAlias
806− , indexAliasSummaryCreate :: IndexAliasCreate }
807− deriving (Eq, Show)
808−
809−{-| 'DocVersion' is an integer version number for a document between 1
810−and 9.2e+18 used for <<https://www.elastic.co/guide/en/elasticsearch/guide/current/optimistic-concurrency-control.html optimistic concurrency control>>.
811−-}
812−newtype DocVersion = DocVersion {
813− docVersionNumber :: Int
814− } deriving (Eq, Show, Ord, ToJSON)
815−
816−-- | Smart constructor for in-range doc version
817−mkDocVersion :: Int -> Maybe DocVersion
818−mkDocVersion i
819− | i >= docVersionNumber minBound
820− && i <= docVersionNumber maxBound =
821− Just $ DocVersion i
822− | otherwise = Nothing
823−
824−instance Bounded DocVersion where
825− minBound = DocVersion 1
826− maxBound = DocVersion 9200000000000000000 -- 9.2e+18
827−
828−instance Enum DocVersion where
829− succ x
830− | x /= maxBound = DocVersion (succ $ docVersionNumber x)
831− | otherwise = succError "DocVersion"
832− pred x
833− | x /= minBound = DocVersion (pred $ docVersionNumber x)
834− | otherwise = predError "DocVersion"
835− toEnum i =
836− fromMaybe (error $ show i ++ " out of DocVersion range") $ mkDocVersion i
837− fromEnum = docVersionNumber
838− enumFrom = boundedEnumFrom
839− enumFromThen = boundedEnumFromThen
840−
841−instance FromJSON DocVersion where
842− parseJSON v = do
843− i <- parseJSON v
844− maybe (fail "DocVersion out of range") return $ mkDocVersion i
845−
846−{-| 'ExternalDocVersion' is a convenience wrapper if your code uses its
847−own version numbers instead of ones from ES.
848−-}
849−newtype ExternalDocVersion = ExternalDocVersion DocVersion
850− deriving (Eq, Show, Ord, Bounded, Enum, ToJSON)
851−
852−{-| 'VersionControl' is specified when indexing documents as a
853−optimistic concurrency control.
854−-}
855−data VersionControl = NoVersionControl
856− -- ^ Don't send a version. This is a pure overwrite.
857− | InternalVersion DocVersion
858− -- ^ Use the default ES versioning scheme. Only
859− -- index the document if the version is the same
860− -- as the one specified. Only applicable to
861− -- updates, as you should be getting Version from
862− -- a search result.
863− | ExternalGT ExternalDocVersion
864− -- ^ Use your own version numbering. Only index
865− -- the document if the version is strictly higher
866− -- OR the document doesn't exist. The given
867− -- version will be used as the new version number
868− -- for the stored document. N.B. All updates must
869− -- increment this number, meaning there is some
870− -- global, external ordering of updates.
871− | ExternalGTE ExternalDocVersion
872− -- ^ Use your own version numbering. Only index
873− -- the document if the version is equal or higher
874− -- than the stored version. Will succeed if there
875− -- is no existing document. The given version will
876− -- be used as the new version number for the
877− -- stored document. Use with care, as this could
878− -- result in data loss.
879− | ForceVersion ExternalDocVersion
880− -- ^ The document will always be indexed and the
881− -- given version will be the new version. This is
882− -- typically used for correcting errors. Use with
883− -- care, as this could result in data loss.
884− deriving (Eq, Show, Ord)
885−
886−{-| 'DocumentParent' is used to specify a parent document.
887−-}
888−newtype DocumentParent = DocumentParent DocId
889− deriving (Eq, Show)
890−
891−{-| 'IndexDocumentSettings' are special settings supplied when indexing
892−a document. For the best backwards compatiblity when new fields are
893−added, you should probably prefer to start with 'defaultIndexDocumentSettings'
894−-}
895−data IndexDocumentSettings =
896− IndexDocumentSettings { idsVersionControl :: VersionControl
897− , idsParent :: Maybe DocumentParent
898− } deriving (Eq, Show)
899−
900−{-| Reasonable default settings. Chooses no version control and no parent.
901−-}
902−defaultIndexDocumentSettings :: IndexDocumentSettings
903−defaultIndexDocumentSettings = IndexDocumentSettings NoVersionControl Nothing
904−
905−{-| 'IndexSelection' is used for APIs which take a single index, a list of
906− indexes, or the special @_all@ index.
907−-}
908−--TODO: this does not fully support <https://www.elastic.co/guide/en/elasticsearch/reference/1.7/multi-index.html multi-index syntax>. It wouldn't be too hard to implement but you'd have to add the optional parameters (ignore_unavailable, allow_no_indices, expand_wildcards) to any APIs using it. Also would be a breaking API.
909−data IndexSelection =
910− IndexList (NonEmpty IndexName)
911− | AllIndexes
912− deriving (Eq, Show)
913−
914−{-| 'NodeSelection' is used for most cluster APIs. See <https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes here> for more details.
915−-}
916−data NodeSelection =
917− LocalNode
918− -- ^ Whatever node receives this request
919− | NodeList (NonEmpty NodeSelector)
920− | AllNodes
921− deriving (Eq, Show)
922−
923−
924−-- | An exact match or pattern to identify a node. Note that All of
925−-- these options support wildcarding, so your node name, server, attr
926−-- name can all contain * characters to be a fuzzy match.
927−data NodeSelector =
928− NodeByName NodeName
929− | NodeByFullNodeId FullNodeId
930− | NodeByHost Server
931− -- ^ e.g. 10.0.0.1 or even 10.0.0.*
932− | NodeByAttribute NodeAttrName Text
933− -- ^ NodeAttrName can be a pattern, e.g. rack*. The value can too.
934− deriving (Eq, Show)
935−
936−{-| 'TemplateName' is used to describe which template to query/create/delete
937−-}
938−newtype TemplateName = TemplateName Text deriving (Eq, Show, ToJSON, FromJSON)
939−
940−{-| 'TemplatePattern' represents a pattern which is matched against index names
941−-}
942−newtype TemplatePattern = TemplatePattern Text deriving (Eq, Show, ToJSON, FromJSON)
943−
944−-- | Username type used for HTTP Basic authentication. See 'basicAuthHook'.
945−newtype EsUsername = EsUsername { esUsername :: Text } deriving (Read, Show, Eq)
946−
947−-- | Password type used for HTTP Basic authentication. See 'basicAuthHook'.
948−newtype EsPassword = EsPassword { esPassword :: Text } deriving (Read, Show, Eq)
949−
950−
951−data SnapshotRepoSelection =
952− SnapshotRepoList (NonEmpty SnapshotRepoPattern)
953− | AllSnapshotRepos
954− deriving (Eq, Show)
955−
956−
957−-- | Either specifies an exact repo name or one with globs in it,
958−-- e.g. @RepoPattern "foo*"@ __NOTE__: Patterns are not supported on ES < 1.7
959−data SnapshotRepoPattern =
960− ExactRepo SnapshotRepoName
961− | RepoPattern Text
962− deriving (Eq, Show)
963−
964−-- | The unique name of a snapshot repository.
965−newtype SnapshotRepoName =
966− SnapshotRepoName { snapshotRepoName :: Text }
967− deriving (Eq, Ord, Show, ToJSON, FromJSON)
968−
969−
970−-- | A generic representation of a snapshot repo. This is what gets
971−-- sent to and parsed from the server. For repo types enabled by
972−-- plugins that aren't exported by this library, consider making a
973−-- custom type which implements 'SnapshotRepo'. If it is a common repo
974−-- type, consider submitting a pull request to have it included in the
975−-- library proper
976−data GenericSnapshotRepo = GenericSnapshotRepo {
977− gSnapshotRepoName :: SnapshotRepoName
978− , gSnapshotRepoType :: SnapshotRepoType
979− , gSnapshotRepoSettings :: GenericSnapshotRepoSettings
980− } deriving (Eq, Show)
981−
982−
983−instance SnapshotRepo GenericSnapshotRepo where
984− toGSnapshotRepo = id
985− fromGSnapshotRepo = Right
986−
987−
988−newtype SnapshotRepoType =
989− SnapshotRepoType { snapshotRepoType :: Text }
990− deriving (Eq, Ord, Show, ToJSON, FromJSON)
991−
992−
993−-- | Opaque representation of snapshot repo settings. Instances of
994−-- 'SnapshotRepo' will produce this.
995−newtype GenericSnapshotRepoSettings =
996− GenericSnapshotRepoSettings { gSnapshotRepoSettingsObject :: Object }
997− deriving (Eq, Show, ToJSON)
998−
999−
1000− -- Regardless of whether you send strongly typed json, my version of
1001− -- ES sends back stringly typed json in the settings, e.g. booleans
1002− -- as strings, so we'll try to convert them.
1003−instance FromJSON GenericSnapshotRepoSettings where
1004− parseJSON = fmap (GenericSnapshotRepoSettings . fmap unStringlyTypeJSON). parseJSON
1005−
1006−-- | The result of running 'verifySnapshotRepo'.
1007−newtype SnapshotVerification =
1008− SnapshotVerification {
1009− snapshotNodeVerifications :: [SnapshotNodeVerification]
1010− } deriving (Eq, Show)
1011−
1012−
1013−instance FromJSON SnapshotVerification where
1014− parseJSON = withObject "SnapshotVerification" parse
1015− where
1016− parse o = do
1017− o2 <- o .: "nodes"
1018− SnapshotVerification <$> mapM (uncurry parse') (HM.toList o2)
1019− parse' rawFullId = withObject "SnapshotNodeVerification" $ \o ->
1020− SnapshotNodeVerification (FullNodeId rawFullId) <$> o .: "name"
1021−
1022−
1023−-- | A node that has verified a snapshot
1024−data SnapshotNodeVerification = SnapshotNodeVerification {
1025− snvFullId :: FullNodeId
1026− , snvNodeName :: NodeName
1027− } deriving (Eq, Show)
1028−
1029−
1030−-- | Unique, automatically-generated name assigned to nodes that are
1031−-- usually returned in node-oriented APIs.
1032−newtype FullNodeId = FullNodeId { fullNodeId :: Text }
1033− deriving (Eq, Ord, Show, FromJSON)
1034−
1035−
1036−-- | A human-readable node name that is supplied by the user in the
1037−-- node config or automatically generated by Elasticsearch.
1038−newtype NodeName = NodeName { nodeName :: Text }
1039− deriving (Eq, Ord, Show, FromJSON)
1040−
1041−newtype ClusterName = ClusterName { clusterName :: Text }
1042− deriving (Eq, Ord, Show, FromJSON)
1043−
1044−data NodesInfo = NodesInfo {
1045− nodesInfo :: [NodeInfo]
1046− , nodesClusterName :: ClusterName
1047− } deriving (Eq, Show)
1048−
1049−data NodesStats = NodesStats {
1050− nodesStats :: [NodeStats]
1051− , nodesStatsClusterName :: ClusterName
1052− } deriving (Eq, Show)
1053−
1054−data NodeStats = NodeStats {
1055− nodeStatsName :: NodeName
1056− , nodeStatsFullId :: FullNodeId
1057− , nodeStatsBreakersStats :: Maybe NodeBreakersStats
1058− , nodeStatsHTTP :: NodeHTTPStats
1059− , nodeStatsTransport :: NodeTransportStats
1060− , nodeStatsFS :: NodeFSStats
1061− , nodeStatsNetwork :: Maybe NodeNetworkStats
1062− , nodeStatsThreadPool :: NodeThreadPoolsStats
1063− , nodeStatsJVM :: NodeJVMStats
1064− , nodeStatsProcess :: NodeProcessStats
1065− , nodeStatsOS :: NodeOSStats
1066− , nodeStatsIndices :: NodeIndicesStats
1067− } deriving (Eq, Show)
1068−
1069−data NodeBreakersStats = NodeBreakersStats {
1070− nodeStatsParentBreaker :: NodeBreakerStats
1071− , nodeStatsRequestBreaker :: NodeBreakerStats
1072− , nodeStatsFieldDataBreaker :: NodeBreakerStats
1073− } deriving (Eq, Show)
1074−
1075−data NodeBreakerStats = NodeBreakerStats {
1076− nodeBreakersTripped :: Int
1077− , nodeBreakersOverhead :: Double
1078− , nodeBreakersEstSize :: Bytes
1079− , nodeBreakersLimitSize :: Bytes
1080− } deriving (Eq, Show)
1081−
1082−data NodeHTTPStats = NodeHTTPStats {
1083− nodeHTTPTotalOpened :: Int
1084− , nodeHTTPCurrentOpen :: Int
1085− } deriving (Eq, Show)
1086−
1087−data NodeTransportStats = NodeTransportStats {
1088− nodeTransportTXSize :: Bytes
1089− , nodeTransportCount :: Int
1090− , nodeTransportRXSize :: Bytes
1091− , nodeTransportRXCount :: Int
1092− , nodeTransportServerOpen :: Int
1093− } deriving (Eq, Show)
1094−
1095−data NodeFSStats = NodeFSStats {
1096− nodeFSDataPaths :: [NodeDataPathStats]
1097− , nodeFSTotal :: NodeFSTotalStats
1098− , nodeFSTimestamp :: UTCTime
1099− } deriving (Eq, Show)
1100−
1101−data NodeDataPathStats = NodeDataPathStats {
1102− nodeDataPathDiskServiceTime :: Maybe Double
1103− , nodeDataPathDiskQueue :: Maybe Double
1104− , nodeDataPathIOSize :: Maybe Bytes
1105− , nodeDataPathWriteSize :: Maybe Bytes
1106− , nodeDataPathReadSize :: Maybe Bytes
1107− , nodeDataPathIOOps :: Maybe Int
1108− , nodeDataPathWrites :: Maybe Int
1109− , nodeDataPathReads :: Maybe Int
1110− , nodeDataPathAvailable :: Bytes
1111− , nodeDataPathFree :: Bytes
1112− , nodeDataPathTotal :: Bytes
1113− , nodeDataPathType :: Maybe Text
1114− , nodeDataPathDevice :: Maybe Text
1115− , nodeDataPathMount :: Text
1116− , nodeDataPathPath :: Text
1117− } deriving (Eq, Show)
1118−
1119−data NodeFSTotalStats = NodeFSTotalStats {
1120− nodeFSTotalDiskServiceTime :: Maybe Double
1121− , nodeFSTotalDiskQueue :: Maybe Double
1122− , nodeFSTotalIOSize :: Maybe Bytes
1123− , nodeFSTotalWriteSize :: Maybe Bytes
1124− , nodeFSTotalReadSize :: Maybe Bytes
1125− , nodeFSTotalIOOps :: Maybe Int
1126− , nodeFSTotalWrites :: Maybe Int
1127− , nodeFSTotalReads :: Maybe Int
1128− , nodeFSTotalAvailable :: Bytes
1129− , nodeFSTotalFree :: Bytes
1130− , nodeFSTotalTotal :: Bytes
1131− } deriving (Eq, Show)
1132−
1133−data NodeNetworkStats = NodeNetworkStats {
1134− nodeNetTCPOutRSTs :: Int
1135− , nodeNetTCPInErrs :: Int
1136− , nodeNetTCPAttemptFails :: Int
1137− , nodeNetTCPEstabResets :: Int
1138− , nodeNetTCPRetransSegs :: Int
1139− , nodeNetTCPOutSegs :: Int
1140− , nodeNetTCPInSegs :: Int
1141− , nodeNetTCPCurrEstab :: Int
1142− , nodeNetTCPPassiveOpens :: Int
1143− , nodeNetTCPActiveOpens :: Int
1144− } deriving (Eq, Show)
1145−
1146−data NodeThreadPoolsStats = NodeThreadPoolsStats {
1147− nodeThreadPoolsStatsSnapshot :: NodeThreadPoolStats
1148− , nodeThreadPoolsStatsBulk :: NodeThreadPoolStats
1149− , nodeThreadPoolsStatsMerge :: NodeThreadPoolStats
1150− , nodeThreadPoolsStatsGet :: NodeThreadPoolStats
1151− , nodeThreadPoolsStatsManagement :: NodeThreadPoolStats
1152− , nodeThreadPoolsStatsFetchShardStore :: Maybe NodeThreadPoolStats
1153− , nodeThreadPoolsStatsOptimize :: Maybe NodeThreadPoolStats
1154− , nodeThreadPoolsStatsFlush :: NodeThreadPoolStats
1155− , nodeThreadPoolsStatsSearch :: NodeThreadPoolStats
1156− , nodeThreadPoolsStatsWarmer :: NodeThreadPoolStats
1157− , nodeThreadPoolsStatsGeneric :: NodeThreadPoolStats
1158− , nodeThreadPoolsStatsSuggest :: Maybe NodeThreadPoolStats
1159− , nodeThreadPoolsStatsRefresh :: NodeThreadPoolStats
1160− , nodeThreadPoolsStatsIndex :: NodeThreadPoolStats
1161− , nodeThreadPoolsStatsListener :: Maybe NodeThreadPoolStats
1162− , nodeThreadPoolsStatsFetchShardStarted :: Maybe NodeThreadPoolStats
1163− , nodeThreadPoolsStatsPercolate :: Maybe NodeThreadPoolStats
1164− } deriving (Eq, Show)
1165−
1166−data NodeThreadPoolStats = NodeThreadPoolStats {
1167− nodeThreadPoolCompleted :: Int
1168− , nodeThreadPoolLargest :: Int
1169− , nodeThreadPoolRejected :: Int
1170− , nodeThreadPoolActive :: Int
1171− , nodeThreadPoolQueue :: Int
1172− , nodeThreadPoolThreads :: Int
1173− } deriving (Eq, Show)
1174−
1175−data NodeJVMStats = NodeJVMStats {
1176− nodeJVMStatsMappedBufferPool :: JVMBufferPoolStats
1177− , nodeJVMStatsDirectBufferPool :: JVMBufferPoolStats
1178− , nodeJVMStatsGCOldCollector :: JVMGCStats
1179− , nodeJVMStatsGCYoungCollector :: JVMGCStats
1180− , nodeJVMStatsPeakThreadsCount :: Int
1181− , nodeJVMStatsThreadsCount :: Int
1182− , nodeJVMStatsOldPool :: JVMPoolStats
1183− , nodeJVMStatsSurvivorPool :: JVMPoolStats
1184− , nodeJVMStatsYoungPool :: JVMPoolStats
1185− , nodeJVMStatsNonHeapCommitted :: Bytes
1186− , nodeJVMStatsNonHeapUsed :: Bytes
1187− , nodeJVMStatsHeapMax :: Bytes
1188− , nodeJVMStatsHeapCommitted :: Bytes
1189− , nodeJVMStatsHeapUsedPercent :: Int
1190− , nodeJVMStatsHeapUsed :: Bytes
1191− , nodeJVMStatsUptime :: NominalDiffTime
1192− , nodeJVMStatsTimestamp :: UTCTime
1193− } deriving (Eq, Show)
1194−
1195−data JVMBufferPoolStats = JVMBufferPoolStats {
1196− jvmBufferPoolStatsTotalCapacity :: Bytes
1197− , jvmBufferPoolStatsUsed :: Bytes
1198− , jvmBufferPoolStatsCount :: Int
1199− } deriving (Eq, Show)
1200−
1201−data JVMGCStats = JVMGCStats {
1202− jvmGCStatsCollectionTime :: NominalDiffTime
1203− , jvmGCStatsCollectionCount :: Int
1204− } deriving (Eq, Show)
1205−
1206−data JVMPoolStats = JVMPoolStats {
1207− jvmPoolStatsPeakMax :: Bytes
1208− , jvmPoolStatsPeakUsed :: Bytes
1209− , jvmPoolStatsMax :: Bytes
1210− , jvmPoolStatsUsed :: Bytes
1211− } deriving (Eq, Show)
1212−
1213−data NodeProcessStats = NodeProcessStats {
1214− nodeProcessTimestamp :: UTCTime
1215− , nodeProcessOpenFDs :: Int
1216− , nodeProcessMaxFDs :: Int
1217− , nodeProcessCPUPercent :: Int
1218− , nodeProcessCPUTotal :: NominalDiffTime
1219− , nodeProcessMemTotalVirtual :: Bytes
1220− } deriving (Eq, Show)
1221−
1222−data NodeOSStats = NodeOSStats {
1223− nodeOSTimestamp :: UTCTime
1224− , nodeOSCPUPercent :: Int
1225− , nodeOSLoad :: Maybe LoadAvgs
1226− , nodeOSMemTotal :: Bytes
1227− , nodeOSMemFree :: Bytes
1228− , nodeOSMemFreePercent :: Int
1229− , nodeOSMemUsed :: Bytes
1230− , nodeOSMemUsedPercent :: Int
1231− , nodeOSSwapTotal :: Bytes
1232− , nodeOSSwapFree :: Bytes
1233− , nodeOSSwapUsed :: Bytes
1234− } deriving (Eq, Show)
1235−
1236−data LoadAvgs = LoadAvgs {
1237− loadAvg1Min :: Double
1238− , loadAvg5Min :: Double
1239− , loadAvg15Min :: Double
1240− } deriving (Eq, Show)
1241−
1242−data NodeIndicesStats = NodeIndicesStats {
1243− nodeIndicesStatsRecoveryThrottleTime :: Maybe NominalDiffTime
1244− , nodeIndicesStatsRecoveryCurrentAsTarget :: Maybe Int
1245− , nodeIndicesStatsRecoveryCurrentAsSource :: Maybe Int
1246− , nodeIndicesStatsQueryCacheMisses :: Maybe Int
1247− , nodeIndicesStatsQueryCacheHits :: Maybe Int
1248− , nodeIndicesStatsQueryCacheEvictions :: Maybe Int
1249− , nodeIndicesStatsQueryCacheSize :: Maybe Bytes
1250− , nodeIndicesStatsSuggestCurrent :: Maybe Int
1251− , nodeIndicesStatsSuggestTime :: Maybe NominalDiffTime
1252− , nodeIndicesStatsSuggestTotal :: Maybe Int
1253− , nodeIndicesStatsTranslogSize :: Bytes
1254− , nodeIndicesStatsTranslogOps :: Int
1255− , nodeIndicesStatsSegFixedBitSetMemory :: Maybe Bytes
1256− , nodeIndicesStatsSegVersionMapMemory :: Bytes
1257− , nodeIndicesStatsSegIndexWriterMaxMemory :: Maybe Bytes
1258− , nodeIndicesStatsSegIndexWriterMemory :: Bytes
1259− , nodeIndicesStatsSegMemory :: Bytes
1260− , nodeIndicesStatsSegCount :: Int
1261− , nodeIndicesStatsCompletionSize :: Bytes
1262− , nodeIndicesStatsPercolateQueries :: Maybe Int
1263− , nodeIndicesStatsPercolateMemory :: Maybe Bytes
1264− , nodeIndicesStatsPercolateCurrent :: Maybe Int
1265− , nodeIndicesStatsPercolateTime :: Maybe NominalDiffTime
1266− , nodeIndicesStatsPercolateTotal :: Maybe Int
1267− , nodeIndicesStatsFieldDataEvictions :: Int
1268− , nodeIndicesStatsFieldDataMemory :: Bytes
1269− , nodeIndicesStatsWarmerTotalTime :: NominalDiffTime
1270− , nodeIndicesStatsWarmerTotal :: Int
1271− , nodeIndicesStatsWarmerCurrent :: Int
1272− , nodeIndicesStatsFlushTotalTime :: NominalDiffTime
1273− , nodeIndicesStatsFlushTotal :: Int
1274− , nodeIndicesStatsRefreshTotalTime :: NominalDiffTime
1275− , nodeIndicesStatsRefreshTotal :: Int
1276− , nodeIndicesStatsMergesTotalSize :: Bytes
1277− , nodeIndicesStatsMergesTotalDocs :: Int
1278− , nodeIndicesStatsMergesTotalTime :: NominalDiffTime
1279− , nodeIndicesStatsMergesTotal :: Int
1280− , nodeIndicesStatsMergesCurrentSize :: Bytes
1281− , nodeIndicesStatsMergesCurrentDocs :: Int
1282− , nodeIndicesStatsMergesCurrent :: Int
1283− , nodeIndicesStatsSearchFetchCurrent :: Int
1284− , nodeIndicesStatsSearchFetchTime :: NominalDiffTime
1285− , nodeIndicesStatsSearchFetchTotal :: Int
1286− , nodeIndicesStatsSearchQueryCurrent :: Int
1287− , nodeIndicesStatsSearchQueryTime :: NominalDiffTime
1288− , nodeIndicesStatsSearchQueryTotal :: Int
1289− , nodeIndicesStatsSearchOpenContexts :: Int
1290− , nodeIndicesStatsGetCurrent :: Int
1291− , nodeIndicesStatsGetMissingTime :: NominalDiffTime
1292− , nodeIndicesStatsGetMissingTotal :: Int
1293− , nodeIndicesStatsGetExistsTime :: NominalDiffTime
1294− , nodeIndicesStatsGetExistsTotal :: Int
1295− , nodeIndicesStatsGetTime :: NominalDiffTime
1296− , nodeIndicesStatsGetTotal :: Int
1297− , nodeIndicesStatsIndexingThrottleTime :: Maybe NominalDiffTime
1298− , nodeIndicesStatsIndexingIsThrottled :: Maybe Bool
1299− , nodeIndicesStatsIndexingNoopUpdateTotal :: Maybe Int
1300− , nodeIndicesStatsIndexingDeleteCurrent :: Int
1301− , nodeIndicesStatsIndexingDeleteTime :: NominalDiffTime
1302− , nodeIndicesStatsIndexingDeleteTotal :: Int
1303− , nodeIndicesStatsIndexingIndexCurrent :: Int
1304− , nodeIndicesStatsIndexingIndexTime :: NominalDiffTime
1305− , nodeIndicesStatsIndexingTotal :: Int
1306− , nodeIndicesStatsStoreThrottleTime :: NominalDiffTime
1307− , nodeIndicesStatsStoreSize :: Bytes
1308− , nodeIndicesStatsDocsDeleted :: Int
1309− , nodeIndicesStatsDocsCount :: Int
1310− } deriving (Eq, Show)
1311−
1312−-- | A quirky address format used throughout Elasticsearch. An example
1313−-- would be inet[/1.1.1.1:9200]. inet may be a placeholder for a
1314−-- <https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN>.
1315−newtype EsAddress = EsAddress { esAddress :: Text }
1316− deriving (Eq, Ord, Show, FromJSON)
1317−
1318−-- | Typically a 7 character hex string.
1319−newtype BuildHash = BuildHash { buildHash :: Text }
1320− deriving (Eq, Ord, Show, FromJSON, ToJSON)
1321−
1322−newtype PluginName = PluginName { pluginName :: Text }
1323− deriving (Eq, Ord, Show, FromJSON)
1324−
1325−data NodeInfo = NodeInfo {
1326− nodeInfoHTTPAddress :: Maybe EsAddress
1327− , nodeInfoBuild :: BuildHash
1328− , nodeInfoESVersion :: VersionNumber
1329− , nodeInfoIP :: Server
1330− , nodeInfoHost :: Server
1331− , nodeInfoTransportAddress :: EsAddress
1332− , nodeInfoName :: NodeName
1333− , nodeInfoFullId :: FullNodeId
1334− , nodeInfoPlugins :: [NodePluginInfo]
1335− , nodeInfoHTTP :: NodeHTTPInfo
1336− , nodeInfoTransport :: NodeTransportInfo
1337− , nodeInfoNetwork :: Maybe NodeNetworkInfo
1338− , nodeInfoThreadPool :: NodeThreadPoolsInfo
1339− , nodeInfoJVM :: NodeJVMInfo
1340− , nodeInfoProcess :: NodeProcessInfo
1341− , nodeInfoOS :: NodeOSInfo
1342− , nodeInfoSettings :: Object
1343− -- ^ The members of the settings objects are not consistent,
1344− -- dependent on plugins, etc.
1345− } deriving (Eq, Show)
1346−
1347−data NodePluginInfo = NodePluginInfo {
1348− nodePluginSite :: Maybe Bool
1349− -- ^ Is this a site plugin?
1350− , nodePluginJVM :: Maybe Bool
1351− -- ^ Is this plugin running on the JVM
1352− , nodePluginDescription :: Text
1353− , nodePluginVersion :: MaybeNA VersionNumber
1354− , nodePluginName :: PluginName
1355− } deriving (Eq, Show)
1356−
1357−data NodeHTTPInfo = NodeHTTPInfo {
1358− nodeHTTPMaxContentLength :: Bytes
1359− , nodeHTTPTransportAddress :: BoundTransportAddress
1360− } deriving (Eq, Show)
1361−
1362−data NodeTransportInfo = NodeTransportInfo {
1363− nodeTransportProfiles :: [BoundTransportAddress]
1364− , nodeTransportAddress :: BoundTransportAddress
1365− } deriving (Eq, Show)
1366−
1367−data BoundTransportAddress = BoundTransportAddress {
1368− publishAddress :: EsAddress
1369− , boundAddress :: [EsAddress]
1370− } deriving (Eq, Show)
1371−
1372−data NodeNetworkInfo = NodeNetworkInfo {
1373− nodeNetworkPrimaryInterface :: NodeNetworkInterface
1374− , nodeNetworkRefreshInterval :: NominalDiffTime
1375− } deriving (Eq, Show)
1376−
1377−newtype MacAddress = MacAddress { macAddress :: Text }
1378− deriving (Eq, Ord, Show, FromJSON)
1379−
1380−newtype NetworkInterfaceName = NetworkInterfaceName { networkInterfaceName :: Text }
1381− deriving (Eq, Ord, Show, FromJSON)
1382−
1383−data NodeNetworkInterface = NodeNetworkInterface {
1384− nodeNetIfaceMacAddress :: MacAddress
1385− , nodeNetIfaceName :: NetworkInterfaceName
1386− , nodeNetIfaceAddress :: Server
1387− } deriving (Eq, Show)
1388−
1389−data NodeThreadPoolsInfo = NodeThreadPoolsInfo {
1390− nodeThreadPoolsRefresh :: NodeThreadPoolInfo
1391− , nodeThreadPoolsManagement :: NodeThreadPoolInfo
1392− , nodeThreadPoolsPercolate :: Maybe NodeThreadPoolInfo
1393− , nodeThreadPoolsListener :: Maybe NodeThreadPoolInfo
1394− , nodeThreadPoolsFetchShardStarted :: Maybe NodeThreadPoolInfo
1395− , nodeThreadPoolsSearch :: NodeThreadPoolInfo
1396− , nodeThreadPoolsFlush :: NodeThreadPoolInfo
1397− , nodeThreadPoolsWarmer :: NodeThreadPoolInfo
1398− , nodeThreadPoolsOptimize :: Maybe NodeThreadPoolInfo
1399− , nodeThreadPoolsBulk :: NodeThreadPoolInfo
1400− , nodeThreadPoolsSuggest :: Maybe NodeThreadPoolInfo
1401− , nodeThreadPoolsMerge :: NodeThreadPoolInfo
1402− , nodeThreadPoolsSnapshot :: NodeThreadPoolInfo
1403− , nodeThreadPoolsGet :: NodeThreadPoolInfo
1404− , nodeThreadPoolsFetchShardStore :: Maybe NodeThreadPoolInfo
1405− , nodeThreadPoolsIndex :: NodeThreadPoolInfo
1406− , nodeThreadPoolsGeneric :: NodeThreadPoolInfo
1407− } deriving (Eq, Show)
1408−
1409−data NodeThreadPoolInfo = NodeThreadPoolInfo {
1410− nodeThreadPoolQueueSize :: ThreadPoolSize
1411− , nodeThreadPoolKeepalive :: Maybe NominalDiffTime
1412− , nodeThreadPoolMin :: Maybe Int
1413− , nodeThreadPoolMax :: Maybe Int
1414− , nodeThreadPoolType :: ThreadPoolType
1415− } deriving (Eq, Show)
1416−
1417−data ThreadPoolSize = ThreadPoolBounded Int
1418− | ThreadPoolUnbounded
1419− deriving (Eq, Show)
1420−
1421−data ThreadPoolType = ThreadPoolScaling
1422− | ThreadPoolFixed
1423− | ThreadPoolCached
1424− deriving (Eq, Show)
1425−
1426−data NodeJVMInfo = NodeJVMInfo {
1427− nodeJVMInfoMemoryPools :: [JVMMemoryPool]
1428− , nodeJVMInfoMemoryPoolsGCCollectors :: [JVMGCCollector]
1429− , nodeJVMInfoMemoryInfo :: JVMMemoryInfo
1430− , nodeJVMInfoStartTime :: UTCTime
1431− , nodeJVMInfoVMVendor :: Text
1432− , nodeJVMVMVersion :: VMVersion
1433− -- ^ JVM doesn't seme to follow normal version conventions
1434− , nodeJVMVMName :: Text
1435− , nodeJVMVersion :: JVMVersion
1436− , nodeJVMPID :: PID
1437− } deriving (Eq, Show)
1438−
1439−-- | We cannot parse JVM version numbers and we're not going to try.
1440−newtype JVMVersion =
1441− JVMVersion { unJVMVersion :: Text }
1442− deriving (Eq, Show)
1443−
1444−instance FromJSON JVMVersion where
1445− parseJSON = withText "JVMVersion" (pure . JVMVersion)
1446−
1447−data JVMMemoryInfo = JVMMemoryInfo {
1448− jvmMemoryInfoDirectMax :: Bytes
1449− , jvmMemoryInfoNonHeapMax :: Bytes
1450− , jvmMemoryInfoNonHeapInit :: Bytes
1451− , jvmMemoryInfoHeapMax :: Bytes
1452− , jvmMemoryInfoHeapInit :: Bytes
1453− } deriving (Eq, Show)
1454−
1455−-- VM version numbers don't appear to be SemVer
1456−-- so we're special casing this jawn.
1457−newtype VMVersion =
1458− VMVersion { unVMVersion :: Text }
1459− deriving (Eq, Show)
1460−
1461−instance ToJSON VMVersion where
1462− toJSON = toJSON . unVMVersion
1463−
1464−instance FromJSON VMVersion where
1465− parseJSON = withText "VMVersion" (pure . VMVersion)
1466−
1467−newtype JVMMemoryPool = JVMMemoryPool {
1468− jvmMemoryPool :: Text
1469− } deriving (Eq, Show, FromJSON)
1470−
1471−newtype JVMGCCollector = JVMGCCollector {
1472− jvmGCCollector :: Text
1473− } deriving (Eq, Show, FromJSON)
1474−
1475−newtype PID = PID {
1476− pid :: Int
1477− } deriving (Eq, Show, FromJSON)
1478−
1479−data NodeOSInfo = NodeOSInfo {
1480− nodeOSRefreshInterval :: NominalDiffTime
1481− , nodeOSName :: Text
1482− , nodeOSArch :: Text
1483− , nodeOSVersion :: VersionNumber
1484− , nodeOSAvailableProcessors :: Int
1485− , nodeOSAllocatedProcessors :: Int
1486− } deriving (Eq, Show)
1487−
1488−data CPUInfo = CPUInfo {
1489− cpuCacheSize :: Bytes
1490− , cpuCoresPerSocket :: Int
1491− , cpuTotalSockets :: Int
1492− , cpuTotalCores :: Int
1493− , cpuMHZ :: Int
1494− , cpuModel :: Text
1495− , cpuVendor :: Text
1496− } deriving (Eq, Show)
1497−
1498−data NodeProcessInfo = NodeProcessInfo {
1499− nodeProcessMLockAll :: Bool
1500− -- ^ See <https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-configuration.html>
1501− , nodeProcessMaxFileDescriptors :: Maybe Int
1502− , nodeProcessId :: PID
1503− , nodeProcessRefreshInterval :: NominalDiffTime
1504− } deriving (Eq, Show)
1505−
1506−data ShardResult =
1507− ShardResult { shardTotal :: Int
1508− , shardsSuccessful :: Int
1509− , shardsFailed :: Int } deriving (Eq, Show)
1510−
1511−instance FromJSON ShardResult where
1512− parseJSON (Object v) = ShardResult <$>
1513− v .: "total" <*>
1514− v .: "successful" <*>
1515− v .: "failed"
1516− parseJSON _ = empty
1517−
1518−data SnapshotState = SnapshotInit
1519− | SnapshotStarted
1520− | SnapshotSuccess
1521− | SnapshotFailed
1522− | SnapshotAborted
1523− | SnapshotMissing
1524− | SnapshotWaiting
1525− deriving (Eq, Show)
1526−
1527−instance FromJSON SnapshotState where
1528− parseJSON = withText "SnapshotState" parse
1529− where
1530− parse "INIT" = return SnapshotInit
1531− parse "STARTED" = return SnapshotStarted
1532− parse "SUCCESS" = return SnapshotSuccess
1533− parse "FAILED" = return SnapshotFailed
1534− parse "ABORTED" = return SnapshotAborted
1535− parse "MISSING" = return SnapshotMissing
1536− parse "WAITING" = return SnapshotWaiting
1537− parse t = fail ("Invalid snapshot state " <> T.unpack t)
1538−
1539−
1540−data SnapshotRestoreSettings = SnapshotRestoreSettings {
1541− snapRestoreWaitForCompletion :: Bool
1542− -- ^ Should the API call return immediately after initializing
1543− -- the restore or wait until completed? Note that if this is
1544− -- enabled, it could wait a long time, so you should adjust your
1545− -- 'ManagerSettings' accordingly to set long timeouts or
1546− -- explicitly handle timeouts.
1547− , snapRestoreIndices :: Maybe IndexSelection
1548− -- ^ Nothing will restore all indices in the snapshot. Just [] is
1549− -- permissable and will essentially be a no-op restore.
1550− , snapRestoreIgnoreUnavailable :: Bool
1551− -- ^ If set to True, any indices that do not exist will be ignored
1552− -- during snapshot rather than failing the restore.
1553− , snapRestoreIncludeGlobalState :: Bool
1554− -- ^ If set to false, will ignore any global state in the snapshot
1555− -- and will not restore it.
1556− , snapRestoreRenamePattern :: Maybe RestoreRenamePattern
1557− -- ^ A regex pattern for matching indices. Used with
1558− -- 'snapRestoreRenameReplacement', the restore can reference the
1559− -- matched index and create a new index name upon restore.
1560− , snapRestoreRenameReplacement :: Maybe (NonEmpty RestoreRenameToken)
1561− -- ^ Expression of how index renames should be constructed.
1562− , snapRestorePartial :: Bool
1563− -- ^ If some indices fail to restore, should the process proceed?
1564− , snapRestoreIncludeAliases :: Bool
1565− -- ^ Should the restore also restore the aliases captured in the
1566− -- snapshot.
1567− , snapRestoreIndexSettingsOverrides :: Maybe RestoreIndexSettings
1568− -- ^ Settings to apply during the restore process. __NOTE:__ This
1569− -- option is not supported in ES < 1.5 and should be set to
1570− -- Nothing in that case.
1571− , snapRestoreIgnoreIndexSettings :: Maybe (NonEmpty Text)
1572− -- ^ This type could be more rich but it isn't clear which
1573− -- settings are allowed to be ignored during restore, so we're
1574− -- going with including this feature in a basic form rather than
1575− -- omitting it. One example here would be
1576− -- "index.refresh_interval". Any setting specified here will
1577− -- revert back to the server default during the restore process.
1578− } deriving (Eq, Show)
1579−
1580−newtype SnapshotRepoUpdateSettings = SnapshotRepoUpdateSettings
1581− { repoUpdateVerify :: Bool
1582− -- ^ After creation/update, synchronously check that nodes can
1583− -- write to this repo. Defaults to True. You may use False if you
1584− -- need a faster response and plan on verifying manually later
1585− -- with 'verifySnapshotRepo'.
1586− } deriving (Eq, Show)
1587−
1588−
1589−-- | Reasonable defaults for repo creation/update
1590−--
1591−-- * repoUpdateVerify True
1592−defaultSnapshotRepoUpdateSettings :: SnapshotRepoUpdateSettings
1593−defaultSnapshotRepoUpdateSettings = SnapshotRepoUpdateSettings True
1594−
1595−
1596−-- | A filesystem-based snapshot repo that ships with
1597−-- Elasticsearch. This is an instance of 'SnapshotRepo' so it can be
1598−-- used with 'updateSnapshotRepo'
1599−data FsSnapshotRepo = FsSnapshotRepo {
1600− fsrName :: SnapshotRepoName
1601− , fsrLocation :: FilePath
1602− , fsrCompressMetadata :: Bool
1603− , fsrChunkSize :: Maybe Bytes
1604− -- ^ Size by which to split large files during snapshotting.
1605− , fsrMaxRestoreBytesPerSec :: Maybe Bytes
1606− -- ^ Throttle node restore rate. If not supplied, defaults to 40mb/sec
1607− , fsrMaxSnapshotBytesPerSec :: Maybe Bytes
1608− -- ^ Throttle node snapshot rate. If not supplied, defaults to 40mb/sec
1609− } deriving (Eq, Show)
1610−
1611−
1612−instance SnapshotRepo FsSnapshotRepo where
1613− toGSnapshotRepo FsSnapshotRepo {..} =
1614− GenericSnapshotRepo fsrName fsRepoType (GenericSnapshotRepoSettings settings)
1615− where
1616− Object settings = object $ [ "location" .= fsrLocation
1617− , "compress" .= fsrCompressMetadata
1618− ] ++ optionalPairs
1619− optionalPairs = catMaybes [ ("chunk_size" .=) <$> fsrChunkSize
1620− , ("max_restore_bytes_per_sec" .=) <$> fsrMaxRestoreBytesPerSec
1621− , ("max_snapshot_bytes_per_sec" .=) <$> fsrMaxSnapshotBytesPerSec
1622− ]
1623− fromGSnapshotRepo GenericSnapshotRepo {..}
1624− | gSnapshotRepoType == fsRepoType = do
1625− let o = gSnapshotRepoSettingsObject gSnapshotRepoSettings
1626− parseRepo $
1627− FsSnapshotRepo gSnapshotRepoName <$> o .: "location"
1628− <*> o .:? "compress" .!= False
1629− <*> o .:? "chunk_size"
1630− <*> o .:? "max_restore_bytes_per_sec"
1631− <*> o .:? "max_snapshot_bytes_per_sec"
1632− | otherwise = Left (RepoTypeMismatch fsRepoType gSnapshotRepoType)
1633−
1634−
1635−parseRepo :: Parser a -> Either SnapshotRepoConversionError a
1636−parseRepo parser = case parseEither (const parser) () of
1637− Left e -> Left (OtherRepoConversionError (T.pack e))
1638− Right a -> Right a
1639−
1640−
1641−fsRepoType :: SnapshotRepoType
1642−fsRepoType = SnapshotRepoType "fs"
1643−
1644−-- | Law: fromGSnapshotRepo (toGSnapshotRepo r) == Right r
1645−class SnapshotRepo r where
1646− toGSnapshotRepo :: r -> GenericSnapshotRepo
1647− fromGSnapshotRepo :: GenericSnapshotRepo -> Either SnapshotRepoConversionError r
1648−
1649−
1650−data SnapshotRepoConversionError = RepoTypeMismatch SnapshotRepoType SnapshotRepoType
1651− -- ^ Expected type and actual type
1652− | OtherRepoConversionError Text
1653− deriving (Show, Eq)
1654−
1655−
1656−instance Exception SnapshotRepoConversionError
1657−
1658−
1659−data SnapshotCreateSettings = SnapshotCreateSettings {
1660− snapWaitForCompletion :: Bool
1661− -- ^ Should the API call return immediately after initializing
1662− -- the snapshot or wait until completed? Note that if this is
1663− -- enabled it could wait a long time, so you should adjust your
1664− -- 'ManagerSettings' accordingly to set long timeouts or
1665− -- explicitly handle timeouts.
1666− , snapIndices :: Maybe IndexSelection
1667− -- ^ Nothing will snapshot all indices. Just [] is permissable and
1668− -- will essentially be a no-op snapshot.
1669− , snapIgnoreUnavailable :: Bool
1670− -- ^ If set to True, any matched indices that don't exist will be
1671− -- ignored. Otherwise it will be an error and fail.
1672− , snapIncludeGlobalState :: Bool
1673− , snapPartial :: Bool
1674− -- ^ If some indices failed to snapshot (e.g. if not all primary
1675− -- shards are available), should the process proceed?
1676− } deriving (Eq, Show)
1677−
1678−
1679−-- | Reasonable defaults for snapshot creation
1680−--
1681−-- * snapWaitForCompletion False
1682−-- * snapIndices Nothing
1683−-- * snapIgnoreUnavailable False
1684−-- * snapIncludeGlobalState True
1685−-- * snapPartial False
1686−defaultSnapshotCreateSettings :: SnapshotCreateSettings
1687−defaultSnapshotCreateSettings = SnapshotCreateSettings {
1688− snapWaitForCompletion = False
1689− , snapIndices = Nothing
1690− , snapIgnoreUnavailable = False
1691− , snapIncludeGlobalState = True
1692− , snapPartial = False
1693− }
1694−
1695−
1696−data SnapshotSelection =
1697− SnapshotList (NonEmpty SnapshotPattern)
1698− | AllSnapshots
1699− deriving (Eq, Show)
1700−
1701−
1702−-- | Either specifies an exact snapshot name or one with globs in it,
1703−-- e.g. @SnapPattern "foo*"@ __NOTE__: Patterns are not supported on
1704−-- ES < 1.7
1705−data SnapshotPattern =
1706− ExactSnap SnapshotName
1707− | SnapPattern Text
1708− deriving (Eq, Show)
1709−
1710−
1711−-- | General information about the state of a snapshot. Has some
1712−-- redundancies with 'SnapshotStatus'
1713−data SnapshotInfo = SnapshotInfo {
1714− snapInfoShards :: ShardResult
1715− , snapInfoFailures :: [SnapshotShardFailure]
1716− , snapInfoDuration :: NominalDiffTime
1717− , snapInfoEndTime :: UTCTime
1718− , snapInfoStartTime :: UTCTime
1719− , snapInfoState :: SnapshotState
1720− , snapInfoIndices :: [IndexName]
1721− , snapInfoName :: SnapshotName
1722− } deriving (Eq, Show)
1723−
1724−
1725−instance FromJSON SnapshotInfo where
1726− parseJSON = withObject "SnapshotInfo" parse
1727− where
1728− parse o = SnapshotInfo <$> o .: "shards"
1729− <*> o .: "failures"
1730− <*> (unMS <$> o .: "duration_in_millis")
1731− <*> (posixMS <$> o .: "end_time_in_millis")
1732− <*> (posixMS <$> o .: "start_time_in_millis")
1733− <*> o .: "state"
1734− <*> o .: "indices"
1735− <*> o .: "snapshot"
1736−
1737−data SnapshotShardFailure = SnapshotShardFailure {
1738− snapShardFailureIndex :: IndexName
1739− , snapShardFailureNodeId :: Maybe NodeName -- I'm not 100% sure this isn't actually 'FullNodeId'
1740− , snapShardFailureReason :: Text
1741− , snapShardFailureShardId :: ShardId
1742− } deriving (Eq, Show)
1743−
1744−
1745−instance FromJSON SnapshotShardFailure where
1746− parseJSON = withObject "SnapshotShardFailure" parse
1747− where
1748− parse o = SnapshotShardFailure <$> o .: "index"
1749− <*> o .:? "node_id"
1750− <*> o .: "reason"
1751− <*> o .: "shard_id"
1752−
1753−-- | Regex-stype pattern, e.g. "index_(.+)" to match index names
1754−newtype RestoreRenamePattern =
1755− RestoreRenamePattern { rrPattern :: Text }
1756− deriving (Eq, Show, Ord, ToJSON)
1757−
1758−
1759−-- | A single token in a index renaming scheme for a restore. These
1760−-- are concatenated into a string before being sent to
1761−-- Elasticsearch. Check out these Java
1762−-- <https://docs.oracle.com/javase/7/docs/api/java/util/regex/Matcher.html docs> to find out more if you're into that sort of thing.
1763−data RestoreRenameToken = RRTLit Text
1764− -- ^ Just a literal string of characters
1765− | RRSubWholeMatch
1766− -- ^ Equivalent to $0. The entire matched pattern, not any subgroup
1767− | RRSubGroup RRGroupRefNum
1768− -- ^ A specific reference to a group number
1769− deriving (Eq, Show)
1770−
1771−
1772−-- | A group number for regex matching. Only values from 1-9 are
1773−-- supported. Construct with 'mkRRGroupRefNum'
1774−newtype RRGroupRefNum =
1775− RRGroupRefNum { rrGroupRefNum :: Int }
1776− deriving (Eq, Ord, Show)
1777−
1778−instance Bounded RRGroupRefNum where
1779− minBound = RRGroupRefNum 1
1780− maxBound = RRGroupRefNum 9
1781−
1782−
1783−-- | Only allows valid group number references (1-9).
1784−mkRRGroupRefNum :: Int -> Maybe RRGroupRefNum
1785−mkRRGroupRefNum i
1786− | i >= rrGroupRefNum minBound
1787− && i <= rrGroupRefNum maxBound =
1788− Just $ RRGroupRefNum i
1789− | otherwise = Nothing
1790−
1791−-- | Reasonable defaults for snapshot restores
1792−--
1793−-- * snapRestoreWaitForCompletion False
1794−-- * snapRestoreIndices Nothing
1795−-- * snapRestoreIgnoreUnavailable False
1796−-- * snapRestoreIncludeGlobalState True
1797−-- * snapRestoreRenamePattern Nothing
1798−-- * snapRestoreRenameReplacement Nothing
1799−-- * snapRestorePartial False
1800−-- * snapRestoreIncludeAliases True
1801−-- * snapRestoreIndexSettingsOverrides Nothing
1802−-- * snapRestoreIgnoreIndexSettings Nothing
1803−defaultSnapshotRestoreSettings :: SnapshotRestoreSettings
1804−defaultSnapshotRestoreSettings = SnapshotRestoreSettings {
1805− snapRestoreWaitForCompletion = False
1806− , snapRestoreIndices = Nothing
1807− , snapRestoreIgnoreUnavailable = False
1808− , snapRestoreIncludeGlobalState = True
1809− , snapRestoreRenamePattern = Nothing
1810− , snapRestoreRenameReplacement = Nothing
1811− , snapRestorePartial = False
1812− , snapRestoreIncludeAliases = True
1813− , snapRestoreIndexSettingsOverrides = Nothing
1814− , snapRestoreIgnoreIndexSettings = Nothing
1815− }
1816−
1817−
1818−-- | Index settings that can be overridden. The docs only mention you
1819−-- can update number of replicas, but there may be more. You
1820−-- definitely cannot override shard count.
1821−newtype RestoreIndexSettings = RestoreIndexSettings
1822− { restoreOverrideReplicas :: Maybe ReplicaCount
1823− } deriving (Eq, Show)
1824−
1825−
1826−instance ToJSON RestoreIndexSettings where
1827− toJSON RestoreIndexSettings {..} = object prs
1828− where
1829− prs = catMaybes [("index.number_of_replicas" .=) <$> restoreOverrideReplicas]
1830−
1831−
1832−instance FromJSON NodesInfo where
1833− parseJSON = withObject "NodesInfo" parse
1834− where
1835− parse o = do
1836− nodes <- o .: "nodes"
1837− infos <- forM (HM.toList nodes) $ \(fullNID, v) -> do
1838− node <- parseJSON v
1839− parseNodeInfo (FullNodeId fullNID) node
1840− cn <- o .: "cluster_name"
1841− return (NodesInfo infos cn)
1842−
1843−instance FromJSON NodesStats where
1844− parseJSON = withObject "NodesStats" parse
1845− where
1846− parse o = do
1847− nodes <- o .: "nodes"
1848− stats <- forM (HM.toList nodes) $ \(fullNID, v) -> do
1849− node <- parseJSON v
1850− parseNodeStats (FullNodeId fullNID) node
1851− cn <- o .: "cluster_name"
1852− return (NodesStats stats cn)
1853−
1854−instance FromJSON NodeBreakerStats where
1855− parseJSON = withObject "NodeBreakerStats" parse
1856− where
1857− parse o = NodeBreakerStats <$> o .: "tripped"
1858− <*> o .: "overhead"
1859− <*> o .: "estimated_size_in_bytes"
1860− <*> o .: "limit_size_in_bytes"
1861−
1862−instance FromJSON NodeHTTPStats where
1863− parseJSON = withObject "NodeHTTPStats" parse
1864− where
1865− parse o = NodeHTTPStats <$> o .: "total_opened"
1866− <*> o .: "current_open"
1867−
1868−instance FromJSON NodeTransportStats where
1869− parseJSON = withObject "NodeTransportStats" parse
1870− where
1871− parse o = NodeTransportStats <$> o .: "tx_size_in_bytes"
1872− <*> o .: "tx_count"
1873− <*> o .: "rx_size_in_bytes"
1874− <*> o .: "rx_count"
1875− <*> o .: "server_open"
1876−
1877−instance FromJSON NodeFSStats where
1878− parseJSON = withObject "NodeFSStats" parse
1879− where
1880− parse o = NodeFSStats <$> o .: "data"
1881− <*> o .: "total"
1882− <*> (posixMS <$> o .: "timestamp")
1883−
1884−instance FromJSON NodeDataPathStats where
1885− parseJSON = withObject "NodeDataPathStats" parse
1886− where
1887− parse o =
1888− NodeDataPathStats <$> (fmap unStringlyTypedDouble <$> o .:? "disk_service_time")
1889− <*> (fmap unStringlyTypedDouble <$> o .:? "disk_queue")
1890− <*> o .:? "disk_io_size_in_bytes"
1891− <*> o .:? "disk_write_size_in_bytes"
1892− <*> o .:? "disk_read_size_in_bytes"
1893− <*> o .:? "disk_io_op"
1894− <*> o .:? "disk_writes"
1895− <*> o .:? "disk_reads"
1896− <*> o .: "available_in_bytes"
1897− <*> o .: "free_in_bytes"
1898− <*> o .: "total_in_bytes"
1899− <*> o .:? "type"
1900− <*> o .:? "dev"
1901− <*> o .: "mount"
1902− <*> o .: "path"
1903−
1904−instance FromJSON NodeFSTotalStats where
1905− parseJSON = withObject "NodeFSTotalStats" parse
1906− where
1907− parse o = NodeFSTotalStats <$> (fmap unStringlyTypedDouble <$> o .:? "disk_service_time")
1908− <*> (fmap unStringlyTypedDouble <$> o .:? "disk_queue")
1909− <*> o .:? "disk_io_size_in_bytes"
1910− <*> o .:? "disk_write_size_in_bytes"
1911− <*> o .:? "disk_read_size_in_bytes"
1912− <*> o .:? "disk_io_op"
1913− <*> o .:? "disk_writes"
1914− <*> o .:? "disk_reads"
1915− <*> o .: "available_in_bytes"
1916− <*> o .: "free_in_bytes"
1917− <*> o .: "total_in_bytes"
1918−
1919−instance FromJSON NodeNetworkStats where
1920− parseJSON = withObject "NodeNetworkStats" parse
1921− where
1922− parse o = do
1923− tcp <- o .: "tcp"
1924− NodeNetworkStats <$> tcp .: "out_rsts"
1925− <*> tcp .: "in_errs"
1926− <*> tcp .: "attempt_fails"
1927− <*> tcp .: "estab_resets"
1928− <*> tcp .: "retrans_segs"
1929− <*> tcp .: "out_segs"
1930− <*> tcp .: "in_segs"
1931− <*> tcp .: "curr_estab"
1932− <*> tcp .: "passive_opens"
1933− <*> tcp .: "active_opens"
1934−
1935−instance FromJSON NodeThreadPoolsStats where
1936− parseJSON = withObject "NodeThreadPoolsStats" parse
1937− where
1938− parse o = NodeThreadPoolsStats <$> o .: "snapshot"
1939− <*> o .: "bulk"
1940− <*> o .: "force_merge"
1941− <*> o .: "get"
1942− <*> o .: "management"
1943− <*> o .:? "fetch_shard_store"
1944− <*> o .:? "optimize"
1945− <*> o .: "flush"
1946− <*> o .: "search"
1947− <*> o .: "warmer"
1948− <*> o .: "generic"
1949− <*> o .:? "suggest"
1950− <*> o .: "refresh"
1951− <*> o .: "index"
1952− <*> o .:? "listener"
1953− <*> o .:? "fetch_shard_started"
1954− <*> o .:? "percolate"
1955−instance FromJSON NodeThreadPoolStats where
1956− parseJSON = withObject "NodeThreadPoolStats" parse
1957− where
1958− parse o = NodeThreadPoolStats <$> o .: "completed"
1959− <*> o .: "largest"
1960− <*> o .: "rejected"
1961− <*> o .: "active"
1962− <*> o .: "queue"
1963− <*> o .: "threads"
1964−
1965−instance FromJSON NodeJVMStats where
1966− parseJSON = withObject "NodeJVMStats" parse
1967− where
1968− parse o = do
1969− bufferPools <- o .: "buffer_pools"
1970− mapped <- bufferPools .: "mapped"
1971− direct <- bufferPools .: "direct"
1972− gc <- o .: "gc"
1973− collectors <- gc .: "collectors"
1974− oldC <- collectors .: "old"
1975− youngC <- collectors .: "young"
1976− threads <- o .: "threads"
1977− mem <- o .: "mem"
1978− pools <- mem .: "pools"
1979− oldM <- pools .: "old"
1980− survivorM <- pools .: "survivor"
1981− youngM <- pools .: "young"
1982− NodeJVMStats <$> pure mapped
1983− <*> pure direct
1984− <*> pure oldC
1985− <*> pure youngC
1986− <*> threads .: "peak_count"
1987− <*> threads .: "count"
1988− <*> pure oldM
1989− <*> pure survivorM
1990− <*> pure youngM
1991− <*> mem .: "non_heap_committed_in_bytes"
1992− <*> mem .: "non_heap_used_in_bytes"
1993− <*> mem .: "heap_max_in_bytes"
1994− <*> mem .: "heap_committed_in_bytes"
1995− <*> mem .: "heap_used_percent"
1996− <*> mem .: "heap_used_in_bytes"
1997− <*> (unMS <$> o .: "uptime_in_millis")
1998− <*> (posixMS <$> o .: "timestamp")
1999−
2000−instance FromJSON JVMBufferPoolStats where
2001− parseJSON = withObject "JVMBufferPoolStats" parse
2002− where
2003− parse o = JVMBufferPoolStats <$> o .: "total_capacity_in_bytes"
2004− <*> o .: "used_in_bytes"
2005− <*> o .: "count"
2006−
2007−instance FromJSON JVMGCStats where
2008− parseJSON = withObject "JVMGCStats" parse
2009− where
2010− parse o = JVMGCStats <$> (unMS <$> o .: "collection_time_in_millis")
2011− <*> o .: "collection_count"
2012−
2013−instance FromJSON JVMPoolStats where
2014− parseJSON = withObject "JVMPoolStats" parse
2015− where
2016− parse o = JVMPoolStats <$> o .: "peak_max_in_bytes"
2017− <*> o .: "peak_used_in_bytes"
2018− <*> o .: "max_in_bytes"
2019− <*> o .: "used_in_bytes"
2020−
2021−instance FromJSON NodeProcessStats where
2022− parseJSON = withObject "NodeProcessStats" parse
2023− where
2024− parse o = do
2025− mem <- o .: "mem"
2026− cpu <- o .: "cpu"
2027− NodeProcessStats <$> (posixMS <$> o .: "timestamp")
2028− <*> o .: "open_file_descriptors"
2029− <*> o .: "max_file_descriptors"
2030− <*> cpu .: "percent"
2031− <*> (unMS <$> cpu .: "total_in_millis")
2032− <*> mem .: "total_virtual_in_bytes"
2033−
2034−instance FromJSON NodeOSStats where
2035− parseJSON = withObject "NodeOSStats" parse
2036− where
2037− parse o = do
2038− swap <- o .: "swap"
2039− mem <- o .: "mem"
2040− cpu <- o .: "cpu"
2041− load <- o .:? "load_average"
2042− NodeOSStats <$> (posixMS <$> o .: "timestamp")
2043− <*> cpu .: "percent"
2044− <*> pure load
2045− <*> mem .: "total_in_bytes"
2046− <*> mem .: "free_in_bytes"
2047− <*> mem .: "free_percent"
2048− <*> mem .: "used_in_bytes"
2049− <*> mem .: "used_percent"
2050− <*> swap .: "total_in_bytes"
2051− <*> swap .: "free_in_bytes"
2052− <*> swap .: "used_in_bytes"
2053−
2054−instance FromJSON LoadAvgs where
2055− parseJSON = withArray "LoadAvgs" parse
2056− where
2057− parse v = case V.toList v of
2058− [one, five, fifteen] -> LoadAvgs <$> parseJSON one
2059− <*> parseJSON five
2060− <*> parseJSON fifteen
2061− _ -> fail "Expecting a triple of Doubles"
2062−
2063−instance FromJSON NodeIndicesStats where
2064− parseJSON = withObject "NodeIndicesStats" parse
2065− where
2066− parse o = do
2067− let (.::) mv k = case mv of
2068− Just v -> Just <$> v .: k
2069− Nothing -> pure Nothing
2070− mRecovery <- o .:? "recovery"
2071− mQueryCache <- o .:? "query_cache"
2072− mSuggest <- o .:? "suggest"
2073− translog <- o .: "translog"
2074− segments <- o .: "segments"
2075− completion <- o .: "completion"
2076− mPercolate <- o .:? "percolate"
2077− fielddata <- o .: "fielddata"
2078− warmer <- o .: "warmer"
2079− flush <- o .: "flush"
2080− refresh <- o .: "refresh"
2081− merges <- o .: "merges"
2082− search <- o .: "search"
2083− getStats <- o .: "get"
2084− indexing <- o .: "indexing"
2085− store <- o .: "store"
2086− docs <- o .: "docs"
2087− NodeIndicesStats <$> (fmap unMS <$> mRecovery .:: "throttle_time_in_millis")
2088− <*> mRecovery .:: "current_as_target"
2089− <*> mRecovery .:: "current_as_source"
2090− <*> mQueryCache .:: "miss_count"
2091− <*> mQueryCache .:: "hit_count"
2092− <*> mQueryCache .:: "evictions"
2093− <*> mQueryCache .:: "memory_size_in_bytes"
2094− <*> mSuggest .:: "current"
2095− <*> (fmap unMS <$> mSuggest .:: "time_in_millis")
2096− <*> mSuggest .:: "total"
2097− <*> translog .: "size_in_bytes"
2098− <*> translog .: "operations"
2099− <*> segments .:? "fixed_bit_set_memory_in_bytes"
2100− <*> segments .: "version_map_memory_in_bytes"
2101− <*> segments .:? "index_writer_max_memory_in_bytes"
2102− <*> segments .: "index_writer_memory_in_bytes"
2103− <*> segments .: "memory_in_bytes"
2104− <*> segments .: "count"
2105− <*> completion .: "size_in_bytes"
2106− <*> mPercolate .:: "queries"
2107− <*> mPercolate .:: "memory_size_in_bytes"
2108− <*> mPercolate .:: "current"
2109− <*> (fmap unMS <$> mPercolate .:: "time_in_millis")
2110− <*> mPercolate .:: "total"
2111− <*> fielddata .: "evictions"
2112− <*> fielddata .: "memory_size_in_bytes"
2113− <*> (unMS <$> warmer .: "total_time_in_millis")
2114− <*> warmer .: "total"
2115− <*> warmer .: "current"
2116− <*> (unMS <$> flush .: "total_time_in_millis")
2117− <*> flush .: "total"
2118− <*> (unMS <$> refresh .: "total_time_in_millis")
2119− <*> refresh .: "total"
2120− <*> merges .: "total_size_in_bytes"
2121− <*> merges .: "total_docs"
2122− <*> (unMS <$> merges .: "total_time_in_millis")
2123− <*> merges .: "total"
2124− <*> merges .: "current_size_in_bytes"
2125− <*> merges .: "current_docs"
2126− <*> merges .: "current"
2127− <*> search .: "fetch_current"
2128− <*> (unMS <$> search .: "fetch_time_in_millis")
2129− <*> search .: "fetch_total"
2130− <*> search .: "query_current"
2131− <*> (unMS <$> search .: "query_time_in_millis")
2132− <*> search .: "query_total"
2133− <*> search .: "open_contexts"
2134− <*> getStats .: "current"
2135− <*> (unMS <$> getStats .: "missing_time_in_millis")
2136− <*> getStats .: "missing_total"
2137− <*> (unMS <$> getStats .: "exists_time_in_millis")
2138− <*> getStats .: "exists_total"
2139− <*> (unMS <$> getStats .: "time_in_millis")
2140− <*> getStats .: "total"
2141− <*> (fmap unMS <$> indexing .:? "throttle_time_in_millis")
2142− <*> indexing .:? "is_throttled"
2143− <*> indexing .:? "noop_update_total"
2144− <*> indexing .: "delete_current"
2145− <*> (unMS <$> indexing .: "delete_time_in_millis")
2146− <*> indexing .: "delete_total"
2147− <*> indexing .: "index_current"
2148− <*> (unMS <$> indexing .: "index_time_in_millis")
2149− <*> indexing .: "index_total"
2150− <*> (unMS <$> store .: "throttle_time_in_millis")
2151− <*> store .: "size_in_bytes"
2152− <*> docs .: "deleted"
2153− <*> docs .: "count"
2154−
2155−instance FromJSON NodeBreakersStats where
2156− parseJSON = withObject "NodeBreakersStats" parse
2157− where
2158− parse o = NodeBreakersStats <$> o .: "parent"
2159− <*> o .: "request"
2160− <*> o .: "fielddata"
2161−
2162−parseNodeStats :: FullNodeId -> Object -> Parser NodeStats
2163−parseNodeStats fnid o =
2164− NodeStats <$> o .: "name"
2165− <*> pure fnid
2166− <*> o .:? "breakers"
2167− <*> o .: "http"
2168− <*> o .: "transport"
2169− <*> o .: "fs"
2170− <*> o .:? "network"
2171− <*> o .: "thread_pool"
2172− <*> o .: "jvm"
2173− <*> o .: "process"
2174− <*> o .: "os"
2175− <*> o .: "indices"
2176−
2177−parseNodeInfo :: FullNodeId -> Object -> Parser NodeInfo
2178−parseNodeInfo nid o =
2179− NodeInfo <$> o .:? "http_address"
2180− <*> o .: "build_hash"
2181− <*> o .: "version"
2182− <*> o .: "ip"
2183− <*> o .: "host"
2184− <*> o .: "transport_address"
2185− <*> o .: "name"
2186− <*> pure nid
2187− <*> o .: "plugins"
2188− <*> o .: "http"
2189− <*> o .: "transport"
2190− <*> o .:? "network"
2191− <*> o .: "thread_pool"
2192− <*> o .: "jvm"
2193− <*> o .: "process"
2194− <*> o .: "os"
2195− <*> o .: "settings"
2196−
2197−instance FromJSON NodePluginInfo where
2198− parseJSON = withObject "NodePluginInfo" parse
2199− where
2200− parse o = NodePluginInfo <$> o .:? "site"
2201− <*> o .:? "jvm"
2202− <*> o .: "description"
2203− <*> o .: "version"
2204− <*> o .: "name"
2205−
2206−instance FromJSON NodeHTTPInfo where
2207− parseJSON = withObject "NodeHTTPInfo" parse
2208− where
2209− parse o = NodeHTTPInfo <$> o .: "max_content_length_in_bytes"
2210− <*> parseJSON (Object o)
2211−
2212−instance FromJSON BoundTransportAddress where
2213− parseJSON = withObject "BoundTransportAddress" parse
2214− where
2215− parse o = BoundTransportAddress <$> o .: "publish_address"
2216− <*> o .: "bound_address"
2217−
2218−instance FromJSON NodeOSInfo where
2219− parseJSON = withObject "NodeOSInfo" parse
2220− where
2221− parse o =
2222− NodeOSInfo <$> (unMS <$> o .: "refresh_interval_in_millis")
2223− <*> o .: "name"
2224− <*> o .: "arch"
2225− <*> o .: "version"
2226− <*> o .: "available_processors"
2227− <*> o .: "allocated_processors"
2228−
2229−
2230−instance FromJSON CPUInfo where
2231− parseJSON = withObject "CPUInfo" parse
2232− where
2233− parse o = CPUInfo <$> o .: "cache_size_in_bytes"
2234− <*> o .: "cores_per_socket"
2235− <*> o .: "total_sockets"
2236− <*> o .: "total_cores"
2237− <*> o .: "mhz"
2238− <*> o .: "model"
2239− <*> o .: "vendor"
2240−
2241−instance FromJSON NodeProcessInfo where
2242− parseJSON = withObject "NodeProcessInfo" parse
2243− where
2244− parse o = NodeProcessInfo <$> o .: "mlockall"
2245− <*> o .:? "max_file_descriptors"
2246− <*> o .: "id"
2247− <*> (unMS <$> o .: "refresh_interval_in_millis")
2248−
2249−instance FromJSON NodeJVMInfo where
2250− parseJSON = withObject "NodeJVMInfo" parse
2251− where
2252− parse o = NodeJVMInfo <$> o .: "memory_pools"
2253− <*> o .: "gc_collectors"
2254− <*> o .: "mem"
2255− <*> (posixMS <$> o .: "start_time_in_millis")
2256− <*> o .: "vm_vendor"
2257− <*> o .: "vm_version"
2258− <*> o .: "vm_name"
2259− <*> o .: "version"
2260− <*> o .: "pid"
2261−
2262−instance FromJSON JVMMemoryInfo where
2263− parseJSON = withObject "JVMMemoryInfo" parse
2264− where
2265− parse o = JVMMemoryInfo <$> o .: "direct_max_in_bytes"
2266− <*> o .: "non_heap_max_in_bytes"
2267− <*> o .: "non_heap_init_in_bytes"
2268− <*> o .: "heap_max_in_bytes"
2269− <*> o .: "heap_init_in_bytes"
2270−
2271−instance FromJSON NodeThreadPoolsInfo where
2272− parseJSON = withObject "NodeThreadPoolsInfo" parse
2273− where
2274− parse o = NodeThreadPoolsInfo <$> o .: "refresh"
2275− <*> o .: "management"
2276− <*> o .:? "percolate"
2277− <*> o .:? "listener"
2278− <*> o .:? "fetch_shard_started"
2279− <*> o .: "search"
2280− <*> o .: "flush"
2281− <*> o .: "warmer"
2282− <*> o .:? "optimize"
2283− <*> o .: "bulk"
2284− <*> o .:? "suggest"
2285− <*> o .: "force_merge"
2286− <*> o .: "snapshot"
2287− <*> o .: "get"
2288− <*> o .:? "fetch_shard_store"
2289− <*> o .: "index"
2290− <*> o .: "generic"
2291−
2292−instance FromJSON NodeThreadPoolInfo where
2293− parseJSON = withObject "NodeThreadPoolInfo" parse
2294− where
2295− parse o = do
2296− ka <- maybe (return Nothing) (fmap Just . parseStringInterval) =<< o .:? "keep_alive"
2297− NodeThreadPoolInfo <$> (parseJSON . unStringlyTypeJSON =<< o .: "queue_size")
2298− <*> pure ka
2299− <*> o .:? "min"
2300− <*> o .:? "max"
2301− <*> o .: "type"
2302−
2303−data TimeInterval = Weeks
2304− | Days
2305− | Hours
2306− | Minutes
2307− | Seconds deriving Eq
2308−
2309−instance Show TimeInterval where
2310− show Weeks = "w"
2311− show Days = "d"
2312− show Hours = "h"
2313− show Minutes = "m"
2314− show Seconds = "s"
2315−
2316−instance Read TimeInterval where
2317− readPrec = f =<< TR.get
2318− where
2319− f 'w' = return Weeks
2320− f 'd' = return Days
2321− f 'h' = return Hours
2322− f 'm' = return Minutes
2323− f 's' = return Seconds
2324− f _ = fail "TimeInterval expected one of w, d, h, m, s"
2325−
2326−data Interval = Year
2327− | Quarter
2328− | Month
2329− | Week
2330− | Day
2331− | Hour
2332− | Minute
2333− | Second deriving (Eq, Show)
2334−
2335−instance ToJSON Interval where
2336− toJSON Year = "year"
2337− toJSON Quarter = "quarter"
2338− toJSON Month = "month"
2339− toJSON Week = "week"
2340− toJSON Day = "day"
2341− toJSON Hour = "hour"
2342− toJSON Minute = "minute"
2343− toJSON Second = "second"
2344−
2345−parseStringInterval :: (Monad m) => String -> m NominalDiffTime
2346−parseStringInterval s = case span isNumber s of
2347− ("", _) -> fail "Invalid interval"
2348− (nS, unitS) -> case (readMay nS, readMay unitS) of
2349− (Just n, Just unit) -> return (fromInteger (n * unitNDT unit))
2350− (Nothing, _) -> fail "Invalid interval number"
2351− (_, Nothing) -> fail "Invalid interval unit"
2352− where
2353− unitNDT Seconds = 1
2354− unitNDT Minutes = 60
2355− unitNDT Hours = 60 * 60
2356− unitNDT Days = 24 * 60 * 60
2357− unitNDT Weeks = 7 * 24 * 60 * 60
2358−
2359−instance FromJSON ThreadPoolSize where
2360− parseJSON v = parseAsNumber v <|> parseAsString v
2361− where
2362− parseAsNumber = parseAsInt <=< parseJSON
2363− parseAsInt (-1) = return ThreadPoolUnbounded
2364− parseAsInt n
2365− | n >= 0 = return (ThreadPoolBounded n)
2366− | otherwise = fail "Thread pool size must be >= -1."
2367− parseAsString = withText "ThreadPoolSize" $ \t ->
2368− case first (readMay . T.unpack) (T.span isNumber t) of
2369− (Just n, "k") -> return (ThreadPoolBounded (n * 1000))
2370− (Just n, "") -> return (ThreadPoolBounded n)
2371− _ -> fail ("Invalid thread pool size " <> T.unpack t)
2372−
2373−instance FromJSON ThreadPoolType where
2374− parseJSON = withText "ThreadPoolType" parse
2375− where
2376− parse "scaling" = return ThreadPoolScaling
2377− parse "fixed" = return ThreadPoolFixed
2378− parse "cached" = return ThreadPoolCached
2379− parse e = fail ("Unexpected thread pool type" <> T.unpack e)
2380−
2381−instance FromJSON NodeTransportInfo where
2382− parseJSON = withObject "NodeTransportInfo" parse
2383− where
2384− parse o = NodeTransportInfo <$> (maybe (return mempty) parseProfiles =<< o .:? "profiles")
2385− <*> parseJSON (Object o)
2386− parseProfiles (Object o) | HM.null o = return []
2387− parseProfiles v@(Array _) = parseJSON v
2388− parseProfiles Null = return []
2389− parseProfiles _ = fail "Could not parse profiles"
2390−
2391−instance FromJSON NodeNetworkInfo where
2392− parseJSON = withObject "NodeNetworkInfo" parse
2393− where
2394− parse o = NodeNetworkInfo <$> o .: "primary_interface"
2395− <*> (unMS <$> o .: "refresh_interval_in_millis")
2396−
2397−
2398−instance FromJSON NodeNetworkInterface where
2399− parseJSON = withObject "NodeNetworkInterface" parse
2400− where
2401− parse o = NodeNetworkInterface <$> o .: "mac_address"
2402− <*> o .: "name"
2403− <*> o .: "address"
2404−
2405−
2406−instance ToJSON Version where
2407− toJSON Version {..} = object ["number" .= number
2408− ,"build_hash" .= build_hash
2409− ,"build_date" .= build_date
2410− ,"build_snapshot" .= build_snapshot
2411− ,"lucene_version" .= lucene_version]
2412−
2413−instance FromJSON Version where
2414− parseJSON = withObject "Version" parse
2415− where parse o = Version
2416− <$> o .: "number"
2417− <*> o .: "build_hash"
2418− <*> o .: "build_date"
2419− <*> o .: "build_snapshot"
2420− <*> o .: "lucene_version"
2421−
2422−instance ToJSON VersionNumber where
2423− toJSON = toJSON . SemVer.toText . versionNumber
2424−
2425−instance FromJSON VersionNumber where
2426− parseJSON = withText "VersionNumber" parse
2427− where
2428− parse t =
2429− case SemVer.fromText t of
2430− (Left err) -> fail err
2431− (Right v) -> return (VersionNumber v)
src/Database/Bloodhound/Internal/Highlight.hsdeleted−164
@@ -1,164 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−
4−module Database.Bloodhound.Internal.Highlight where
5−
6−import Bloodhound.Import
7−
8−import qualified Data.Map.Strict as M
9−
10−import Database.Bloodhound.Internal.Newtypes
11−import Database.Bloodhound.Internal.Query
12−
13−type HitHighlight = M.Map Text [Text]
14−
15−data Highlights = Highlights
16− { globalsettings :: Maybe HighlightSettings
17− , highlightFields :: [FieldHighlight]
18− } deriving (Eq, Show)
19−
20−instance ToJSON Highlights where
21− toJSON (Highlights global fields) =
22− omitNulls (("fields" .= fields)
23− : highlightSettingsPairs global)
24−
25−data FieldHighlight =
26− FieldHighlight FieldName (Maybe HighlightSettings)
27− deriving (Eq, Show)
28−
29−
30−instance ToJSON FieldHighlight where
31− toJSON (FieldHighlight (FieldName fName) (Just fSettings)) =
32− object [ fName .= fSettings ]
33− toJSON (FieldHighlight (FieldName fName) Nothing) =
34− object [ fName .= emptyObject ]
35−
36−data HighlightSettings =
37− Plain PlainHighlight
38− | Postings PostingsHighlight
39− | FastVector FastVectorHighlight
40− deriving (Eq, Show)
41−
42−
43−instance ToJSON HighlightSettings where
44− toJSON hs = omitNulls (highlightSettingsPairs (Just hs))
45−
46−data PlainHighlight =
47− PlainHighlight { plainCommon :: Maybe CommonHighlight
48− , plainNonPost :: Maybe NonPostings }
49− deriving (Eq, Show)
50−
51− -- This requires that index_options are set to 'offset' in the mapping.
52−data PostingsHighlight =
53− PostingsHighlight (Maybe CommonHighlight)
54− deriving (Eq, Show)
55−
56−-- This requires that term_vector is set to 'with_positions_offsets' in the mapping.
57−data FastVectorHighlight = FastVectorHighlight
58− { fvCommon :: Maybe CommonHighlight
59− , fvNonPostSettings :: Maybe NonPostings
60− , boundaryChars :: Maybe Text
61− , boundaryMaxScan :: Maybe Int
62− , fragmentOffset :: Maybe Int
63− , matchedFields :: [Text]
64− , phraseLimit :: Maybe Int
65− } deriving (Eq, Show)
66−
67−data CommonHighlight = CommonHighlight
68− { order :: Maybe Text
69− , forceSource :: Maybe Bool
70− , tag :: Maybe HighlightTag
71− , encoder :: Maybe HighlightEncoder
72− , noMatchSize :: Maybe Int
73− , highlightQuery :: Maybe Query
74− , requireFieldMatch :: Maybe Bool
75− } deriving (Eq, Show)
76−
77−-- Settings that are only applicable to FastVector and Plain highlighters.
78−data NonPostings =
79− NonPostings { fragmentSize :: Maybe Int
80− , numberOfFragments :: Maybe Int
81− } deriving (Eq, Show)
82−
83−data HighlightEncoder = DefaultEncoder
84− | HTMLEncoder
85− deriving (Eq, Show)
86−
87−instance ToJSON HighlightEncoder where
88− toJSON DefaultEncoder = String "default"
89− toJSON HTMLEncoder = String "html"
90−
91−-- NOTE: Should the tags use some kind of HTML type, rather than Text?
92−data HighlightTag =
93− TagSchema Text
94− -- Only uses more than the first value in the lists if fvh
95− | CustomTags ([Text], [Text])
96− deriving (Eq, Show)
97−
98−highlightSettingsPairs :: Maybe HighlightSettings -> [Pair]
99−highlightSettingsPairs Nothing = []
100−highlightSettingsPairs (Just (Plain plh)) = plainHighPairs (Just plh)
101−highlightSettingsPairs (Just (Postings ph)) = postHighPairs (Just ph)
102−highlightSettingsPairs (Just (FastVector fvh)) = fastVectorHighPairs (Just fvh)
103−
104−
105−plainHighPairs :: Maybe PlainHighlight -> [Pair]
106−plainHighPairs Nothing = []
107−plainHighPairs (Just (PlainHighlight plCom plNonPost)) =
108− [ "type" .= String "plain"]
109− ++ commonHighlightPairs plCom
110− ++ nonPostingsToPairs plNonPost
111−
112−postHighPairs :: Maybe PostingsHighlight -> [Pair]
113−postHighPairs Nothing = []
114−postHighPairs (Just (PostingsHighlight pCom)) =
115− ("type" .= String "postings")
116− : commonHighlightPairs pCom
117−
118−fastVectorHighPairs :: Maybe FastVectorHighlight -> [Pair]
119−fastVectorHighPairs Nothing = []
120−fastVectorHighPairs
121− (Just
122− (FastVectorHighlight fvCom fvNonPostSettings' fvBoundChars
123− fvBoundMaxScan fvFragOff fvMatchedFields
124− fvPhraseLim)) =
125− [ "type" .= String "fvh"
126− , "boundary_chars" .= fvBoundChars
127− , "boundary_max_scan" .= fvBoundMaxScan
128− , "fragment_offset" .= fvFragOff
129− , "matched_fields" .= fvMatchedFields
130− , "phraseLimit" .= fvPhraseLim]
131− ++ commonHighlightPairs fvCom
132− ++ nonPostingsToPairs fvNonPostSettings'
133−
134−commonHighlightPairs :: Maybe CommonHighlight -> [Pair]
135−commonHighlightPairs Nothing = []
136−commonHighlightPairs (Just (CommonHighlight chScore chForceSource
137− chTag chEncoder chNoMatchSize
138− chHighlightQuery chRequireFieldMatch)) =
139− [ "order" .= chScore
140− , "force_source" .= chForceSource
141− , "encoder" .= chEncoder
142− , "no_match_size" .= chNoMatchSize
143− , "highlight_query" .= chHighlightQuery
144− , "require_fieldMatch" .= chRequireFieldMatch
145− ]
146− ++ highlightTagToPairs chTag
147−
148−
149−nonPostingsToPairs :: Maybe NonPostings -> [Pair]
150−nonPostingsToPairs Nothing = []
151−nonPostingsToPairs (Just (NonPostings npFragSize npNumOfFrags)) =
152− [ "fragment_size" .= npFragSize
153− , "number_of_fragments" .= npNumOfFrags
154− ]
155−
156−highlightTagToPairs :: Maybe HighlightTag -> [Pair]
157−highlightTagToPairs (Just (TagSchema _)) =
158− [ "scheme" .= String "default"
159− ]
160−highlightTagToPairs (Just (CustomTags (pre, post))) =
161− [ "pre_tags" .= pre
162− , "post_tags" .= post
163− ]
164−highlightTagToPairs Nothing = []
src/Database/Bloodhound/Internal/Newtypes.hsdeleted−237
@@ -1,237 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−
4−module Database.Bloodhound.Internal.Newtypes where
5−
6−import Bloodhound.Import
7−
8−import qualified Data.Map.Strict as M
9−
10−newtype From = From Int deriving (Eq, Show, ToJSON)
11−newtype Size = Size Int deriving (Eq, Show, ToJSON, FromJSON)
12−
13−-- Used with scripts
14−newtype HitFields =
15− HitFields (M.Map Text [Value])
16− deriving (Eq, Show)
17−
18−instance FromJSON HitFields where
19− parseJSON x
20− = HitFields <$> parseJSON x
21−
22−-- Slight misnomer.
23−type Score = Maybe Double
24−
25−{-| 'MappingName' is part of mappings which are how ES describes and schematizes
26− the data in the indices.
27−-}
28−newtype MappingName =
29− MappingName Text
30− deriving (Eq, Show, ToJSON, FromJSON)
31−
32−newtype ShardId = ShardId { shardId :: Int }
33− deriving (Eq, Show, FromJSON)
34−
35−{-| 'DocId' is a generic wrapper value for expressing unique Document IDs.
36− Can be set by the user or created by ES itself. Often used in client
37− functions for poking at specific documents.
38−-}
39−newtype DocId =
40− DocId Text
41− deriving (Eq, Show, ToJSON, FromJSON)
42−
43−{-| 'FieldName' is used all over the place wherever a specific field within
44− a document needs to be specified, usually in 'Query's or 'Filter's.
45−-}
46−newtype FieldName =
47− FieldName Text
48− deriving (Eq, Read, Show, ToJSON, FromJSON)
49−
50−newtype TypeName =
51− TypeName Text
52− deriving (Eq, Show, ToJSON, FromJSON)
53−
54−{-| 'QueryString' is used to wrap query text bodies, be they human written or not.
55−-}
56−newtype QueryString =
57− QueryString Text
58− deriving (Eq, Show, ToJSON, FromJSON)
59−
60−
61−-- {-| 'Script' is often used in place of 'FieldName' to specify more
62−-- complex ways of extracting a value from a document.
63−-- -}
64−-- newtype Script =
65−-- Script { scriptText :: Text }
66−-- deriving (Eq, Show)
67−
68−{-| 'CacheName' is used in 'RegexpFilter' for describing the
69− 'CacheKey' keyed caching behavior.
70−-}
71−newtype CacheName =
72− CacheName Text
73− deriving (Eq, Show, FromJSON, ToJSON)
74−
75−{-| 'CacheKey' is used in 'RegexpFilter' to key regex caching.
76−-}
77−newtype CacheKey =
78− CacheKey Text deriving (Eq, Show, FromJSON, ToJSON)
79−newtype Existence =
80− Existence Bool deriving (Eq, Show, FromJSON, ToJSON)
81−newtype NullValue =
82− NullValue Bool deriving (Eq, Show, FromJSON, ToJSON)
83−newtype CutoffFrequency =
84− CutoffFrequency Double deriving (Eq, Show, FromJSON, ToJSON)
85−newtype Analyzer =
86− Analyzer Text deriving (Eq, Show, FromJSON, ToJSON)
87−newtype MaxExpansions =
88− MaxExpansions Int deriving (Eq, Show, FromJSON, ToJSON)
89−
90−{-| 'Lenient', if set to true, will cause format based failures to be
91− ignored. I don't know what the bloody default is, Elasticsearch
92− documentation didn't say what it was. Let me know if you figure it out.
93−-}
94−newtype Lenient =
95− Lenient Bool deriving (Eq, Show, FromJSON, ToJSON)
96−newtype Tiebreaker =
97− Tiebreaker Double deriving (Eq, Show, FromJSON, ToJSON)
98−
99−{-| 'MinimumMatch' controls how many should clauses in the bool query should
100− match. Can be an absolute value (2) or a percentage (30%) or a
101− combination of both.
102−-}
103−newtype MinimumMatch =
104− MinimumMatch Int deriving (Eq, Show, FromJSON, ToJSON)
105−newtype DisableCoord =
106− DisableCoord Bool deriving (Eq, Show, FromJSON, ToJSON)
107−newtype IgnoreTermFrequency =
108− IgnoreTermFrequency Bool deriving (Eq, Show, FromJSON, ToJSON)
109−newtype MinimumTermFrequency =
110− MinimumTermFrequency Int deriving (Eq, Show, FromJSON, ToJSON)
111−newtype MaxQueryTerms =
112− MaxQueryTerms Int deriving (Eq, Show, FromJSON, ToJSON)
113−
114−{-| 'PrefixLength' is the prefix length used in queries, defaults to 0. -}
115−newtype PrefixLength =
116− PrefixLength Int deriving (Eq, Show, FromJSON, ToJSON)
117−newtype PercentMatch =
118− PercentMatch Double deriving (Eq, Show, FromJSON, ToJSON)
119−newtype StopWord =
120− StopWord Text deriving (Eq, Show, FromJSON, ToJSON)
121−newtype QueryPath =
122− QueryPath Text deriving (Eq, Show, FromJSON, ToJSON)
123−
124−{-| Allowing a wildcard at the beginning of a word (eg "*ing") is particularly
125− heavy, because all terms in the index need to be examined, just in case
126− they match. Leading wildcards can be disabled by setting
127− 'AllowLeadingWildcard' to false. -}
128−newtype AllowLeadingWildcard =
129− AllowLeadingWildcard Bool deriving (Eq, Show, FromJSON, ToJSON)
130−newtype LowercaseExpanded =
131− LowercaseExpanded Bool deriving (Eq, Show, FromJSON, ToJSON)
132−newtype EnablePositionIncrements =
133− EnablePositionIncrements Bool deriving (Eq, Show, FromJSON, ToJSON)
134−
135−{-| By default, wildcard terms in a query are not analyzed.
136− Setting 'AnalyzeWildcard' to true enables best-effort analysis.
137−-}
138−newtype AnalyzeWildcard = AnalyzeWildcard Bool deriving (Eq, Show, FromJSON, ToJSON)
139−
140−{-| 'GeneratePhraseQueries' defaults to false.
141−-}
142−newtype GeneratePhraseQueries =
143− GeneratePhraseQueries Bool deriving (Eq, Show, FromJSON, ToJSON)
144−
145−{-| 'Locale' is used for string conversions - defaults to ROOT.
146−-}
147−newtype Locale = Locale Text deriving (Eq, Show, FromJSON, ToJSON)
148−newtype MaxWordLength = MaxWordLength Int deriving (Eq, Show, FromJSON, ToJSON)
149−newtype MinWordLength = MinWordLength Int deriving (Eq, Show, FromJSON, ToJSON)
150−
151−{-| 'PhraseSlop' sets the default slop for phrases, 0 means exact
152− phrase matches. Default is 0.
153−-}
154−newtype PhraseSlop = PhraseSlop Int deriving (Eq, Show, FromJSON, ToJSON)
155−newtype MinDocFrequency = MinDocFrequency Int deriving (Eq, Show, FromJSON, ToJSON)
156−newtype MaxDocFrequency = MaxDocFrequency Int deriving (Eq, Show, FromJSON, ToJSON)
157−
158−-- | Newtype wrapper to parse ES's concerning tendency to in some APIs return a floating point number of milliseconds since epoch ಠ_ಠ
159−newtype POSIXMS = POSIXMS { posixMS :: UTCTime }
160−
161−instance FromJSON POSIXMS where
162− parseJSON = withScientific "POSIXMS" (return . parse)
163− where parse n =
164− let n' = truncate n :: Integer
165− in POSIXMS (posixSecondsToUTCTime (fromInteger (n' `div` 1000)))
166−
167−newtype Boost =
168− Boost Double
169− deriving (Eq, Show, ToJSON, FromJSON)
170−
171−newtype BoostTerms =
172− BoostTerms Double
173− deriving (Eq, Show, ToJSON, FromJSON)
174−
175−{-| 'ReplicaCount' is part of 'IndexSettings' -}
176−newtype ReplicaCount =
177− ReplicaCount Int
178− deriving (Eq, Show, ToJSON)
179−
180−{-| 'ShardCount' is part of 'IndexSettings' -}
181−newtype ShardCount =
182− ShardCount Int
183− deriving (Eq, Show, ToJSON)
184−
185−-- This insanity is because ES *sometimes* returns Replica/Shard counts as strings
186−instance FromJSON ReplicaCount where
187− parseJSON v = parseAsInt v
188− <|> parseAsString v
189− where parseAsInt = fmap ReplicaCount . parseJSON
190− parseAsString = withText "ReplicaCount" (fmap ReplicaCount . parseReadText)
191−
192−instance FromJSON ShardCount where
193− parseJSON v = parseAsInt v
194− <|> parseAsString v
195− where parseAsInt = fmap ShardCount . parseJSON
196− parseAsString = withText "ShardCount" (fmap ShardCount . parseReadText)
197−
198−{-| 'IndexName' is used to describe which index to query/create/delete -}
199−newtype IndexName =
200− IndexName Text
201− deriving (Eq, Show, ToJSON, FromJSON)
202−
203−newtype IndexAliasName =
204− IndexAliasName { indexAliasName :: IndexName }
205− deriving (Eq, Show, ToJSON)
206−
207−newtype MaybeNA a = MaybeNA { unMaybeNA :: Maybe a }
208− deriving (Show, Eq)
209−
210−instance FromJSON a => FromJSON (MaybeNA a) where
211− parseJSON (String "NA") = pure $ MaybeNA Nothing
212− parseJSON o = MaybeNA . Just <$> parseJSON o
213−
214−newtype SnapshotName =
215− SnapshotName { snapshotName :: Text }
216− deriving (Eq, Show, ToJSON, FromJSON)
217−
218−-- | Milliseconds
219−newtype MS = MS NominalDiffTime
220−
221−-- keeps the unexported constructor warnings at bay
222−unMS :: MS -> NominalDiffTime
223−unMS (MS t) = t
224−
225−
226−instance FromJSON MS where
227− parseJSON = withScientific "MS" (return . MS . parse)
228− where
229− parse n = fromInteger (truncate n * 1000)
230−
231−newtype TokenFilter =
232− TokenFilter Text
233− deriving (Eq, Show, FromJSON, ToJSON)
234−
235−newtype CharFilter =
236− CharFilter Text
237− deriving (Eq, Show, FromJSON, ToJSON)
src/Database/Bloodhound/Internal/Query.hsdeleted−1640
@@ -1,1640 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
4−
5−module Database.Bloodhound.Internal.Query
6− ( module X
7− , module Database.Bloodhound.Internal.Query
8− ) where
9−
10−import Bloodhound.Import
11−
12−import Data.Char (isNumber)
13−import qualified Data.HashMap.Strict as HM
14−import Data.List (nub)
15−import qualified Data.Text as T
16−
17−import Database.Bloodhound.Common.Script as X
18−import Database.Bloodhound.Internal.Newtypes
19−
20−data Query =
21− TermQuery Term (Maybe Boost)
22− | TermsQuery Text (NonEmpty Text)
23− | QueryMatchQuery MatchQuery
24− | QueryMultiMatchQuery MultiMatchQuery
25− | QueryBoolQuery BoolQuery
26− | QueryBoostingQuery BoostingQuery
27− | QueryCommonTermsQuery CommonTermsQuery
28− | ConstantScoreQuery Query Boost
29− | QueryFunctionScoreQuery FunctionScoreQuery
30− | QueryDisMaxQuery DisMaxQuery
31− | QueryFuzzyLikeThisQuery FuzzyLikeThisQuery
32− | QueryFuzzyLikeFieldQuery FuzzyLikeFieldQuery
33− | QueryFuzzyQuery FuzzyQuery
34− | QueryHasChildQuery HasChildQuery
35− | QueryHasParentQuery HasParentQuery
36− | IdsQuery MappingName [DocId]
37− | QueryIndicesQuery IndicesQuery
38− | MatchAllQuery (Maybe Boost)
39− | QueryMoreLikeThisQuery MoreLikeThisQuery
40− | QueryMoreLikeThisFieldQuery MoreLikeThisFieldQuery
41− | QueryNestedQuery NestedQuery
42− | QueryPrefixQuery PrefixQuery
43− | QueryQueryStringQuery QueryStringQuery
44− | QuerySimpleQueryStringQuery SimpleQueryStringQuery
45− | QueryRangeQuery RangeQuery
46− | QueryRegexpQuery RegexpQuery
47− | QueryExistsQuery FieldName
48− | QueryTemplateQueryInline TemplateQueryInline
49− | QueryMatchNoneQuery
50− | QueryWildcardQuery WildcardQuery
51− deriving (Eq, Show)
52−
53−instance ToJSON Query where
54− toJSON (TermQuery (Term termQueryField termQueryValue) boost) =
55− object [ "term" .=
56− object [termQueryField .= object merged]]
57− where
58− base = [ "value" .= termQueryValue ]
59− boosted = maybe [] (return . ("boost" .=)) boost
60− merged = mappend base boosted
61−
62− toJSON (TermsQuery fieldName terms) =
63− object [ "terms" .= object conjoined ]
64− where conjoined = [fieldName .= terms]
65−
66− toJSON (IdsQuery idsQueryMappingName docIds) =
67− object [ "ids" .= object conjoined ]
68− where conjoined = [ "type" .= idsQueryMappingName
69− , "values" .= fmap toJSON docIds ]
70−
71− toJSON (QueryQueryStringQuery qQueryStringQuery) =
72− object [ "query_string" .= qQueryStringQuery ]
73−
74− toJSON (QueryMatchQuery matchQuery) =
75− object [ "match" .= matchQuery ]
76−
77− toJSON (QueryMultiMatchQuery multiMatchQuery) =
78− toJSON multiMatchQuery
79−
80− toJSON (QueryBoolQuery boolQuery) =
81− object [ "bool" .= boolQuery ]
82−
83− toJSON (QueryBoostingQuery boostingQuery) =
84− object [ "boosting" .= boostingQuery ]
85−
86− toJSON (QueryCommonTermsQuery commonTermsQuery) =
87− object [ "common" .= commonTermsQuery ]
88−
89− toJSON (ConstantScoreQuery query boost) =
90− object ["constant_score" .= object ["query" .= query
91− , "boost" .= boost]]
92−
93− toJSON (QueryFunctionScoreQuery functionScoreQuery) =
94− object [ "function_score" .= functionScoreQuery ]
95−
96− toJSON (QueryDisMaxQuery disMaxQuery) =
97− object [ "dis_max" .= disMaxQuery ]
98−
99− toJSON (QueryFuzzyLikeThisQuery fuzzyQuery) =
100− object [ "fuzzy_like_this" .= fuzzyQuery ]
101−
102− toJSON (QueryFuzzyLikeFieldQuery fuzzyFieldQuery) =
103− object [ "fuzzy_like_this_field" .= fuzzyFieldQuery ]
104−
105− toJSON (QueryFuzzyQuery fuzzyQuery) =
106− object [ "fuzzy" .= fuzzyQuery ]
107−
108− toJSON (QueryHasChildQuery childQuery) =
109− object [ "has_child" .= childQuery ]
110−
111− toJSON (QueryHasParentQuery parentQuery) =
112− object [ "has_parent" .= parentQuery ]
113−
114− toJSON (QueryIndicesQuery qIndicesQuery) =
115− object [ "indices" .= qIndicesQuery ]
116−
117− toJSON (MatchAllQuery boost) =
118− object [ "match_all" .= omitNulls [ "boost" .= boost ] ]
119−
120− toJSON (QueryMoreLikeThisQuery query) =
121− object [ "more_like_this" .= query ]
122−
123− toJSON (QueryMoreLikeThisFieldQuery query) =
124− object [ "more_like_this_field" .= query ]
125−
126− toJSON (QueryNestedQuery query) =
127− object [ "nested" .= query ]
128−
129− toJSON (QueryPrefixQuery query) =
130− object [ "prefix" .= query ]
131−
132− toJSON (QueryRangeQuery query) =
133− object [ "range" .= query ]
134−
135− toJSON (QueryRegexpQuery query) =
136− object [ "regexp" .= query ]
137−
138− toJSON (QuerySimpleQueryStringQuery query) =
139− object [ "simple_query_string" .= query ]
140−
141− toJSON (QueryExistsQuery (FieldName fieldName)) =
142− object ["exists" .= object
143− ["field" .= fieldName]
144− ]
145− toJSON QueryMatchNoneQuery =
146− object ["match_none" .= object []]
147−
148− toJSON (QueryTemplateQueryInline templateQuery) =
149− object [ "template" .= templateQuery ]
150−
151− toJSON (QueryWildcardQuery query) =
152− object [ "wildcard" .= query ]
153−
154−instance FromJSON Query where
155− parseJSON v = withObject "Query" parse v
156− where parse o = termQuery `taggedWith` "term"
157− <|> termsQuery `taggedWith` "terms"
158− <|> idsQuery `taggedWith` "ids"
159− <|> queryQueryStringQuery `taggedWith` "query_string"
160− <|> queryMatchQuery `taggedWith` "match"
161− <|> queryMultiMatchQuery
162− <|> queryBoolQuery `taggedWith` "bool"
163− <|> queryBoostingQuery `taggedWith` "boosting"
164− <|> queryCommonTermsQuery `taggedWith` "common"
165− <|> constantScoreQuery `taggedWith` "constant_score"
166− <|> queryFunctionScoreQuery `taggedWith` "function_score"
167− <|> queryDisMaxQuery `taggedWith` "dis_max"
168− <|> queryFuzzyLikeThisQuery `taggedWith` "fuzzy_like_this"
169− <|> queryFuzzyLikeFieldQuery `taggedWith` "fuzzy_like_this_field"
170− <|> queryFuzzyQuery `taggedWith` "fuzzy"
171− <|> queryHasChildQuery `taggedWith` "has_child"
172− <|> queryHasParentQuery `taggedWith` "has_parent"
173− <|> queryIndicesQuery `taggedWith` "indices"
174− <|> matchAllQuery `taggedWith` "match_all"
175− <|> queryMoreLikeThisQuery `taggedWith` "more_like_this"
176− <|> queryMoreLikeThisFieldQuery `taggedWith` "more_like_this_field"
177− <|> queryNestedQuery `taggedWith` "nested"
178− <|> queryPrefixQuery `taggedWith` "prefix"
179− <|> queryRangeQuery `taggedWith` "range"
180− <|> queryRegexpQuery `taggedWith` "regexp"
181− <|> querySimpleQueryStringQuery `taggedWith` "simple_query_string"
182− <|> queryTemplateQueryInline `taggedWith` "template"
183− <|> queryWildcardQuery `taggedWith` "wildcard"
184− where taggedWith parser k = parser =<< o .: k
185− termQuery = fieldTagged $ \(FieldName fn) o ->
186− TermQuery <$> (Term fn <$> o .: "value") <*> o .:? "boost"
187− termsQuery o = case HM.toList o of
188− [(fn, vs)] -> do vals <- parseJSON vs
189− case vals of
190− x:xs -> return (TermsQuery fn (x :| xs))
191− _ -> fail "Expected non empty list of values"
192− _ -> fail "Expected object with 1 field-named key"
193− idsQuery o = IdsQuery <$> o .: "type"
194− <*> o .: "values"
195− queryQueryStringQuery = pure . QueryQueryStringQuery
196− queryMatchQuery = pure . QueryMatchQuery
197− queryMultiMatchQuery = QueryMultiMatchQuery <$> parseJSON v
198− queryBoolQuery = pure . QueryBoolQuery
199− queryBoostingQuery = pure . QueryBoostingQuery
200− queryCommonTermsQuery = pure . QueryCommonTermsQuery
201− constantScoreQuery o = case HM.lookup "query" o of
202− Just x -> ConstantScoreQuery <$> parseJSON x
203− <*> o .: "boost"
204− _ -> fail "Does not appear to be a ConstantScoreQuery"
205− queryFunctionScoreQuery = pure . QueryFunctionScoreQuery
206− queryDisMaxQuery = pure . QueryDisMaxQuery
207− queryFuzzyLikeThisQuery = pure . QueryFuzzyLikeThisQuery
208− queryFuzzyLikeFieldQuery = pure . QueryFuzzyLikeFieldQuery
209− queryFuzzyQuery = pure . QueryFuzzyQuery
210− queryHasChildQuery = pure . QueryHasChildQuery
211− queryHasParentQuery = pure . QueryHasParentQuery
212− queryIndicesQuery = pure . QueryIndicesQuery
213− matchAllQuery o = MatchAllQuery <$> o .:? "boost"
214− queryMoreLikeThisQuery = pure . QueryMoreLikeThisQuery
215− queryMoreLikeThisFieldQuery = pure . QueryMoreLikeThisFieldQuery
216− queryNestedQuery = pure . QueryNestedQuery
217− queryPrefixQuery = pure . QueryPrefixQuery
218− queryRangeQuery = pure . QueryRangeQuery
219− queryRegexpQuery = pure . QueryRegexpQuery
220− querySimpleQueryStringQuery = pure . QuerySimpleQueryStringQuery
221− -- queryExistsQuery o = QueryExistsQuery <$> o .: "field"
222− queryTemplateQueryInline = pure . QueryTemplateQueryInline
223− queryWildcardQuery = pure . QueryWildcardQuery
224−
225−-- | As of Elastic 2.0, 'Filters' are just 'Queries' housed in a
226−-- Bool Query, and flagged in a different context.
227−newtype Filter = Filter { unFilter :: Query }
228− deriving (Eq, Show)
229−
230−instance ToJSON Filter where
231− toJSON = toJSON . unFilter
232−
233−instance FromJSON Filter where
234− parseJSON v = Filter <$> parseJSON v
235−
236−data RegexpQuery =
237− RegexpQuery { regexpQueryField :: FieldName
238− , regexpQuery :: Regexp
239− , regexpQueryFlags :: RegexpFlags
240− , regexpQueryBoost :: Maybe Boost
241− } deriving (Eq, Show)
242−
243−instance ToJSON RegexpQuery where
244− toJSON (RegexpQuery (FieldName rqQueryField)
245− (Regexp regexpQueryQuery) rqQueryFlags
246− rqQueryBoost) =
247− object [ rqQueryField .= omitNulls base ]
248− where base = [ "value" .= regexpQueryQuery
249− , "flags" .= rqQueryFlags
250− , "boost" .= rqQueryBoost ]
251−
252−instance FromJSON RegexpQuery where
253− parseJSON = withObject "RegexpQuery" parse
254− where parse = fieldTagged $ \fn o ->
255− RegexpQuery fn
256− <$> o .: "value"
257− <*> o .: "flags"
258− <*> o .:? "boost"
259−
260−data WildcardQuery =
261− WildcardQuery { wildcardQueryField :: FieldName
262− , wildcardQuery :: Text
263− , wildcardQueryBoost :: Maybe Boost
264− } deriving (Eq, Show)
265−
266−instance ToJSON WildcardQuery where
267− toJSON (WildcardQuery (FieldName wcQueryField)
268− (wcQueryQuery) wcQueryBoost) =
269− object [ wcQueryField .= omitNulls base ]
270− where base = [ "value" .= wcQueryQuery
271− , "boost" .= wcQueryBoost ]
272−
273−instance FromJSON WildcardQuery where
274− parseJSON = withObject "WildcardQuery" parse
275− where parse = fieldTagged $ \fn o ->
276− WildcardQuery fn
277− <$> o .: "value"
278− <*> o .:? "boost"
279−
280−data RangeQuery =
281− RangeQuery { rangeQueryField :: FieldName
282− , rangeQueryRange :: RangeValue
283− , rangeQueryBoost :: Boost } deriving (Eq, Show)
284−
285−instance ToJSON RangeQuery where
286− toJSON (RangeQuery (FieldName fieldName) range boost) =
287− object [ fieldName .= object conjoined ]
288− where
289− conjoined = ("boost" .= boost) : rangeValueToPair range
290−
291−instance FromJSON RangeQuery where
292− parseJSON = withObject "RangeQuery" parse
293− where parse = fieldTagged $ \fn o ->
294− RangeQuery fn
295− <$> parseJSON (Object o)
296− <*> o .: "boost"
297−
298−mkRangeQuery :: FieldName -> RangeValue -> RangeQuery
299−mkRangeQuery f r = RangeQuery f r (Boost 1.0)
300−
301−data SimpleQueryStringQuery =
302− SimpleQueryStringQuery
303− { simpleQueryStringQuery :: QueryString
304− , simpleQueryStringField :: Maybe FieldOrFields
305− , simpleQueryStringOperator :: Maybe BooleanOperator
306− , simpleQueryStringAnalyzer :: Maybe Analyzer
307− , simpleQueryStringFlags :: Maybe (NonEmpty SimpleQueryFlag)
308− , simpleQueryStringLowercaseExpanded :: Maybe LowercaseExpanded
309− , simpleQueryStringLocale :: Maybe Locale
310− } deriving (Eq, Show)
311−
312−
313−instance ToJSON SimpleQueryStringQuery where
314− toJSON SimpleQueryStringQuery {..} =
315− omitNulls (base ++ maybeAdd)
316− where base = [ "query" .= simpleQueryStringQuery ]
317− maybeAdd = [ "fields" .= simpleQueryStringField
318− , "default_operator" .= simpleQueryStringOperator
319− , "analyzer" .= simpleQueryStringAnalyzer
320− , "flags" .= simpleQueryStringFlags
321− , "lowercase_expanded_terms" .= simpleQueryStringLowercaseExpanded
322− , "locale" .= simpleQueryStringLocale ]
323−
324−instance FromJSON SimpleQueryStringQuery where
325− parseJSON = withObject "SimpleQueryStringQuery" parse
326− where parse o = SimpleQueryStringQuery <$> o .: "query"
327− <*> o .:? "fields"
328− <*> o .:? "default_operator"
329− <*> o .:? "analyzer"
330− <*> (parseFlags <$> o .:? "flags")
331− <*> o .:? "lowercase_expanded_terms"
332− <*> o .:? "locale"
333− parseFlags (Just (x:xs)) = Just (x :| xs)
334− parseFlags _ = Nothing
335−
336−data SimpleQueryFlag =
337− SimpleQueryAll
338− | SimpleQueryNone
339− | SimpleQueryAnd
340− | SimpleQueryOr
341− | SimpleQueryPrefix
342− | SimpleQueryPhrase
343− | SimpleQueryPrecedence
344− | SimpleQueryEscape
345− | SimpleQueryWhitespace
346− | SimpleQueryFuzzy
347− | SimpleQueryNear
348− | SimpleQuerySlop deriving (Eq, Show)
349−
350−instance ToJSON SimpleQueryFlag where
351− toJSON SimpleQueryAll = "ALL"
352− toJSON SimpleQueryNone = "NONE"
353− toJSON SimpleQueryAnd = "AND"
354− toJSON SimpleQueryOr = "OR"
355− toJSON SimpleQueryPrefix = "PREFIX"
356− toJSON SimpleQueryPhrase = "PHRASE"
357− toJSON SimpleQueryPrecedence = "PRECEDENCE"
358− toJSON SimpleQueryEscape = "ESCAPE"
359− toJSON SimpleQueryWhitespace = "WHITESPACE"
360− toJSON SimpleQueryFuzzy = "FUZZY"
361− toJSON SimpleQueryNear = "NEAR"
362− toJSON SimpleQuerySlop = "SLOP"
363−
364−instance FromJSON SimpleQueryFlag where
365− parseJSON = withText "SimpleQueryFlag" parse
366− where parse "ALL" = pure SimpleQueryAll
367− parse "NONE" = pure SimpleQueryNone
368− parse "AND" = pure SimpleQueryAnd
369− parse "OR" = pure SimpleQueryOr
370− parse "PREFIX" = pure SimpleQueryPrefix
371− parse "PHRASE" = pure SimpleQueryPhrase
372− parse "PRECEDENCE" = pure SimpleQueryPrecedence
373− parse "ESCAPE" = pure SimpleQueryEscape
374− parse "WHITESPACE" = pure SimpleQueryWhitespace
375− parse "FUZZY" = pure SimpleQueryFuzzy
376− parse "NEAR" = pure SimpleQueryNear
377− parse "SLOP" = pure SimpleQuerySlop
378− parse f = fail ("Unexpected SimpleQueryFlag: " <> show f)
379−
380−-- use_dis_max and tie_breaker when fields are plural?
381−data QueryStringQuery =
382− QueryStringQuery
383− { queryStringQuery :: QueryString
384− , queryStringDefaultField :: Maybe FieldName
385− , queryStringOperator :: Maybe BooleanOperator
386− , queryStringAnalyzer :: Maybe Analyzer
387− , queryStringAllowLeadingWildcard :: Maybe AllowLeadingWildcard
388− , queryStringLowercaseExpanded :: Maybe LowercaseExpanded
389− , queryStringEnablePositionIncrements :: Maybe EnablePositionIncrements
390− , queryStringFuzzyMaxExpansions :: Maybe MaxExpansions
391− , queryStringFuzziness :: Maybe Fuzziness
392− , queryStringFuzzyPrefixLength :: Maybe PrefixLength
393− , queryStringPhraseSlop :: Maybe PhraseSlop
394− , queryStringBoost :: Maybe Boost
395− , queryStringAnalyzeWildcard :: Maybe AnalyzeWildcard
396− , queryStringGeneratePhraseQueries :: Maybe GeneratePhraseQueries
397− , queryStringMinimumShouldMatch :: Maybe MinimumMatch
398− , queryStringLenient :: Maybe Lenient
399− , queryStringLocale :: Maybe Locale
400− } deriving (Eq, Show)
401−
402−
403−instance ToJSON QueryStringQuery where
404− toJSON (QueryStringQuery qsQueryString
405− qsDefaultField qsOperator
406− qsAnalyzer qsAllowWildcard
407− qsLowercaseExpanded qsEnablePositionIncrements
408− qsFuzzyMaxExpansions qsFuzziness
409− qsFuzzyPrefixLength qsPhraseSlop
410− qsBoost qsAnalyzeWildcard
411− qsGeneratePhraseQueries qsMinimumShouldMatch
412− qsLenient qsLocale) =
413− omitNulls base
414− where
415− base = [ "query" .= qsQueryString
416− , "default_field" .= qsDefaultField
417− , "default_operator" .= qsOperator
418− , "analyzer" .= qsAnalyzer
419− , "allow_leading_wildcard" .= qsAllowWildcard
420− , "lowercase_expanded_terms" .= qsLowercaseExpanded
421− , "enable_position_increments" .= qsEnablePositionIncrements
422− , "fuzzy_max_expansions" .= qsFuzzyMaxExpansions
423− , "fuzziness" .= qsFuzziness
424− , "fuzzy_prefix_length" .= qsFuzzyPrefixLength
425− , "phrase_slop" .= qsPhraseSlop
426− , "boost" .= qsBoost
427− , "analyze_wildcard" .= qsAnalyzeWildcard
428− , "auto_generate_phrase_queries" .= qsGeneratePhraseQueries
429− , "minimum_should_match" .= qsMinimumShouldMatch
430− , "lenient" .= qsLenient
431− , "locale" .= qsLocale ]
432−
433−instance FromJSON QueryStringQuery where
434− parseJSON = withObject "QueryStringQuery" parse
435− where parse o = QueryStringQuery
436− <$> o .: "query"
437− <*> o .:? "default_field"
438− <*> o .:? "default_operator"
439− <*> o .:? "analyzer"
440− <*> o .:? "allow_leading_wildcard"
441− <*> o .:? "lowercase_expanded_terms"
442− <*> o .:? "enable_position_increments"
443− <*> o .:? "fuzzy_max_expansions"
444− <*> o .:? "fuzziness"
445− <*> o .:? "fuzzy_prefix_length"
446− <*> o .:? "phrase_slop"
447− <*> o .:? "boost"
448− <*> o .:? "analyze_wildcard"
449− <*> o .:? "auto_generate_phrase_queries"
450− <*> o .:? "minimum_should_match"
451− <*> o .:? "lenient"
452− <*> o .:? "locale"
453−
454−mkQueryStringQuery :: QueryString -> QueryStringQuery
455−mkQueryStringQuery qs =
456− QueryStringQuery qs Nothing Nothing
457− Nothing Nothing Nothing Nothing
458− Nothing Nothing Nothing Nothing
459− Nothing Nothing Nothing Nothing
460− Nothing Nothing
461−
462−data FieldOrFields = FofField FieldName
463− | FofFields (NonEmpty FieldName) deriving (Eq, Show)
464−
465−instance ToJSON FieldOrFields where
466− toJSON (FofField fieldName) =
467− toJSON fieldName
468− toJSON (FofFields fieldNames) =
469− toJSON fieldNames
470−
471−instance FromJSON FieldOrFields where
472− parseJSON v = FofField <$> parseJSON v
473− <|> FofFields <$> (parseNEJSON =<< parseJSON v)
474−
475−data PrefixQuery =
476− PrefixQuery
477− { prefixQueryField :: FieldName
478− , prefixQueryPrefixValue :: Text
479− , prefixQueryBoost :: Maybe Boost } deriving (Eq, Show)
480−
481−instance ToJSON PrefixQuery where
482− toJSON (PrefixQuery (FieldName fieldName) queryValue boost) =
483− object [ fieldName .= omitNulls base ]
484− where base = [ "value" .= queryValue
485− , "boost" .= boost ]
486−
487−instance FromJSON PrefixQuery where
488− parseJSON = withObject "PrefixQuery" parse
489− where parse = fieldTagged $ \fn o ->
490− PrefixQuery fn
491− <$> o .: "value"
492− <*> o .:? "boost"
493−
494−data NestedQuery =
495− NestedQuery
496− { nestedQueryPath :: QueryPath
497− , nestedQueryScoreType :: ScoreType
498− , nestedQuery :: Query } deriving (Eq, Show)
499−
500−instance ToJSON NestedQuery where
501− toJSON (NestedQuery nqPath nqScoreType nqQuery) =
502− object [ "path" .= nqPath
503− , "score_mode" .= nqScoreType
504− , "query" .= nqQuery ]
505−
506−instance FromJSON NestedQuery where
507− parseJSON = withObject "NestedQuery" parse
508− where parse o = NestedQuery
509− <$> o .: "path"
510− <*> o .: "score_mode"
511− <*> o .: "query"
512−
513−data MoreLikeThisFieldQuery =
514− MoreLikeThisFieldQuery
515− { moreLikeThisFieldText :: Text
516− , moreLikeThisFieldFields :: FieldName
517− -- default 0.3 (30%)
518− , moreLikeThisFieldPercentMatch :: Maybe PercentMatch
519− , moreLikeThisFieldMinimumTermFreq :: Maybe MinimumTermFrequency
520− , moreLikeThisFieldMaxQueryTerms :: Maybe MaxQueryTerms
521− , moreLikeThisFieldStopWords :: Maybe (NonEmpty StopWord)
522− , moreLikeThisFieldMinDocFrequency :: Maybe MinDocFrequency
523− , moreLikeThisFieldMaxDocFrequency :: Maybe MaxDocFrequency
524− , moreLikeThisFieldMinWordLength :: Maybe MinWordLength
525− , moreLikeThisFieldMaxWordLength :: Maybe MaxWordLength
526− , moreLikeThisFieldBoostTerms :: Maybe BoostTerms
527− , moreLikeThisFieldBoost :: Maybe Boost
528− , moreLikeThisFieldAnalyzer :: Maybe Analyzer
529− } deriving (Eq, Show)
530−
531−
532−instance ToJSON MoreLikeThisFieldQuery where
533− toJSON (MoreLikeThisFieldQuery text (FieldName fieldName)
534− percent mtf mqt stopwords mindf maxdf
535− minwl maxwl boostTerms boost analyzer) =
536− object [ fieldName .= omitNulls base ]
537− where base = [ "like_text" .= text
538− , "percent_terms_to_match" .= percent
539− , "min_term_freq" .= mtf
540− , "max_query_terms" .= mqt
541− , "stop_words" .= stopwords
542− , "min_doc_freq" .= mindf
543− , "max_doc_freq" .= maxdf
544− , "min_word_length" .= minwl
545− , "max_word_length" .= maxwl
546− , "boost_terms" .= boostTerms
547− , "boost" .= boost
548− , "analyzer" .= analyzer ]
549−
550−instance FromJSON MoreLikeThisFieldQuery where
551− parseJSON = withObject "MoreLikeThisFieldQuery" parse
552− where parse = fieldTagged $ \fn o ->
553− MoreLikeThisFieldQuery
554− <$> o .: "like_text"
555− <*> pure fn
556− <*> o .:? "percent_terms_to_match"
557− <*> o .:? "min_term_freq"
558− <*> o .:? "max_query_terms"
559− -- <*> (optionalNE =<< o .:? "stop_words")
560− <*> o .:? "stop_words"
561− <*> o .:? "min_doc_freq"
562− <*> o .:? "max_doc_freq"
563− <*> o .:? "min_word_length"
564− <*> o .:? "max_word_length"
565− <*> o .:? "boost_terms"
566− <*> o .:? "boost"
567− <*> o .:? "analyzer"
568− -- optionalNE = maybe (pure Nothing) (fmap Just . parseNEJSON)
569−
570−data MoreLikeThisQuery =
571− MoreLikeThisQuery
572− { moreLikeThisText :: Text
573− , moreLikeThisFields :: Maybe (NonEmpty FieldName)
574− -- default 0.3 (30%)
575− , moreLikeThisPercentMatch :: Maybe PercentMatch
576− , moreLikeThisMinimumTermFreq :: Maybe MinimumTermFrequency
577− , moreLikeThisMaxQueryTerms :: Maybe MaxQueryTerms
578− , moreLikeThisStopWords :: Maybe (NonEmpty StopWord)
579− , moreLikeThisMinDocFrequency :: Maybe MinDocFrequency
580− , moreLikeThisMaxDocFrequency :: Maybe MaxDocFrequency
581− , moreLikeThisMinWordLength :: Maybe MinWordLength
582− , moreLikeThisMaxWordLength :: Maybe MaxWordLength
583− , moreLikeThisBoostTerms :: Maybe BoostTerms
584− , moreLikeThisBoost :: Maybe Boost
585− , moreLikeThisAnalyzer :: Maybe Analyzer
586− } deriving (Eq, Show)
587−
588−
589−instance ToJSON MoreLikeThisQuery where
590− toJSON (MoreLikeThisQuery text fields percent
591− mtf mqt stopwords mindf maxdf
592− minwl maxwl boostTerms boost analyzer) =
593− omitNulls base
594− where base = [ "like_text" .= text
595− , "fields" .= fields
596− , "percent_terms_to_match" .= percent
597− , "min_term_freq" .= mtf
598− , "max_query_terms" .= mqt
599− , "stop_words" .= stopwords
600− , "min_doc_freq" .= mindf
601− , "max_doc_freq" .= maxdf
602− , "min_word_length" .= minwl
603− , "max_word_length" .= maxwl
604− , "boost_terms" .= boostTerms
605− , "boost" .= boost
606− , "analyzer" .= analyzer ]
607−
608−instance FromJSON MoreLikeThisQuery where
609− parseJSON = withObject "MoreLikeThisQuery" parse
610− where parse o = MoreLikeThisQuery
611− <$> o .: "like_text"
612− -- <*> (optionalNE =<< o .:? "fields")
613− <*> o .:? "fields"
614− <*> o .:? "percent_terms_to_match"
615− <*> o .:? "min_term_freq"
616− <*> o .:? "max_query_terms"
617− -- <*> (optionalNE =<< o .:? "stop_words")
618− <*> o .:? "stop_words"
619− <*> o .:? "min_doc_freq"
620− <*> o .:? "max_doc_freq"
621− <*> o .:? "min_word_length"
622− <*> o .:? "max_word_length"
623− <*> o .:? "boost_terms"
624− <*> o .:? "boost"
625− <*> o .:? "analyzer"
626− -- optionalNE = maybe (pure Nothing) (fmap Just . parseNEJSON)
627−
628−data IndicesQuery =
629− IndicesQuery
630− { indicesQueryIndices :: [IndexName]
631− , indicesQuery :: Query
632− -- default "all"
633− , indicesQueryNoMatch :: Maybe Query } deriving (Eq, Show)
634−
635−
636−instance ToJSON IndicesQuery where
637− toJSON (IndicesQuery indices query noMatch) =
638− omitNulls [ "indices" .= indices
639− , "no_match_query" .= noMatch
640− , "query" .= query ]
641−
642−instance FromJSON IndicesQuery where
643− parseJSON = withObject "IndicesQuery" parse
644− where parse o = IndicesQuery
645− <$> o .:? "indices" .!= []
646− <*> o .: "query"
647− <*> o .:? "no_match_query"
648−
649−data HasParentQuery =
650− HasParentQuery
651− { hasParentQueryType :: TypeName
652− , hasParentQuery :: Query
653− , hasParentQueryScoreType :: Maybe ScoreType } deriving (Eq, Show)
654−
655−instance ToJSON HasParentQuery where
656− toJSON (HasParentQuery queryType query scoreType) =
657− omitNulls [ "parent_type" .= queryType
658− , "score_type" .= scoreType
659− , "query" .= query ]
660−
661−instance FromJSON HasParentQuery where
662− parseJSON = withObject "HasParentQuery" parse
663− where parse o = HasParentQuery
664− <$> o .: "parent_type"
665− <*> o .: "query"
666− <*> o .:? "score_type"
667−
668−data HasChildQuery =
669− HasChildQuery
670− { hasChildQueryType :: TypeName
671− , hasChildQuery :: Query
672− , hasChildQueryScoreType :: Maybe ScoreType } deriving (Eq, Show)
673−
674−instance ToJSON HasChildQuery where
675− toJSON (HasChildQuery queryType query scoreType) =
676− omitNulls [ "query" .= query
677− , "score_type" .= scoreType
678− , "type" .= queryType ]
679−
680−instance FromJSON HasChildQuery where
681− parseJSON = withObject "HasChildQuery" parse
682− where parse o = HasChildQuery
683− <$> o .: "type"
684− <*> o .: "query"
685− <*> o .:? "score_type"
686−
687−data ScoreType =
688− ScoreTypeMax
689− | ScoreTypeSum
690− | ScoreTypeAvg
691− | ScoreTypeNone deriving (Eq, Show)
692−
693−instance ToJSON ScoreType where
694− toJSON ScoreTypeMax = "max"
695− toJSON ScoreTypeAvg = "avg"
696− toJSON ScoreTypeSum = "sum"
697− toJSON ScoreTypeNone = "none"
698−
699−instance FromJSON ScoreType where
700− parseJSON = withText "ScoreType" parse
701− where parse "max" = pure ScoreTypeMax
702− parse "avg" = pure ScoreTypeAvg
703− parse "sum" = pure ScoreTypeSum
704− parse "none" = pure ScoreTypeNone
705− parse t = fail ("Unexpected ScoreType: " <> show t)
706−
707−data FuzzyQuery =
708− FuzzyQuery { fuzzyQueryField :: FieldName
709− , fuzzyQueryValue :: Text
710− , fuzzyQueryPrefixLength :: PrefixLength
711− , fuzzyQueryMaxExpansions :: MaxExpansions
712− , fuzzyQueryFuzziness :: Fuzziness
713− , fuzzyQueryBoost :: Maybe Boost
714− } deriving (Eq, Show)
715−
716−
717−instance ToJSON FuzzyQuery where
718− toJSON (FuzzyQuery (FieldName fieldName) queryText
719− prefixLength maxEx fuzziness boost) =
720− object [ fieldName .= omitNulls base ]
721− where base = [ "value" .= queryText
722− , "fuzziness" .= fuzziness
723− , "prefix_length" .= prefixLength
724− , "boost" .= boost
725− , "max_expansions" .= maxEx ]
726−
727−instance FromJSON FuzzyQuery where
728− parseJSON = withObject "FuzzyQuery" parse
729− where parse = fieldTagged $ \fn o ->
730− FuzzyQuery fn
731− <$> o .: "value"
732− <*> o .: "prefix_length"
733− <*> o .: "max_expansions"
734− <*> o .: "fuzziness"
735− <*> o .:? "boost"
736−
737−data FuzzyLikeFieldQuery =
738− FuzzyLikeFieldQuery
739− { fuzzyLikeField :: FieldName
740− -- anaphora is good for the soul.
741− , fuzzyLikeFieldText :: Text
742− , fuzzyLikeFieldMaxQueryTerms :: MaxQueryTerms
743− , fuzzyLikeFieldIgnoreTermFrequency :: IgnoreTermFrequency
744− , fuzzyLikeFieldFuzziness :: Fuzziness
745− , fuzzyLikeFieldPrefixLength :: PrefixLength
746− , fuzzyLikeFieldBoost :: Boost
747− , fuzzyLikeFieldAnalyzer :: Maybe Analyzer
748− } deriving (Eq, Show)
749−
750−
751−instance ToJSON FuzzyLikeFieldQuery where
752− toJSON (FuzzyLikeFieldQuery (FieldName fieldName)
753− fieldText maxTerms ignoreFreq fuzziness prefixLength
754− boost analyzer) =
755− object [ fieldName .=
756− omitNulls [ "like_text" .= fieldText
757− , "max_query_terms" .= maxTerms
758− , "ignore_tf" .= ignoreFreq
759− , "fuzziness" .= fuzziness
760− , "prefix_length" .= prefixLength
761− , "analyzer" .= analyzer
762− , "boost" .= boost ]]
763−
764−instance FromJSON FuzzyLikeFieldQuery where
765− parseJSON = withObject "FuzzyLikeFieldQuery" parse
766− where parse = fieldTagged $ \fn o ->
767− FuzzyLikeFieldQuery fn
768− <$> o .: "like_text"
769− <*> o .: "max_query_terms"
770− <*> o .: "ignore_tf"
771− <*> o .: "fuzziness"
772− <*> o .: "prefix_length"
773− <*> o .: "boost"
774− <*> o .:? "analyzer"
775−
776−data FuzzyLikeThisQuery =
777− FuzzyLikeThisQuery
778− { fuzzyLikeFields :: [FieldName]
779− , fuzzyLikeText :: Text
780− , fuzzyLikeMaxQueryTerms :: MaxQueryTerms
781− , fuzzyLikeIgnoreTermFrequency :: IgnoreTermFrequency
782− , fuzzyLikeFuzziness :: Fuzziness
783− , fuzzyLikePrefixLength :: PrefixLength
784− , fuzzyLikeBoost :: Boost
785− , fuzzyLikeAnalyzer :: Maybe Analyzer
786− } deriving (Eq, Show)
787−
788−
789−instance ToJSON FuzzyLikeThisQuery where
790− toJSON (FuzzyLikeThisQuery fields text maxTerms
791− ignoreFreq fuzziness prefixLength boost analyzer) =
792− omitNulls base
793− where base = [ "fields" .= fields
794− , "like_text" .= text
795− , "max_query_terms" .= maxTerms
796− , "ignore_tf" .= ignoreFreq
797− , "fuzziness" .= fuzziness
798− , "prefix_length" .= prefixLength
799− , "analyzer" .= analyzer
800− , "boost" .= boost ]
801−
802−instance FromJSON FuzzyLikeThisQuery where
803− parseJSON = withObject "FuzzyLikeThisQuery" parse
804− where parse o = FuzzyLikeThisQuery
805− <$> o .:? "fields" .!= []
806− <*> o .: "like_text"
807− <*> o .: "max_query_terms"
808− <*> o .: "ignore_tf"
809− <*> o .: "fuzziness"
810− <*> o .: "prefix_length"
811− <*> o .: "boost"
812− <*> o .:? "analyzer"
813−
814−data DisMaxQuery =
815− DisMaxQuery { disMaxQueries :: [Query]
816− -- default 0.0
817− , disMaxTiebreaker :: Tiebreaker
818− , disMaxBoost :: Maybe Boost
819− } deriving (Eq, Show)
820−
821−
822−instance ToJSON DisMaxQuery where
823− toJSON (DisMaxQuery queries tiebreaker boost) =
824− omitNulls base
825− where base = [ "queries" .= queries
826− , "boost" .= boost
827− , "tie_breaker" .= tiebreaker ]
828−
829−instance FromJSON DisMaxQuery where
830− parseJSON = withObject "DisMaxQuery" parse
831− where parse o = DisMaxQuery
832− <$> o .:? "queries" .!= []
833− <*> o .: "tie_breaker"
834− <*> o .:? "boost"
835−
836−data MatchQuery = MatchQuery
837− { matchQueryField :: FieldName
838− , matchQueryQueryString :: QueryString
839− , matchQueryOperator :: BooleanOperator
840− , matchQueryZeroTerms :: ZeroTermsQuery
841− , matchQueryCutoffFrequency :: Maybe CutoffFrequency
842− , matchQueryMatchType :: Maybe MatchQueryType
843− , matchQueryAnalyzer :: Maybe Analyzer
844− , matchQueryMaxExpansions :: Maybe MaxExpansions
845− , matchQueryLenient :: Maybe Lenient
846− , matchQueryBoost :: Maybe Boost
847− , matchQueryMinimumShouldMatch :: Maybe Text
848− , matchQueryFuzziness :: Maybe Fuzziness
849− } deriving (Eq, Show)
850−
851−
852−instance ToJSON MatchQuery where
853− toJSON (MatchQuery (FieldName fieldName)
854− (QueryString mqQueryString) booleanOperator
855− zeroTermsQuery cutoffFrequency matchQueryType
856− analyzer maxExpansions lenient boost
857− minShouldMatch mqFuzziness
858− ) =
859− object [ fieldName .= omitNulls base ]
860− where base = [ "query" .= mqQueryString
861− , "operator" .= booleanOperator
862− , "zero_terms_query" .= zeroTermsQuery
863− , "cutoff_frequency" .= cutoffFrequency
864− , "type" .= matchQueryType
865− , "analyzer" .= analyzer
866− , "max_expansions" .= maxExpansions
867− , "lenient" .= lenient
868− , "boost" .= boost
869− , "minimum_should_match" .= minShouldMatch
870− , "fuzziness" .= mqFuzziness
871− ]
872−
873−instance FromJSON MatchQuery where
874− parseJSON = withObject "MatchQuery" parse
875− where parse = fieldTagged $ \fn o ->
876− MatchQuery fn
877− <$> o .: "query"
878− <*> o .: "operator"
879− <*> o .: "zero_terms_query"
880− <*> o .:? "cutoff_frequency"
881− <*> o .:? "type"
882− <*> o .:? "analyzer"
883− <*> o .:? "max_expansions"
884− <*> o .:? "lenient"
885− <*> o .:? "boost"
886− <*> o .:? "minimum_should_match"
887− <*> o .:? "fuzziness"
888−
889−{-| 'mkMatchQuery' is a convenience function that defaults the less common parameters,
890− enabling you to provide only the 'FieldName' and 'QueryString' to make a 'MatchQuery'
891−-}
892−mkMatchQuery :: FieldName -> QueryString -> MatchQuery
893−mkMatchQuery field query = MatchQuery field query Or ZeroTermsNone Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing
894−
895−data MatchQueryType =
896− MatchPhrase
897− | MatchPhrasePrefix deriving (Eq, Show)
898−
899−instance ToJSON MatchQueryType where
900− toJSON MatchPhrase = "phrase"
901− toJSON MatchPhrasePrefix = "phrase_prefix"
902−
903−instance FromJSON MatchQueryType where
904− parseJSON = withText "MatchQueryType" parse
905− where parse "phrase" = pure MatchPhrase
906− parse "phrase_prefix" = pure MatchPhrasePrefix
907− parse t = fail ("Unexpected MatchQueryType: " <> show t)
908−
909−data MultiMatchQuery = MultiMatchQuery
910− { multiMatchQueryFields :: [FieldName]
911− , multiMatchQueryString :: QueryString
912− , multiMatchQueryOperator :: BooleanOperator
913− , multiMatchQueryZeroTerms :: ZeroTermsQuery
914− , multiMatchQueryTiebreaker :: Maybe Tiebreaker
915− , multiMatchQueryType :: Maybe MultiMatchQueryType
916− , multiMatchQueryCutoffFrequency :: Maybe CutoffFrequency
917− , multiMatchQueryAnalyzer :: Maybe Analyzer
918− , multiMatchQueryMaxExpansions :: Maybe MaxExpansions
919− , multiMatchQueryLenient :: Maybe Lenient
920− } deriving (Eq, Show)
921−
922−instance ToJSON MultiMatchQuery where
923− toJSON (MultiMatchQuery fields (QueryString query) boolOp
924− ztQ tb mmqt cf analyzer maxEx lenient) =
925− object ["multi_match" .= omitNulls base]
926− where base = [ "fields" .= fmap toJSON fields
927− , "query" .= query
928− , "operator" .= boolOp
929− , "zero_terms_query" .= ztQ
930− , "tie_breaker" .= tb
931− , "type" .= mmqt
932− , "cutoff_frequency" .= cf
933− , "analyzer" .= analyzer
934− , "max_expansions" .= maxEx
935− , "lenient" .= lenient ]
936−
937−instance FromJSON MultiMatchQuery where
938− parseJSON = withObject "MultiMatchQuery" parse
939− where parse raw = do o <- raw .: "multi_match"
940− MultiMatchQuery
941− <$> o .:? "fields" .!= []
942− <*> o .: "query"
943− <*> o .: "operator"
944− <*> o .: "zero_terms_query"
945− <*> o .:? "tie_breaker"
946− <*> o .:? "type"
947− <*> o .:? "cutoff_frequency"
948− <*> o .:? "analyzer"
949− <*> o .:? "max_expansions"
950− <*> o .:? "lenient"
951−
952−{-| 'mkMultiMatchQuery' is a convenience function that defaults the less common parameters,
953− enabling you to provide only the list of 'FieldName's and 'QueryString' to
954− make a 'MultiMatchQuery'.
955−-}
956−
957−mkMultiMatchQuery :: [FieldName] -> QueryString -> MultiMatchQuery
958−mkMultiMatchQuery matchFields query =
959− MultiMatchQuery matchFields query
960− Or ZeroTermsNone Nothing Nothing Nothing Nothing Nothing Nothing
961−
962−data MultiMatchQueryType =
963− MultiMatchBestFields
964− | MultiMatchMostFields
965− | MultiMatchCrossFields
966− | MultiMatchPhrase
967− | MultiMatchPhrasePrefix deriving (Eq, Show)
968−
969−instance ToJSON MultiMatchQueryType where
970− toJSON MultiMatchBestFields = "best_fields"
971− toJSON MultiMatchMostFields = "most_fields"
972− toJSON MultiMatchCrossFields = "cross_fields"
973− toJSON MultiMatchPhrase = "phrase"
974− toJSON MultiMatchPhrasePrefix = "phrase_prefix"
975−
976−instance FromJSON MultiMatchQueryType where
977− parseJSON = withText "MultiMatchPhrasePrefix" parse
978− where parse "best_fields" = pure MultiMatchBestFields
979− parse "most_fields" = pure MultiMatchMostFields
980− parse "cross_fields" = pure MultiMatchCrossFields
981− parse "phrase" = pure MultiMatchPhrase
982− parse "phrase_prefix" = pure MultiMatchPhrasePrefix
983− parse t = fail ("Unexpected MultiMatchPhrasePrefix: " <> show t)
984−
985−data BoolQuery =
986− BoolQuery { boolQueryMustMatch :: [Query]
987− , boolQueryFilter :: [Filter]
988− , boolQueryMustNotMatch :: [Query]
989− , boolQueryShouldMatch :: [Query]
990− , boolQueryMinimumShouldMatch :: Maybe MinimumMatch
991− , boolQueryBoost :: Maybe Boost
992− , boolQueryDisableCoord :: Maybe DisableCoord
993− } deriving (Eq, Show)
994−
995−
996−instance ToJSON BoolQuery where
997− toJSON (BoolQuery mustM filterM' notM shouldM bqMin boost disableCoord) =
998− omitNulls base
999− where base = [ "must" .= mustM
1000− , "filter" .= filterM'
1001− , "must_not" .= notM
1002− , "should" .= shouldM
1003− , "minimum_should_match" .= bqMin
1004− , "boost" .= boost
1005− , "disable_coord" .= disableCoord ]
1006−
1007−instance FromJSON BoolQuery where
1008− parseJSON = withObject "BoolQuery" parse
1009− where parse o = BoolQuery
1010− <$> o .:? "must" .!= []
1011− <*> o .:? "filter" .!= []
1012− <*> o .:? "must_not" .!= []
1013− <*> o .:? "should" .!= []
1014− <*> o .:? "minimum_should_match"
1015− <*> o .:? "boost"
1016− <*> o .:? "disable_coord"
1017−
1018−mkBoolQuery :: [Query] -> [Filter] -> [Query] -> [Query] -> BoolQuery
1019−mkBoolQuery must filt mustNot should =
1020− BoolQuery must filt mustNot should Nothing Nothing Nothing
1021−
1022−data BoostingQuery =
1023− BoostingQuery { positiveQuery :: Query
1024− , negativeQuery :: Query
1025− , negativeBoost :: Boost } deriving (Eq, Show)
1026−
1027−instance ToJSON BoostingQuery where
1028− toJSON (BoostingQuery bqPositiveQuery bqNegativeQuery bqNegativeBoost) =
1029− object [ "positive" .= bqPositiveQuery
1030− , "negative" .= bqNegativeQuery
1031− , "negative_boost" .= bqNegativeBoost ]
1032−
1033−instance FromJSON BoostingQuery where
1034− parseJSON = withObject "BoostingQuery" parse
1035− where parse o = BoostingQuery
1036− <$> o .: "positive"
1037− <*> o .: "negative"
1038− <*> o .: "negative_boost"
1039−
1040−data CommonTermsQuery =
1041− CommonTermsQuery { commonField :: FieldName
1042− , commonQuery :: QueryString
1043− , commonCutoffFrequency :: CutoffFrequency
1044− , commonLowFreqOperator :: BooleanOperator
1045− , commonHighFreqOperator :: BooleanOperator
1046− , commonMinimumShouldMatch :: Maybe CommonMinimumMatch
1047− , commonBoost :: Maybe Boost
1048− , commonAnalyzer :: Maybe Analyzer
1049− , commonDisableCoord :: Maybe DisableCoord
1050− } deriving (Eq, Show)
1051−
1052−
1053−instance ToJSON CommonTermsQuery where
1054− toJSON (CommonTermsQuery (FieldName fieldName)
1055− (QueryString query) cf lfo hfo msm
1056− boost analyzer disableCoord) =
1057− object [fieldName .= omitNulls base ]
1058− where base = [ "query" .= query
1059− , "cutoff_frequency" .= cf
1060− , "low_freq_operator" .= lfo
1061− , "minimum_should_match" .= msm
1062− , "boost" .= boost
1063− , "analyzer" .= analyzer
1064− , "disable_coord" .= disableCoord
1065− , "high_freq_operator" .= hfo ]
1066−
1067−instance FromJSON CommonTermsQuery where
1068− parseJSON = withObject "CommonTermsQuery" parse
1069− where parse = fieldTagged $ \fn o ->
1070− CommonTermsQuery fn
1071− <$> o .: "query"
1072− <*> o .: "cutoff_frequency"
1073− <*> o .: "low_freq_operator"
1074− <*> o .: "high_freq_operator"
1075− <*> o .:? "minimum_should_match"
1076− <*> o .:? "boost"
1077− <*> o .:? "analyzer"
1078− <*> o .:? "disable_coord"
1079−
1080−data CommonMinimumMatch =
1081− CommonMinimumMatchHighLow MinimumMatchHighLow
1082− | CommonMinimumMatch MinimumMatch
1083− deriving (Eq, Show)
1084−
1085−
1086−instance ToJSON CommonMinimumMatch where
1087− toJSON (CommonMinimumMatch mm) = toJSON mm
1088− toJSON (CommonMinimumMatchHighLow (MinimumMatchHighLow lowF highF)) =
1089− object [ "low_freq" .= lowF
1090− , "high_freq" .= highF ]
1091−
1092−instance FromJSON CommonMinimumMatch where
1093− parseJSON v = parseMinimum v
1094− <|> parseMinimumHighLow v
1095− where parseMinimum = fmap CommonMinimumMatch . parseJSON
1096− parseMinimumHighLow = fmap CommonMinimumMatchHighLow . withObject "CommonMinimumMatchHighLow" (\o ->
1097− MinimumMatchHighLow
1098− <$> o .: "low_freq"
1099− <*> o .: "high_freq")
1100−
1101−data MinimumMatchHighLow =
1102− MinimumMatchHighLow { lowFreq :: MinimumMatch
1103− , highFreq :: MinimumMatch } deriving (Eq, Show)
1104−
1105−data ZeroTermsQuery =
1106− ZeroTermsNone
1107− | ZeroTermsAll deriving (Eq, Show)
1108−
1109−instance ToJSON ZeroTermsQuery where
1110− toJSON ZeroTermsNone = String "none"
1111− toJSON ZeroTermsAll = String "all"
1112−
1113−instance FromJSON ZeroTermsQuery where
1114− parseJSON = withText "ZeroTermsQuery" parse
1115− where parse "none" = pure ZeroTermsNone
1116− parse "all" = pure ZeroTermsAll
1117− parse q = fail ("Unexpected ZeroTermsQuery: " <> show q)
1118−
1119−data RangeExecution = RangeExecutionIndex
1120− | RangeExecutionFielddata deriving (Eq, Show)
1121−
1122−-- index for smaller ranges, fielddata for longer ranges
1123−instance ToJSON RangeExecution where
1124− toJSON RangeExecutionIndex = "index"
1125− toJSON RangeExecutionFielddata = "fielddata"
1126−
1127−
1128−instance FromJSON RangeExecution where
1129− parseJSON = withText "RangeExecution" parse
1130− where parse "index" = pure RangeExecutionIndex
1131− parse "fielddata" = pure RangeExecutionFielddata
1132− parse t = error ("Unrecognized RangeExecution " <> show t)
1133−
1134−newtype Regexp = Regexp Text deriving (Eq, Show, FromJSON)
1135−
1136−data RegexpFlags = AllRegexpFlags
1137− | NoRegexpFlags
1138− | SomeRegexpFlags (NonEmpty RegexpFlag) deriving (Eq, Show)
1139−
1140−instance ToJSON RegexpFlags where
1141− toJSON AllRegexpFlags = String "ALL"
1142− toJSON NoRegexpFlags = String "NONE"
1143− toJSON (SomeRegexpFlags (h :| fs)) = String $ T.intercalate "|" flagStrs
1144− where flagStrs = map flagStr . nub $ h:fs
1145− flagStr AnyString = "ANYSTRING"
1146− flagStr Automaton = "AUTOMATON"
1147− flagStr Complement = "COMPLEMENT"
1148− flagStr Empty = "EMPTY"
1149− flagStr Intersection = "INTERSECTION"
1150− flagStr Interval = "INTERVAL"
1151−
1152−instance FromJSON RegexpFlags where
1153− parseJSON = withText "RegexpFlags" parse
1154− where parse "ALL" = pure AllRegexpFlags
1155− parse "NONE" = pure NoRegexpFlags
1156− parse t = SomeRegexpFlags <$> parseNEJSON (String <$> T.splitOn "|" t)
1157−
1158−data RegexpFlag = AnyString
1159− | Automaton
1160− | Complement
1161− | Empty
1162− | Intersection
1163− | Interval deriving (Eq, Show)
1164−
1165−instance FromJSON RegexpFlag where
1166− parseJSON = withText "RegexpFlag" parse
1167− where parse "ANYSTRING" = pure AnyString
1168− parse "AUTOMATON" = pure Automaton
1169− parse "COMPLEMENT" = pure Complement
1170− parse "EMPTY" = pure Empty
1171− parse "INTERSECTION" = pure Intersection
1172− parse "INTERVAL" = pure Interval
1173− parse f = fail ("Unknown RegexpFlag: " <> show f)
1174−
1175−newtype LessThan = LessThan Double deriving (Eq, Show)
1176−newtype LessThanEq = LessThanEq Double deriving (Eq, Show)
1177−newtype GreaterThan = GreaterThan Double deriving (Eq, Show)
1178−newtype GreaterThanEq = GreaterThanEq Double deriving (Eq, Show)
1179−
1180−newtype LessThanD = LessThanD UTCTime deriving (Eq, Show)
1181−newtype LessThanEqD = LessThanEqD UTCTime deriving (Eq, Show)
1182−newtype GreaterThanD = GreaterThanD UTCTime deriving (Eq, Show)
1183−newtype GreaterThanEqD = GreaterThanEqD UTCTime deriving (Eq, Show)
1184−
1185−data RangeValue = RangeDateLte LessThanEqD
1186− | RangeDateLt LessThanD
1187− | RangeDateGte GreaterThanEqD
1188− | RangeDateGt GreaterThanD
1189− | RangeDateGtLt GreaterThanD LessThanD
1190− | RangeDateGteLte GreaterThanEqD LessThanEqD
1191− | RangeDateGteLt GreaterThanEqD LessThanD
1192− | RangeDateGtLte GreaterThanD LessThanEqD
1193− | RangeDoubleLte LessThanEq
1194− | RangeDoubleLt LessThan
1195− | RangeDoubleGte GreaterThanEq
1196− | RangeDoubleGt GreaterThan
1197− | RangeDoubleGtLt GreaterThan LessThan
1198− | RangeDoubleGteLte GreaterThanEq LessThanEq
1199− | RangeDoubleGteLt GreaterThanEq LessThan
1200− | RangeDoubleGtLte GreaterThan LessThanEq
1201− deriving (Eq, Show)
1202−
1203−
1204−parseRangeValue :: ( FromJSON t4
1205− , FromJSON t3
1206− , FromJSON t2
1207− , FromJSON t1
1208− )
1209− => (t3 -> t5)
1210− -> (t1 -> t6)
1211− -> (t4 -> t7)
1212− -> (t2 -> t8)
1213− -> (t5 -> t6 -> b)
1214− -> (t7 -> t6 -> b)
1215− -> (t5 -> t8 -> b)
1216− -> (t7 -> t8 -> b)
1217− -> (t5 -> b)
1218− -> (t6 -> b)
1219− -> (t7 -> b)
1220− -> (t8 -> b)
1221− -> Parser b
1222− -> Object
1223− -> Parser b
1224−parseRangeValue mkGt mkLt mkGte mkLte
1225− fGtLt fGteLt fGtLte fGteLte
1226− fGt fLt fGte fLte nada o = do
1227− lt <- o .:? "lt"
1228− lte <- o .:? "lte"
1229− gt <- o .:? "gt"
1230− gte <- o .:? "gte"
1231− case (lt, lte, gt, gte) of
1232− (Just a, _, Just b, _) ->
1233− return (fGtLt (mkGt b) (mkLt a))
1234− (Just a, _, _, Just b) ->
1235− return (fGteLt (mkGte b) (mkLt a))
1236− (_, Just a, Just b, _) ->
1237− return (fGtLte (mkGt b) (mkLte a))
1238− (_, Just a, _, Just b) ->
1239− return (fGteLte (mkGte b) (mkLte a))
1240− (_, _, Just a, _) ->
1241− return (fGt (mkGt a))
1242− (Just a, _, _, _) ->
1243− return (fLt (mkLt a))
1244− (_, _, _, Just a) ->
1245− return (fGte (mkGte a))
1246− (_, Just a, _, _) ->
1247− return (fLte (mkLte a))
1248− (Nothing, Nothing, Nothing, Nothing) ->
1249− nada
1250−
1251−
1252−instance FromJSON RangeValue where
1253− parseJSON = withObject "RangeValue" parse
1254− where parse o = parseDate o
1255− <|> parseDouble o
1256− parseDate o =
1257− parseRangeValue
1258− GreaterThanD LessThanD
1259− GreaterThanEqD LessThanEqD
1260− RangeDateGtLt RangeDateGteLt
1261− RangeDateGtLte RangeDateGteLte
1262− RangeDateGt RangeDateLt
1263− RangeDateGte RangeDateLte
1264− mzero o
1265− parseDouble o =
1266− parseRangeValue
1267− GreaterThan LessThan
1268− GreaterThanEq LessThanEq
1269− RangeDoubleGtLt RangeDoubleGteLt
1270− RangeDoubleGtLte RangeDoubleGteLte
1271− RangeDoubleGt RangeDoubleLt
1272− RangeDoubleGte RangeDoubleLte
1273− mzero o
1274−
1275−rangeValueToPair :: RangeValue -> [Pair]
1276−rangeValueToPair rv = case rv of
1277− RangeDateLte (LessThanEqD t) -> ["lte" .= t]
1278− RangeDateGte (GreaterThanEqD t) -> ["gte" .= t]
1279− RangeDateLt (LessThanD t) -> ["lt" .= t]
1280− RangeDateGt (GreaterThanD t) -> ["gt" .= t]
1281− RangeDateGteLte (GreaterThanEqD l) (LessThanEqD g) -> ["gte" .= l, "lte" .= g]
1282− RangeDateGtLte (GreaterThanD l) (LessThanEqD g) -> ["gt" .= l, "lte" .= g]
1283− RangeDateGteLt (GreaterThanEqD l) (LessThanD g) -> ["gte" .= l, "lt" .= g]
1284− RangeDateGtLt (GreaterThanD l) (LessThanD g) -> ["gt" .= l, "lt" .= g]
1285− RangeDoubleLte (LessThanEq t) -> ["lte" .= t]
1286− RangeDoubleGte (GreaterThanEq t) -> ["gte" .= t]
1287− RangeDoubleLt (LessThan t) -> ["lt" .= t]
1288− RangeDoubleGt (GreaterThan t) -> ["gt" .= t]
1289− RangeDoubleGteLte (GreaterThanEq l) (LessThanEq g) -> ["gte" .= l, "lte" .= g]
1290− RangeDoubleGtLte (GreaterThan l) (LessThanEq g) -> ["gt" .= l, "lte" .= g]
1291− RangeDoubleGteLt (GreaterThanEq l) (LessThan g) -> ["gte" .= l, "lt" .= g]
1292− RangeDoubleGtLt (GreaterThan l) (LessThan g) -> ["gt" .= l, "lt" .= g]
1293−
1294−data Term = Term { termField :: Text
1295− , termValue :: Text } deriving (Eq, Show)
1296−
1297−instance ToJSON Term where
1298− toJSON (Term field value) = object ["term" .= object
1299− [field .= value]]
1300−
1301−instance FromJSON Term where
1302− parseJSON = withObject "Term" parse
1303− where parse o = do termObj <- o .: "term"
1304− case HM.toList termObj of
1305− [(fn, v)] -> Term fn <$> parseJSON v
1306− _ -> fail "Expected object with 1 field-named key"
1307−
1308−data BoolMatch = MustMatch Term Cache
1309− | MustNotMatch Term Cache
1310− | ShouldMatch [Term] Cache deriving (Eq, Show)
1311−
1312−
1313−instance ToJSON BoolMatch where
1314− toJSON (MustMatch term cache) = object ["must" .= term,
1315− "_cache" .= cache]
1316− toJSON (MustNotMatch term cache) = object ["must_not" .= term,
1317− "_cache" .= cache]
1318− toJSON (ShouldMatch terms cache) = object ["should" .= fmap toJSON terms,
1319− "_cache" .= cache]
1320−
1321−instance FromJSON BoolMatch where
1322− parseJSON = withObject "BoolMatch" parse
1323− where parse o = mustMatch `taggedWith` "must"
1324− <|> mustNotMatch `taggedWith` "must_not"
1325− <|> shouldMatch `taggedWith` "should"
1326− where taggedWith parser k = parser =<< o .: k
1327− mustMatch t = MustMatch t <$> o .:? "_cache" .!= defaultCache
1328− mustNotMatch t = MustNotMatch t <$> o .:? "_cache" .!= defaultCache
1329− shouldMatch t = ShouldMatch t <$> o .:? "_cache" .!= defaultCache
1330−
1331−-- "memory" or "indexed"
1332−data GeoFilterType = GeoFilterMemory
1333− | GeoFilterIndexed deriving (Eq, Show)
1334−
1335−instance ToJSON GeoFilterType where
1336− toJSON GeoFilterMemory = String "memory"
1337− toJSON GeoFilterIndexed = String "indexed"
1338−
1339−instance FromJSON GeoFilterType where
1340− parseJSON = withText "GeoFilterType" parse
1341− where parse "memory" = pure GeoFilterMemory
1342− parse "indexed" = pure GeoFilterIndexed
1343− parse t = fail ("Unrecognized GeoFilterType: " <> show t)
1344−
1345−data LatLon = LatLon { lat :: Double
1346− , lon :: Double } deriving (Eq, Show)
1347−
1348−instance ToJSON LatLon where
1349− toJSON (LatLon lLat lLon) =
1350− object ["lat" .= lLat
1351− , "lon" .= lLon]
1352−
1353−instance FromJSON LatLon where
1354− parseJSON = withObject "LatLon" parse
1355− where parse o = LatLon <$> o .: "lat"
1356− <*> o .: "lon"
1357−
1358−data GeoBoundingBox =
1359− GeoBoundingBox { topLeft :: LatLon
1360− , bottomRight :: LatLon } deriving (Eq, Show)
1361−
1362−instance ToJSON GeoBoundingBox where
1363− toJSON (GeoBoundingBox gbbTopLeft gbbBottomRight) =
1364− object ["top_left" .= gbbTopLeft
1365− , "bottom_right" .= gbbBottomRight]
1366−
1367−instance FromJSON GeoBoundingBox where
1368− parseJSON = withObject "GeoBoundingBox" parse
1369− where parse o = GeoBoundingBox
1370− <$> o .: "top_left"
1371− <*> o .: "bottom_right"
1372−
1373−data GeoBoundingBoxConstraint =
1374− GeoBoundingBoxConstraint { geoBBField :: FieldName
1375− , constraintBox :: GeoBoundingBox
1376− , bbConstraintcache :: Cache
1377− , geoType :: GeoFilterType
1378− } deriving (Eq, Show)
1379−
1380−instance ToJSON GeoBoundingBoxConstraint where
1381− toJSON (GeoBoundingBoxConstraint
1382− (FieldName gbbcGeoBBField) gbbcConstraintBox cache type') =
1383− object [gbbcGeoBBField .= gbbcConstraintBox
1384− , "_cache" .= cache
1385− , "type" .= type']
1386−
1387−instance FromJSON GeoBoundingBoxConstraint where
1388− parseJSON = withObject "GeoBoundingBoxConstraint" parse
1389− where parse o = case HM.toList (deleteSeveral ["type", "_cache"] o) of
1390− [(fn, v)] -> GeoBoundingBoxConstraint (FieldName fn)
1391− <$> parseJSON v
1392− <*> o .:? "_cache" .!= defaultCache
1393− <*> o .: "type"
1394− _ -> fail "Could not find field name for GeoBoundingBoxConstraint"
1395−
1396−data GeoPoint =
1397− GeoPoint { geoField :: FieldName
1398− , latLon :: LatLon} deriving (Eq, Show)
1399−
1400−instance ToJSON GeoPoint where
1401− toJSON (GeoPoint (FieldName geoPointField) geoPointLatLon) =
1402− object [ geoPointField .= geoPointLatLon ]
1403−
1404−data DistanceUnit = Miles
1405− | Yards
1406− | Feet
1407− | Inches
1408− | Kilometers
1409− | Meters
1410− | Centimeters
1411− | Millimeters
1412− | NauticalMiles deriving (Eq, Show)
1413−
1414−instance ToJSON DistanceUnit where
1415− toJSON Miles = String "mi"
1416− toJSON Yards = String "yd"
1417− toJSON Feet = String "ft"
1418− toJSON Inches = String "in"
1419− toJSON Kilometers = String "km"
1420− toJSON Meters = String "m"
1421− toJSON Centimeters = String "cm"
1422− toJSON Millimeters = String "mm"
1423− toJSON NauticalMiles = String "nmi"
1424−
1425−instance FromJSON DistanceUnit where
1426− parseJSON = withText "DistanceUnit" parse
1427− where parse "mi" = pure Miles
1428− parse "yd" = pure Yards
1429− parse "ft" = pure Feet
1430− parse "in" = pure Inches
1431− parse "km" = pure Kilometers
1432− parse "m" = pure Meters
1433− parse "cm" = pure Centimeters
1434− parse "mm" = pure Millimeters
1435− parse "nmi" = pure NauticalMiles
1436− parse u = fail ("Unrecognized DistanceUnit: " <> show u)
1437−
1438−data DistanceType = Arc
1439− | SloppyArc -- doesn't exist <1.0
1440− | Plane deriving (Eq, Show)
1441−
1442−instance ToJSON DistanceType where
1443− toJSON Arc = String "arc"
1444− toJSON SloppyArc = String "sloppy_arc"
1445− toJSON Plane = String "plane"
1446−
1447−instance FromJSON DistanceType where
1448− parseJSON = withText "DistanceType" parse
1449− where parse "arc" = pure Arc
1450− parse "sloppy_arc" = pure SloppyArc
1451− parse "plane" = pure Plane
1452− parse t = fail ("Unrecognized DistanceType: " <> show t)
1453−
1454−data OptimizeBbox = OptimizeGeoFilterType GeoFilterType
1455− | NoOptimizeBbox deriving (Eq, Show)
1456−
1457−
1458−instance ToJSON OptimizeBbox where
1459− toJSON NoOptimizeBbox = String "none"
1460− toJSON (OptimizeGeoFilterType gft) = toJSON gft
1461−
1462−instance FromJSON OptimizeBbox where
1463− parseJSON v = withText "NoOptimizeBbox" parseNoOptimize v
1464− <|> parseOptimize v
1465− where parseNoOptimize "none" = pure NoOptimizeBbox
1466− parseNoOptimize _ = mzero
1467− parseOptimize = fmap OptimizeGeoFilterType . parseJSON
1468−
1469−data Distance =
1470− Distance { coefficient :: Double
1471− , unit :: DistanceUnit } deriving (Eq, Show)
1472−
1473−
1474−instance ToJSON Distance where
1475− toJSON (Distance dCoefficient dUnit) =
1476− String boltedTogether where
1477− coefText = showText dCoefficient
1478− (String unitText) = toJSON dUnit
1479− boltedTogether = mappend coefText unitText
1480−
1481−instance FromJSON Distance where
1482− parseJSON = withText "Distance" parse
1483− where parse t = Distance <$> parseCoeff nT
1484− <*> parseJSON (String unitT)
1485− where (nT, unitT) = T.span validForNumber t
1486− -- may be a better way to do this
1487− validForNumber '-' = True
1488− validForNumber '.' = True
1489− validForNumber 'e' = True
1490− validForNumber c = isNumber c
1491− parseCoeff "" = fail "Empty string cannot be parsed as number"
1492− parseCoeff s = return (read (T.unpack s))
1493−
1494−data DistanceRange =
1495− DistanceRange { distanceFrom :: Distance
1496− , distanceTo :: Distance } deriving (Eq, Show)
1497−
1498−type TemplateQueryKey = Text
1499−type TemplateQueryValue = Text
1500−
1501−newtype TemplateQueryKeyValuePairs =
1502− TemplateQueryKeyValuePairs (HM.HashMap TemplateQueryKey TemplateQueryValue)
1503− deriving (Eq, Show)
1504−
1505−instance ToJSON TemplateQueryKeyValuePairs where
1506− toJSON (TemplateQueryKeyValuePairs x) =
1507− Object $ HM.map toJSON x
1508−
1509−instance FromJSON TemplateQueryKeyValuePairs where
1510− parseJSON (Object o) =
1511− pure . TemplateQueryKeyValuePairs $ HM.mapMaybe getValue o
1512− where getValue (String x) = Just x
1513− getValue _ = Nothing
1514− parseJSON _ =
1515− fail "error parsing TemplateQueryKeyValuePairs"
1516−
1517−data TemplateQueryInline =
1518− TemplateQueryInline { inline :: Query
1519− , params :: TemplateQueryKeyValuePairs
1520− }
1521− deriving (Eq, Show)
1522−
1523−instance ToJSON TemplateQueryInline where
1524− toJSON TemplateQueryInline{..} = object [ "inline" .= inline
1525− , "params" .= params
1526− ]
1527−
1528−instance FromJSON TemplateQueryInline where
1529− parseJSON = withObject "TemplateQueryInline" parse
1530− where parse o = TemplateQueryInline
1531− <$> o .: "inline"
1532− <*> o .: "params"
1533−
1534−{-| 'BooleanOperator' is the usual And/Or operators with an ES compatible
1535− JSON encoding baked in. Used all over the place.
1536−-}
1537−data BooleanOperator = And | Or deriving (Eq, Show)
1538−
1539−instance ToJSON BooleanOperator where
1540− toJSON And = String "and"
1541− toJSON Or = String "or"
1542−
1543−instance FromJSON BooleanOperator where
1544− parseJSON = withText "BooleanOperator" parse
1545− where parse "and" = pure And
1546− parse "or" = pure Or
1547− parse o = fail ("Unexpected BooleanOperator: " <> show o)
1548−
1549−{-| 'Cache' is for telling ES whether it should cache a 'Filter' not.
1550− 'Query's cannot be cached.
1551−-}
1552−type Cache = Bool -- caching on/off
1553−defaultCache :: Cache
1554−defaultCache = False
1555−
1556−
1557−data FunctionScoreQuery =
1558− FunctionScoreQuery { functionScoreQuery :: Maybe Query
1559− , functionScoreBoost :: Maybe Boost
1560− , functionScoreFunctions :: FunctionScoreFunctions
1561− , functionScoreMaxBoost :: Maybe Boost
1562− , functionScoreBoostMode :: Maybe BoostMode
1563− , functionScoreMinScore :: Score
1564− , functionScoreScoreMode :: Maybe ScoreMode
1565− } deriving (Eq, Show)
1566−
1567−instance ToJSON FunctionScoreQuery where
1568− toJSON (FunctionScoreQuery query boost fns maxBoost boostMode minScore scoreMode) =
1569− omitNulls base
1570− where base = functionScoreFunctionsPair fns :
1571− [ "query" .= query
1572− , "boost" .= boost
1573− , "max_boost" .= maxBoost
1574− , "boost_mode" .= boostMode
1575− , "min_score" .= minScore
1576− , "score_mode" .= scoreMode ]
1577−
1578−instance FromJSON FunctionScoreQuery where
1579− parseJSON = withObject "FunctionScoreQuery" parse
1580− where parse o = FunctionScoreQuery
1581− <$> o .:? "query"
1582− <*> o .:? "boost"
1583− <*> (singleFunction o
1584− <|> multipleFunctions `taggedWith` "functions")
1585− <*> o .:? "max_boost"
1586− <*> o .:? "boost_mode"
1587− <*> o .:? "min_score"
1588− <*> o .:? "score_mode"
1589− where taggedWith parser k = parser =<< o .: k
1590− singleFunction = fmap FunctionScoreSingle . parseFunctionScoreFunction
1591− multipleFunctions = pure . FunctionScoreMultiple
1592−
1593−data FunctionScoreFunctions =
1594− FunctionScoreSingle FunctionScoreFunction
1595− | FunctionScoreMultiple (NonEmpty ComponentFunctionScoreFunction) deriving (Eq, Show)
1596−
1597−data ComponentFunctionScoreFunction =
1598− ComponentFunctionScoreFunction { componentScoreFunctionFilter :: Maybe Filter
1599− , componentScoreFunction :: FunctionScoreFunction
1600− , componentScoreFunctionWeight :: Maybe Weight
1601− } deriving (Eq, Show)
1602−
1603−instance ToJSON ComponentFunctionScoreFunction where
1604− toJSON (ComponentFunctionScoreFunction filter' fn weight) =
1605− omitNulls base
1606− where base = functionScoreFunctionPair fn :
1607− [ "filter" .= filter'
1608− , "weight" .= weight ]
1609−
1610−instance FromJSON ComponentFunctionScoreFunction where
1611− parseJSON = withObject "ComponentFunctionScoreFunction" parse
1612− where parse o = ComponentFunctionScoreFunction
1613− <$> o .:? "filter"
1614− <*> parseFunctionScoreFunction o
1615− <*> o .:? "weight"
1616−
1617−functionScoreFunctionsPair :: FunctionScoreFunctions -> (Text, Value)
1618−functionScoreFunctionsPair (FunctionScoreSingle fn)
1619− = functionScoreFunctionPair fn
1620−functionScoreFunctionsPair (FunctionScoreMultiple componentFns) =
1621− ("functions", toJSON componentFns)
1622−
1623−fieldTagged :: Monad m => (FieldName -> Object -> m a) -> Object -> m a
1624−fieldTagged f o = case HM.toList o of
1625− [(k, Object o')] -> f (FieldName k) o'
1626− _ -> fail "Expected object with 1 field-named key"
1627−
1628−-- | Fuzziness value as a number or 'AUTO'.
1629−-- See:
1630−-- https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness
1631−data Fuzziness = Fuzziness Double | FuzzinessAuto
1632− deriving (Eq, Show)
1633−
1634−instance ToJSON Fuzziness where
1635− toJSON (Fuzziness n) = toJSON n
1636− toJSON FuzzinessAuto = String "AUTO"
1637−
1638−instance FromJSON Fuzziness where
1639− parseJSON (String "AUTO") = return FuzzinessAuto
1640− parseJSON v = Fuzziness <$> parseJSON v
src/Database/Bloodhound/Internal/Sort.hsdeleted−107
@@ -1,107 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
4−
5−module Database.Bloodhound.Internal.Sort where
6−
7−import Bloodhound.Import
8−
9−import Database.Bloodhound.Internal.Newtypes
10−import Database.Bloodhound.Internal.Query
11−
12−{-| 'SortMode' prescribes how to handle sorting array/multi-valued fields.
13−
14−http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#_sort_mode_option
15−-}
16−data SortMode = SortMin
17− | SortMax
18− | SortSum
19− | SortAvg deriving (Eq, Show)
20−
21−instance ToJSON SortMode where
22− toJSON SortMin = String "min"
23− toJSON SortMax = String "max"
24− toJSON SortSum = String "sum"
25− toJSON SortAvg = String "avg"
26−
27−{-| 'mkSort' defaults everything but the 'FieldName' and the 'SortOrder' so
28− that you can concisely describe the usual kind of 'SortSpec's you want.
29−-}
30−mkSort :: FieldName -> SortOrder -> DefaultSort
31−mkSort fieldName sOrder = DefaultSort fieldName sOrder Nothing Nothing Nothing Nothing
32−
33−{-| 'Sort' is a synonym for a list of 'SortSpec's. Sort behavior is order
34− dependent with later sorts acting as tie-breakers for earlier sorts.
35−-}
36−type Sort = [SortSpec]
37−
38−{-| The two main kinds of 'SortSpec' are 'DefaultSortSpec' and
39− 'GeoDistanceSortSpec'. The latter takes a 'SortOrder', 'GeoPoint', and
40− 'DistanceUnit' to express "nearness" to a single geographical point as a
41− sort specification.
42−
43−<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort>
44−-}
45−data SortSpec =
46− DefaultSortSpec DefaultSort
47− | GeoDistanceSortSpec SortOrder GeoPoint DistanceUnit
48− deriving (Eq, Show)
49−
50−instance ToJSON SortSpec where
51− toJSON (DefaultSortSpec
52− (DefaultSort (FieldName dsSortFieldName) dsSortOrder dsIgnoreUnmapped
53− dsSortMode dsMissingSort dsNestedFilter)) =
54− object [dsSortFieldName .= omitNulls base] where
55− base = [ "order" .= dsSortOrder
56− , "unmapped_type" .= dsIgnoreUnmapped
57− , "mode" .= dsSortMode
58− , "missing" .= dsMissingSort
59− , "nested_filter" .= dsNestedFilter ]
60−
61− toJSON (GeoDistanceSortSpec gdsSortOrder (GeoPoint (FieldName field) gdsLatLon) units) =
62− object [ "unit" .= units
63− , field .= gdsLatLon
64− , "order" .= gdsSortOrder ]
65−
66−{-| 'DefaultSort' is usually the kind of 'SortSpec' you'll want. There's a
67− 'mkSort' convenience function for when you want to specify only the most
68− common parameters.
69−
70− The `ignoreUnmapped`, when `Just` field is used to set the elastic 'unmapped_type'
71−
72−<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort>
73−-}
74−data DefaultSort =
75− DefaultSort { sortFieldName :: FieldName
76− , sortOrder :: SortOrder
77− -- default False
78− , ignoreUnmapped :: Maybe Text
79− , sortMode :: Maybe SortMode
80− , missingSort :: Maybe Missing
81− , nestedFilter :: Maybe Filter } deriving (Eq, Show)
82−
83−{-| 'SortOrder' is 'Ascending' or 'Descending', as you might expect. These get
84− encoded into "asc" or "desc" when turned into JSON.
85−
86−<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort>
87−-}
88−data SortOrder = Ascending
89− | Descending deriving (Eq, Show)
90−
91−instance ToJSON SortOrder where
92− toJSON Ascending = String "asc"
93− toJSON Descending = String "desc"
94−
95−{-| 'Missing' prescribes how to handle missing fields. A missing field can be
96− sorted last, first, or using a custom value as a substitute.
97−
98−<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#_missing_values>
99−-}
100−data Missing = LastMissing
101− | FirstMissing
102− | CustomMissing Text deriving (Eq, Show)
103−
104−instance ToJSON Missing where
105− toJSON LastMissing = String "_last"
106− toJSON FirstMissing = String "_first"
107− toJSON (CustomMissing txt) = String txt
src/Database/Bloodhound/Internal/StringlyTyped.hsdeleted−51
@@ -1,51 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Database.Bloodhound.Internal.StringlyTyped where
4−
5−import Bloodhound.Import
6−
7−import qualified Data.Text as T
8−
9−
10−-- This whole module is a sin bucket to deal with Elasticsearch badness.
11−newtype StringlyTypedDouble = StringlyTypedDouble
12− { unStringlyTypedDouble :: Double }
13−
14−instance FromJSON StringlyTypedDouble where
15− parseJSON =
16− fmap StringlyTypedDouble
17− . parseJSON
18− . unStringlyTypeJSON
19−
20−newtype StringlyTypedInt = StringlyTypedInt
21− { unStringlyTypedInt :: Int }
22−
23−instance FromJSON StringlyTypedInt where
24− parseJSON =
25− fmap StringlyTypedInt
26− . parseJSON
27− . unStringlyTypeJSON
28−
29−newtype StringlyTypedBool = StringlyTypedBool { unStringlyTypedBool :: Bool }
30−
31−instance FromJSON StringlyTypedBool where
32− parseJSON =
33− fmap StringlyTypedBool
34− . parseJSON
35− . unStringlyTypeJSON
36−
37−-- | For some reason in several settings APIs, all leaf values get returned
38−-- as strings. This function attempts to recover from this for all
39−-- non-recursive JSON types. If nothing can be done, the value is left alone.
40−unStringlyTypeJSON :: Value -> Value
41−unStringlyTypeJSON (String "true") =
42− Bool True
43−unStringlyTypeJSON (String "false") =
44− Bool False
45−unStringlyTypeJSON (String "null") =
46− Null
47−unStringlyTypeJSON v@(String t) =
48− case readMay (T.unpack t) of
49− Just n -> Number n
50− Nothing -> v
51−unStringlyTypeJSON v = v
src/Database/Bloodhound/Internal/Suggest.hsdeleted−270
@@ -1,270 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE RecordWildCards #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−
5−module Database.Bloodhound.Internal.Suggest where
6−
7−import Bloodhound.Import
8−
9−import qualified Data.HashMap.Strict as HM
10−
11−import Database.Bloodhound.Internal.Newtypes
12−import Database.Bloodhound.Internal.Query (TemplateQueryInline(..), params)
13−
14−data Suggest = Suggest
15− { suggestText :: Text
16− , suggestName :: Text
17− , suggestType :: SuggestType
18− } deriving (Eq, Show)
19−
20−instance ToJSON Suggest where
21− toJSON Suggest{..} =
22− object [ "text" .= suggestText
23− , suggestName .= suggestType
24− ]
25−
26−instance FromJSON Suggest where
27− parseJSON (Object o) = do
28− suggestText' <- o .: "text"
29− let dropTextList =
30− HM.toList
31− $ HM.filterWithKey (\x _ -> x /= "text") o
32− suggestName' <-
33− case dropTextList of
34− [(x, _)] -> return x
35− _ -> fail "error parsing Suggest field name"
36− suggestType' <- o .: suggestName'
37− return $ Suggest suggestText' suggestName' suggestType'
38− parseJSON x = typeMismatch "Suggest" x
39−
40−data SuggestType =
41− SuggestTypePhraseSuggester PhraseSuggester
42− deriving (Eq, Show)
43−
44−instance ToJSON SuggestType where
45− toJSON (SuggestTypePhraseSuggester x) =
46− object [ "phrase" .= x ]
47−
48−instance FromJSON SuggestType where
49− parseJSON = withObject "SuggestType" parse
50− where parse o = phraseSuggester `taggedWith` "phrase"
51− where taggedWith parser k = parser =<< o .: k
52− phraseSuggester = pure . SuggestTypePhraseSuggester
53−
54−data PhraseSuggester = PhraseSuggester
55− { phraseSuggesterField :: FieldName
56− , phraseSuggesterGramSize :: Maybe Int
57− , phraseSuggesterRealWordErrorLikelihood :: Maybe Int
58− , phraseSuggesterConfidence :: Maybe Int
59− , phraseSuggesterMaxErrors :: Maybe Int
60− , phraseSuggesterSeparator :: Maybe Text
61− , phraseSuggesterSize :: Maybe Size
62− , phraseSuggesterAnalyzer :: Maybe Analyzer
63− , phraseSuggesterShardSize :: Maybe Int
64− , phraseSuggesterHighlight :: Maybe PhraseSuggesterHighlighter
65− , phraseSuggesterCollate :: Maybe PhraseSuggesterCollate
66− , phraseSuggesterCandidateGenerators :: [DirectGenerators]
67− } deriving (Eq, Show)
68−
69−instance ToJSON PhraseSuggester where
70− toJSON PhraseSuggester{..} =
71− omitNulls [ "field" .= phraseSuggesterField
72− , "gram_size" .= phraseSuggesterGramSize
73− , "real_word_error_likelihood" .=
74− phraseSuggesterRealWordErrorLikelihood
75− , "confidence" .= phraseSuggesterConfidence
76− , "max_errors" .= phraseSuggesterMaxErrors
77− , "separator" .= phraseSuggesterSeparator
78− , "size" .= phraseSuggesterSize
79− , "analyzer" .= phraseSuggesterAnalyzer
80− , "shard_size" .= phraseSuggesterShardSize
81− , "highlight" .= phraseSuggesterHighlight
82− , "collate" .= phraseSuggesterCollate
83− , "direct_generator" .=
84− phraseSuggesterCandidateGenerators
85− ]
86−
87−instance FromJSON PhraseSuggester where
88− parseJSON = withObject "PhraseSuggester" parse
89− where parse o = PhraseSuggester
90− <$> o .: "field"
91− <*> o .:? "gram_size"
92− <*> o .:? "real_word_error_likelihood"
93− <*> o .:? "confidence"
94− <*> o .:? "max_errors"
95− <*> o .:? "separator"
96− <*> o .:? "size"
97− <*> o .:? "analyzer"
98− <*> o .:? "shard_size"
99− <*> o .:? "highlight"
100− <*> o .:? "collate"
101− <*> o .:? "direct_generator" .!= []
102−
103−mkPhraseSuggester :: FieldName -> PhraseSuggester
104−mkPhraseSuggester fName =
105− PhraseSuggester fName Nothing Nothing Nothing Nothing Nothing Nothing
106− Nothing Nothing Nothing Nothing []
107−
108−data PhraseSuggesterHighlighter =
109− PhraseSuggesterHighlighter { phraseSuggesterHighlighterPreTag :: Text
110− , phraseSuggesterHighlighterPostTag :: Text
111− }
112− deriving (Eq, Show)
113−
114−instance ToJSON PhraseSuggesterHighlighter where
115− toJSON PhraseSuggesterHighlighter{..} =
116− object [ "pre_tag" .= phraseSuggesterHighlighterPreTag
117− , "post_tag" .= phraseSuggesterHighlighterPostTag
118− ]
119−
120−instance FromJSON PhraseSuggesterHighlighter where
121− parseJSON = withObject "PhraseSuggesterHighlighter" parse
122− where parse o = PhraseSuggesterHighlighter
123− <$> o .: "pre_tag"
124− <*> o .: "post_tag"
125−
126−data PhraseSuggesterCollate = PhraseSuggesterCollate
127− { phraseSuggesterCollateTemplateQuery :: TemplateQueryInline
128− , phraseSuggesterCollatePrune :: Bool
129− } deriving (Eq, Show)
130−
131−instance ToJSON PhraseSuggesterCollate where
132− toJSON PhraseSuggesterCollate{..} =
133− object [ "query" .= object
134− [ "inline" .= (inline phraseSuggesterCollateTemplateQuery)
135− ]
136− , "params" .= (params phraseSuggesterCollateTemplateQuery)
137− , "prune" .= phraseSuggesterCollatePrune
138− ]
139−
140−instance FromJSON PhraseSuggesterCollate where
141− parseJSON (Object o) = do
142− query' <- o .: "query"
143− inline' <- query' .: "inline"
144− params' <- o .: "params"
145− prune' <- o .:? "prune" .!= False
146− return $ PhraseSuggesterCollate
147− (TemplateQueryInline inline' params') prune'
148− parseJSON x = typeMismatch "PhraseSuggesterCollate" x
149−
150−data SuggestOptions =
151− SuggestOptions { suggestOptionsText :: Text
152− , suggestOptionsScore :: Double
153− , suggestOptionsFreq :: Maybe Int
154− , suggestOptionsHighlighted :: Maybe Text
155− }
156− deriving (Eq, Read, Show)
157−
158−instance FromJSON SuggestOptions where
159− parseJSON = withObject "SuggestOptions" parse
160− where
161− parse o = SuggestOptions
162− <$> o .: "text"
163− <*> o .: "score"
164− <*> o .:? "freq"
165− <*> o .:? "highlighted"
166−
167−data SuggestResponse =
168− SuggestResponse { suggestResponseText :: Text
169− , suggestResponseOffset :: Int
170− , suggestResponseLength :: Int
171− , suggestResponseOptions :: [SuggestOptions]
172− }
173− deriving (Eq, Read, Show)
174−
175−instance FromJSON SuggestResponse where
176− parseJSON = withObject "SuggestResponse" parse
177− where parse o = SuggestResponse
178− <$> o .: "text"
179− <*> o .: "offset"
180− <*> o .: "length"
181− <*> o .: "options"
182−
183−data NamedSuggestionResponse = NamedSuggestionResponse
184− { nsrName :: Text
185− , nsrResponses :: [SuggestResponse]
186− } deriving (Eq, Read, Show)
187−
188−instance FromJSON NamedSuggestionResponse where
189− parseJSON (Object o) = do
190− suggestionName' <- case HM.toList o of
191− [(x, _)] -> return x
192− _ -> fail "error parsing NamedSuggestionResponse name"
193− suggestionResponses' <- o .: suggestionName'
194− return $ NamedSuggestionResponse suggestionName' suggestionResponses'
195−
196− parseJSON x = typeMismatch "NamedSuggestionResponse" x
197−
198−data DirectGeneratorSuggestModeTypes = DirectGeneratorSuggestModeMissing
199− | DirectGeneratorSuggestModePopular
200− | DirectGeneratorSuggestModeAlways
201− deriving (Eq, Show)
202−
203−instance ToJSON DirectGeneratorSuggestModeTypes where
204− toJSON DirectGeneratorSuggestModeMissing = "missing"
205− toJSON DirectGeneratorSuggestModePopular = "popular"
206− toJSON DirectGeneratorSuggestModeAlways = "always"
207−
208−instance FromJSON DirectGeneratorSuggestModeTypes where
209− parseJSON = withText "DirectGeneratorSuggestModeTypes" parse
210− where
211− parse "missing" =
212− pure DirectGeneratorSuggestModeMissing
213− parse "popular" =
214− pure DirectGeneratorSuggestModePopular
215− parse "always" =
216− pure DirectGeneratorSuggestModeAlways
217− parse f =
218− fail ("Unexpected DirectGeneratorSuggestModeTypes: " <> show f)
219−
220−data DirectGenerators = DirectGenerators
221− { directGeneratorsField :: FieldName
222− , directGeneratorsSize :: Maybe Int
223− , directGeneratorSuggestMode :: DirectGeneratorSuggestModeTypes
224− , directGeneratorMaxEdits :: Maybe Double
225− , directGeneratorPrefixLength :: Maybe Int
226− , directGeneratorMinWordLength :: Maybe Int
227− , directGeneratorMaxInspections :: Maybe Int
228− , directGeneratorMinDocFreq :: Maybe Double
229− , directGeneratorMaxTermFreq :: Maybe Double
230− , directGeneratorPreFilter :: Maybe Text
231− , directGeneratorPostFilter :: Maybe Text
232− } deriving (Eq, Show)
233−
234−instance ToJSON DirectGenerators where
235− toJSON DirectGenerators{..} =
236− omitNulls [ "field" .= directGeneratorsField
237− , "size" .= directGeneratorsSize
238− , "suggest_mode" .= directGeneratorSuggestMode
239− , "max_edits" .= directGeneratorMaxEdits
240− , "prefix_length" .= directGeneratorPrefixLength
241− , "min_word_length" .= directGeneratorMinWordLength
242− , "max_inspections" .= directGeneratorMaxInspections
243− , "min_doc_freq" .= directGeneratorMinDocFreq
244− , "max_term_freq" .= directGeneratorMaxTermFreq
245− , "pre_filter" .= directGeneratorPreFilter
246− , "post_filter" .= directGeneratorPostFilter
247− ]
248−
249−instance FromJSON DirectGenerators where
250− parseJSON = withObject "DirectGenerators" parse
251− where parse o = DirectGenerators
252− <$> o .: "field"
253− <*> o .:? "size"
254− <*> o .: "suggest_mode"
255− <*> o .:? "max_edits"
256− <*> o .:? "prefix_length"
257− <*> o .:? "min_word_length"
258− <*> o .:? "max_inspections"
259− <*> o .:? "min_doc_freq"
260− <*> o .:? "max_term_freq"
261− <*> o .:? "pre_filter"
262− <*> o .:? "post_filter"
263−
264−mkDirectGenerators :: FieldName -> DirectGenerators
265−mkDirectGenerators fn =
266− DirectGenerators
267− fn
268− Nothing
269− DirectGeneratorSuggestModeMissing
270− Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing
src/Database/Bloodhound/Types.hs+3306−232
@@ -1,20 +1,23 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE DeriveGeneric #-}
13{-# LANGUAGE FlexibleContexts #-}
24{-# LANGUAGE FlexibleInstances #-}
35{-# LANGUAGE GeneralizedNewtypeDeriving #-}
46{-# LANGUAGE MultiParamTypeClasses #-}
5−{-# LANGUAGE NamedFieldPuns #-}
7+-- {-# LANGUAGE NoMonomorphismRestriction #-}
68{-# LANGUAGE OverloadedStrings #-}
79{-# LANGUAGE RecordWildCards #-}
810{-# LANGUAGE UndecidableInstances #-}
11+{-# LANGUAGE NamedFieldPuns #-}
912
1013-------------------------------------------------------------------------------
1114-- |
1215-- Module : Database.Bloodhound.Types
13−-- Copyright : (C) 2014, 2018 Chris Allen
16+-- Copyright : (C) 2014, 2015, 2016 Chris Allen
1417-- License : BSD-style (see the file LICENSE)
1518-- Maintainer : Chris Allen <cma@bitemyapp.com
1619-- Stability : provisional
17−-- Portability : RecordWildCards
20+-- Portability : DeriveGeneric, RecordWildCards
1821--
1922-- Data types for describing actions and data structures performed to interact
2023-- with Elasticsearch. The two main buckets your queries against Elasticsearch
@@ -42,15 +45,11 @@ module Database.Bloodhound.Types
4245 , mkTermsAggregation
4346 , mkTermsScriptAggregation
4447 , mkDateHistogram
45− , mkCardinalityAggregation
4648 , mkDocVersion
47− , mkStatsAggregation
48− , mkExtendedStatsAggregation
4949 , docVersionNumber
5050 , toMissing
5151 , toTerms
5252 , toDateHistogram
53− , toTopHits
5453 , omitNulls
5554 , BH(..)
5655 , runBH
@@ -61,9 +60,6 @@ module Database.Bloodhound.Types
6160 , mkBHEnv
6261 , MonadBH(..)
6362 , Version(..)
64− , VersionNumber(..)
65− , MaybeNA(..)
66− , BuildHash(..)
6763 , Status(..)
6864 , Existence(..)
6965 , NullValue(..)
@@ -71,12 +67,8 @@ module Database.Bloodhound.Types
7167 , UpdatableIndexSetting(..)
7268 , IndexSettingsSummary(..)
7369 , AllocationPolicy(..)
74− , Compression(..)
7570 , ReplicaBounds(..)
7671 , Bytes(..)
77− , gigabytes
78− , megabytes
79− , kilobytes
8072 , FSType(..)
8173 , InitialShardCount(..)
8274 , NodeAttrFilter(..)
@@ -120,8 +112,8 @@ module Database.Bloodhound.Types
120112 , Pattern(..)
121113 , ShardResult(..)
122114 , Hit(..)
123− , HitFields(..)
124115 , Filter(..)
116+ , Seminearring(..)
125117 , BoolMatch(..)
126118 , Term(..)
127119 , GeoPoint(..)
@@ -148,22 +140,11 @@ module Database.Bloodhound.Types
148140 , RegexpFlags(..)
149141 , RegexpFlag(..)
150142 , FieldName(..)
151− , ScriptFields(..)
152− , ScriptFieldName
153− , ScriptFieldValue
154143 , Script(..)
155− , ScriptLanguage(..)
156− , ScriptInline(..)
157− , ScriptId(..)
158− , ScriptParams(..)
159− , ScriptParamName
160− , ScriptParamValue
161144 , IndexName(..)
162145 , IndexSelection(..)
163− , NodeSelection(..)
164− , NodeSelector(..)
165− , ForceMergeIndexSettings(..)
166− , defaultForceMergeIndexSettings
146+ , IndexOptimizationSettings(..)
147+ , defaultIndexOptimizationSettings
167148 , TemplateName(..)
168149 , TemplatePattern(..)
169150 , MappingName(..)
@@ -187,19 +168,8 @@ module Database.Bloodhound.Types
187168 , BoolQuery(..)
188169 , BoostingQuery(..)
189170 , CommonTermsQuery(..)
190− , FunctionScoreQuery(..)
191− , BoostMode(..)
192− , ScoreMode(..)
193− , FunctionScoreFunctions(..)
194− , ComponentFunctionScoreFunction(..)
195− , FunctionScoreFunction(..)
196− , Weight(..)
197− , Seed(..)
198− , FieldValueFactor(..)
199− , Factor(..)
200− , FactorModifier(..)
201− , FactorMissingFieldValue(..)
202171 , DisMaxQuery(..)
172+ , FilteredQuery(..)
203173 , FuzzyLikeThisQuery(..)
204174 , FuzzyLikeFieldQuery(..)
205175 , FuzzyQuery(..)
@@ -215,16 +185,10 @@ module Database.Bloodhound.Types
215185 , RangeQuery(..)
216186 , RegexpQuery(..)
217187 , QueryString(..)
218− , TemplateQueryInline(..)
219− , TemplateQueryKeyValuePairs(..)
220− , WildcardQuery(..)
221188 , BooleanOperator(..)
222189 , ZeroTermsQuery(..)
223190 , CutoffFrequency(..)
224191 , Analyzer(..)
225− , Tokenizer(..)
226− , TokenFilter(..)
227− , CharFilter(..)
228192 , MaxExpansions(..)
229193 , Lenient(..)
230194 , MatchQueryType(..)
@@ -271,95 +235,6 @@ module Database.Bloodhound.Types
271235 , CollectionMode(..)
272236 , TermOrder(..)
273237 , TermInclusion(..)
274− , SnapshotRepoSelection(..)
275− , GenericSnapshotRepo(..)
276− , SnapshotRepo(..)
277− , SnapshotRepoConversionError(..)
278− , SnapshotRepoType(..)
279− , GenericSnapshotRepoSettings(..)
280− , SnapshotRepoUpdateSettings(..)
281− , defaultSnapshotRepoUpdateSettings
282− , SnapshotRepoName(..)
283− , SnapshotRepoPattern(..)
284− , SnapshotVerification(..)
285− , SnapshotNodeVerification(..)
286− , FullNodeId(..)
287− , NodeName(..)
288− , ClusterName(..)
289− , NodesInfo(..)
290− , NodesStats(..)
291− , NodeStats(..)
292− , NodeBreakersStats(..)
293− , NodeBreakerStats(..)
294− , NodeHTTPStats(..)
295− , NodeTransportStats(..)
296− , NodeFSStats(..)
297− , NodeDataPathStats(..)
298− , NodeFSTotalStats(..)
299− , NodeNetworkStats(..)
300− , NodeThreadPoolsStats(..)
301− , NodeThreadPoolStats(..)
302− , NodeJVMStats(..)
303− , JVMBufferPoolStats(..)
304− , JVMGCStats(..)
305− , JVMPoolStats(..)
306− , NodeProcessStats(..)
307− , NodeOSStats(..)
308− , LoadAvgs(..)
309− , NodeIndicesStats(..)
310− , EsAddress(..)
311− , PluginName(..)
312− , NodeInfo(..)
313− , NodePluginInfo(..)
314− , NodeHTTPInfo(..)
315− , NodeTransportInfo(..)
316− , BoundTransportAddress(..)
317− , NodeNetworkInfo(..)
318− , MacAddress(..)
319− , NetworkInterfaceName(..)
320− , NodeNetworkInterface(..)
321− , NodeThreadPoolsInfo(..)
322− , NodeThreadPoolInfo(..)
323− , ThreadPoolSize(..)
324− , ThreadPoolType(..)
325− , NodeJVMInfo(..)
326− , JVMMemoryPool(..)
327− , JVMGCCollector(..)
328− , JVMMemoryInfo(..)
329− , PID(..)
330− , NodeOSInfo(..)
331− , CPUInfo(..)
332− , NodeProcessInfo(..)
333− , FsSnapshotRepo(..)
334− , SnapshotCreateSettings(..)
335− , defaultSnapshotCreateSettings
336− , SnapshotSelection(..)
337− , SnapshotPattern(..)
338− , SnapshotInfo(..)
339− , SnapshotShardFailure(..)
340− , ShardId(..)
341− , SnapshotName(..)
342− , SnapshotState(..)
343− , SnapshotRestoreSettings(..)
344− , defaultSnapshotRestoreSettings
345− , RestoreRenamePattern(..)
346− , RestoreRenameToken(..)
347− , RRGroupRefNum
348− , rrGroupRefNum
349− , mkRRGroupRefNum
350− , RestoreIndexSettings(..)
351− , Suggest(..)
352− , SuggestType(..)
353− , PhraseSuggester(..)
354− , PhraseSuggesterHighlighter(..)
355− , PhraseSuggesterCollate(..)
356− , mkPhraseSuggester
357− , SuggestOptions(..)
358− , SuggestResponse(..)
359− , NamedSuggestionResponse(..)
360− , DirectGenerators(..)
361− , mkDirectGenerators
362− , DirectGeneratorSuggestModeTypes (..)
363238
364239 , Aggregation(..)
365240 , Aggregations
@@ -371,8 +246,6 @@ module Database.Bloodhound.Types
371246 , MissingAggregation(..)
372247 , ValueCountAggregation(..)
373248 , FilterAggregation(..)
374− , CardinalityAggregation(..)
375− , MaxAggregation(..)
376249 , DateHistogramAggregation(..)
377250 , DateRangeAggregation(..)
378251 , DateRangeAggRange(..)
@@ -380,9 +253,6 @@ module Database.Bloodhound.Types
380253 , DateMathAnchor(..)
381254 , DateMathModifier(..)
382255 , DateMathUnit(..)
383− , TopHitsAggregation(..)
384− , StatisticsAggregation(..)
385− , SearchAfterKey
386256
387257 , Highlights(..)
388258 , FieldHighlight(..)
@@ -400,32 +270,673 @@ module Database.Bloodhound.Types
400270 , TermsResult(..)
401271 , DateHistogramResult(..)
402272 , DateRangeResult(..)
403− , TopHitResult(..)
404273
405274 , EsUsername(..)
406275 , EsPassword(..)
276+ ) where
277+
278+import Control.Applicative
279+import Control.Monad.Catch
280+import Control.Monad.Except
281+import Control.Monad.Reader
282+import Control.Monad.State
283+import Control.Monad.Writer
284+import Data.Aeson
285+import Data.Aeson.Types (Pair, Parser, emptyObject,
286+ parseMaybe)
287+import qualified Data.ByteString.Lazy.Char8 as L
288+import Data.Char
289+import Data.Hashable (Hashable)
290+import qualified Data.HashMap.Strict as HM
291+import Data.List (foldl', nub)
292+import Data.List.NonEmpty (NonEmpty (..), toList)
293+import qualified Data.Map.Strict as M
294+import Data.Maybe
295+import Data.Scientific (Scientific)
296+import Data.Text (Text)
297+import qualified Data.Text as T
298+import Data.Time.Calendar
299+import Data.Time.Clock (NominalDiffTime, UTCTime)
300+import Data.Time.Clock.POSIX
301+import qualified Data.Traversable as DT
302+import Data.Typeable (Typeable)
303+import qualified Data.Vector as V
304+import GHC.Enum
305+import GHC.Generics (Generic)
306+import Network.HTTP.Client
307+import qualified Network.HTTP.Types.Method as NHTM
308+
309+import Database.Bloodhound.Types.Class
310+import Database.Bloodhound.Types.Internal
311+
312+-- $setup
313+-- >>> :set -XOverloadedStrings
314+-- >>> import Data.Aeson
315+-- >>> import Database.Bloodhound
316+-- >>> let testServer = (Server "http://localhost:9200")
317+-- >>> let testIndex = IndexName "twitter"
318+-- >>> let testMapping = MappingName "tweet"
319+-- >>> let defaultIndexSettings = IndexSettings (ShardCount 3) (ReplicaCount 2)
320+
321+-- defaultIndexSettings is exported by Database.Bloodhound as well
322+-- no trailing slashes in servers, library handles building the path.
323+
324+-- | Create a 'BHEnv' with all optional fields defaulted. HTTP hook
325+-- will be a noop. You can use the exported fields to customize it further, e.g.:
326+--
327+-- >> (mkBHEnv myServer myManager) { bhRequestHook = customHook }
328+mkBHEnv :: Server -> Manager -> BHEnv
329+mkBHEnv s m = BHEnv s m return
330+
331+newtype BH m a = BH {
332+ unBH :: ReaderT BHEnv m a
333+ } deriving ( Functor
334+ , Applicative
335+ , Monad
336+ , MonadIO
337+ , MonadState s
338+ , MonadWriter w
339+ , MonadError e
340+ , Alternative
341+ , MonadPlus
342+ , MonadFix
343+ , MonadThrow
344+ , MonadCatch
345+ , MonadMask)
346+
347+instance MonadTrans BH where
348+ lift = BH . lift
349+
350+instance (MonadReader r m) => MonadReader r (BH m) where
351+ ask = lift ask
352+ local f (BH (ReaderT m)) = BH $ ReaderT $ \r ->
353+ local f (m r)
354+
355+instance (Functor m, Applicative m, MonadIO m) => MonadBH (BH m) where
356+ getBHEnv = BH getBHEnv
357+
358+runBH :: BHEnv -> BH m a -> m a
359+runBH e f = runReaderT (unBH f) e
360+
361+{-| 'Version' is embedded in 'Status' -}
362+data Version = Version { number :: Text
363+ , build_hash :: Text
364+ , build_timestamp :: UTCTime
365+ , build_snapshot :: Bool
366+ , lucene_version :: Text } deriving (Eq, Show, Generic, Typeable)
367+
368+{-| 'Status' is a data type for describing the JSON body returned by
369+ Elasticsearch when you query its status. This was deprecated in 1.2.0.
370+
371+ <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-status.html#indices-status>
372+-}
373+
374+data Status = Status { ok :: Maybe Bool
375+ , status :: Int
376+ , name :: Text
377+ , version :: Version
378+ , tagline :: Text } deriving (Eq, Show, Generic)
379+
380+{-| 'IndexSettings' is used to configure the shards and replicas when you create
381+ an Elasticsearch Index.
382+
383+ <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html>
384+-}
385+
386+data IndexSettings =
387+ IndexSettings { indexShards :: ShardCount
388+ , indexReplicas :: ReplicaCount } deriving (Eq, Show, Generic, Typeable)
389+
390+{-| 'defaultIndexSettings' is an 'IndexSettings' with 3 shards and 2 replicas. -}
391+defaultIndexSettings :: IndexSettings
392+defaultIndexSettings = IndexSettings (ShardCount 3) (ReplicaCount 2)
393+
394+
395+{-| 'IndexOptimizationSettings' is used to configure index optimization. See
396+ <https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-optimize.html>
397+ for more info.
398+-}
399+data IndexOptimizationSettings =
400+ IndexOptimizationSettings { maxNumSegments :: Maybe Int
401+ -- ^ Number of segments to optimize to. 1 will fully optimize the index. If omitted, the default behavior is to only optimize if the server deems it necessary.
402+ , onlyExpungeDeletes :: Bool
403+ -- ^ Should the optimize process only expunge segments with deletes in them? If the purpose of the optimization is to free disk space, this should be set to True.
404+ , flushAfterOptimize :: Bool
405+ -- ^ Should a flush be performed after the optimize.
406+ } deriving (Eq, Show, Generic, Typeable)
407+
408+
409+{-| 'defaultIndexOptimizationSettings' implements the default settings that
410+ ElasticSearch uses for index optimization. 'maxNumSegments' is Nothing,
411+ 'onlyExpungeDeletes' is False, and flushAfterOptimize is True.
412+-}
413+defaultIndexOptimizationSettings :: IndexOptimizationSettings
414+defaultIndexOptimizationSettings = IndexOptimizationSettings Nothing False True
415+
416+{-| 'UpdatableIndexSetting' are settings which may be updated after an index is created.
417+
418+ <https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html>
419+-}
420+data UpdatableIndexSetting = NumberOfReplicas ReplicaCount
421+ -- ^ The number of replicas each shard has.
422+ | AutoExpandReplicas ReplicaBounds
423+ | BlocksReadOnly Bool
424+ -- ^ Set to True to have the index read only. False to allow writes and metadata changes.
425+ | BlocksRead Bool
426+ -- ^ Set to True to disable read operations against the index.
427+ | BlocksWrite Bool
428+ -- ^ Set to True to disable write operations against the index.
429+ | BlocksMetaData Bool
430+ -- ^ Set to True to disable metadata operations against the index.
431+ | RefreshInterval NominalDiffTime
432+ -- ^ The async refresh interval of a shard
433+ | IndexConcurrency Int
434+ | FailOnMergeFailure Bool
435+ | TranslogFlushThresholdOps Int
436+ -- ^ When to flush on operations.
437+ | TranslogFlushThresholdSize Bytes
438+ -- ^ When to flush based on translog (bytes) size.
439+ | TranslogFlushThresholdPeriod NominalDiffTime
440+ -- ^ When to flush based on a period of not flushing.
441+ | TranslogDisableFlush Bool
442+ -- ^ Disables flushing. Note, should be set for a short interval and then enabled.
443+ | CacheFilterMaxSize (Maybe Bytes)
444+ -- ^ The maximum size of filter cache (per segment in shard).
445+ | CacheFilterExpire (Maybe NominalDiffTime)
446+ -- ^ The expire after access time for filter cache.
447+ | GatewaySnapshotInterval NominalDiffTime
448+ -- ^ The gateway snapshot interval (only applies to shared gateways).
449+ | RoutingAllocationInclude (NonEmpty NodeAttrFilter)
450+ -- ^ A node matching any rule will be allowed to host shards from the index.
451+ | RoutingAllocationExclude (NonEmpty NodeAttrFilter)
452+ -- ^ A node matching any rule will NOT be allowed to host shards from the index.
453+ | RoutingAllocationRequire (NonEmpty NodeAttrFilter)
454+ -- ^ Only nodes matching all rules will be allowed to host shards from the index.
455+ | RoutingAllocationEnable AllocationPolicy
456+ -- ^ Enables shard allocation for a specific index.
457+ | RoutingAllocationShardsPerNode ShardCount
458+ -- ^ Controls the total number of shards (replicas and primaries) allowed to be allocated on a single node.
459+ | RecoveryInitialShards InitialShardCount
460+ -- ^ When using local gateway a particular shard is recovered only if there can be allocated quorum shards in the cluster.
461+ | GCDeletes NominalDiffTime
462+ | TTLDisablePurge Bool
463+ -- ^ Disables temporarily the purge of expired docs.
464+ | TranslogFSType FSType
465+ | IndexCompoundFormat CompoundFormat
466+ | IndexCompoundOnFlush Bool
467+ | WarmerEnabled Bool
468+ deriving (Eq, Show, Generic, Typeable)
469+
470+data AllocationPolicy = AllocAll
471+ -- ^ Allows shard allocation for all shards.
472+ | AllocPrimaries
473+ -- ^ Allows shard allocation only for primary shards.
474+ | AllocNewPrimaries
475+ -- ^ Allows shard allocation only for primary shards for new indices.
476+ | AllocNone
477+ -- ^ No shard allocation is allowed
478+ deriving (Eq, Show, Generic, Typeable)
479+
480+data ReplicaBounds = ReplicasBounded Int Int
481+ | ReplicasLowerBounded Int
482+ | ReplicasUnbounded
483+ deriving (Eq, Show, Generic, Typeable)
484+
485+newtype Bytes = Bytes Int deriving (Eq, Show, Generic, Typeable, Ord, ToJSON, FromJSON)
486+
487+data FSType = FSSimple
488+ | FSBuffered deriving (Eq, Show, Generic, Typeable, Ord)
489+
490+data InitialShardCount = QuorumShards
491+ | QuorumMinus1Shards
492+ | FullShards
493+ | FullMinus1Shards
494+ | ExplicitShards Int
495+ deriving (Eq, Show, Generic, Typeable)
496+
497+data NodeAttrFilter = NodeAttrFilter { nodeAttrFilterName :: NodeAttrName
498+ , nodeAttrFilterValues :: NonEmpty Text}
499+ deriving (Eq, Show, Generic, Ord)
500+
501+newtype NodeAttrName = NodeAttrName Text deriving (Eq, Show, Ord, Generic, Typeable)
502+
503+data CompoundFormat = CompoundFileFormat Bool
504+ | MergeSegmentVsTotalIndex Double
505+ -- ^ percentage between 0 and 1 where 0 is false, 1 is true
506+ deriving (Eq, Show, Generic, Typeable)
507+
508+newtype NominalDiffTimeJSON = NominalDiffTimeJSON { ndtJSON :: NominalDiffTime }
509+
510+data IndexSettingsSummary = IndexSettingsSummary { sSummaryIndexName :: IndexName
511+ , sSummaryFixedSettings :: IndexSettings
512+ , sSummaryUpdateable :: [UpdatableIndexSetting]}
513+ deriving (Eq, Show, Generic, Typeable)
514+
515+{-| 'Reply' and 'Method' are type synonyms from 'Network.HTTP.Types.Method.Method' -}
516+type Reply = Network.HTTP.Client.Response L.ByteString
517+type Method = NHTM.Method
518+
519+{-| 'OpenCloseIndex' is a sum type for opening and closing indices.
520+
521+ <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html>
522+-}
523+data OpenCloseIndex = OpenIndex | CloseIndex deriving (Eq, Show, Generic, Typeable)
524+
525+data FieldType = GeoPointType
526+ | GeoShapeType
527+ | FloatType
528+ | IntegerType
529+ | LongType
530+ | ShortType
531+ | ByteType deriving (Eq, Show, Generic, Typeable)
532+
533+data FieldDefinition =
534+ FieldDefinition { fieldType :: FieldType } deriving (Eq, Show, Generic, Typeable)
535+
536+{-| An 'IndexTemplate' defines a template that will automatically be
537+ applied to new indices created. The templates include both
538+ 'IndexSettings' and mappings, and a simple 'TemplatePattern' that
539+ controls if the template will be applied to the index created.
540+ Specify mappings as follows: @[toJSON TweetMapping, ...]@
541+
542+ https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-templates.html
543+-}
544+data IndexTemplate =
545+ IndexTemplate { templatePattern :: TemplatePattern
546+ , templateSettings :: Maybe IndexSettings
547+ , templateMappings :: [Value]
548+ }
549+
550+data MappingField =
551+ MappingField { mappingFieldName :: FieldName
552+ , fieldDefinition :: FieldDefinition } deriving (Eq, Show, Generic, Typeable)
553+
554+{-| Support for type reification of 'Mapping's is currently incomplete, for
555+ now the mapping API verbiage expects a 'ToJSON'able blob.
556+
557+ Indexes have mappings, mappings are schemas for the documents contained in the
558+ index. I'd recommend having only one mapping per index, always having a mapping,
559+ and keeping different kinds of documents separated if possible.
560+-}
561+data Mapping = Mapping { typeName :: TypeName
562+ , mappingFields :: [MappingField] } deriving (Eq, Show, Generic, Typeable)
563+
564+{-| 'BulkOperation' is a sum type for expressing the four kinds of bulk
565+ operation index, create, delete, and update. 'BulkIndex' behaves like an
566+ "upsert", 'BulkCreate' will fail if a document already exists at the DocId.
567+
568+ <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html#docs-bulk>
569+-}
570+data BulkOperation =
571+ BulkIndex IndexName MappingName DocId Value
572+ | BulkCreate IndexName MappingName DocId Value
573+ | BulkDelete IndexName MappingName DocId
574+ | BulkUpdate IndexName MappingName DocId Value deriving (Eq, Show, Generic, Typeable)
575+
576+{-| 'EsResult' describes the standard wrapper JSON document that you see in
577+ successful Elasticsearch lookups or lookups that couldn't find the document.
578+-}
579+data EsResult a = EsResult { _index :: Text
580+ , _type :: Text
581+ , _id :: Text
582+ , foundResult :: Maybe (EsResultFound a)} deriving (Eq, Show, Generic, Typeable)
583+
584+{-| 'EsResultFound' contains the document and its metadata inside of an
585+ 'EsResult' when the document was successfully found.
586+-}
587+data EsResultFound a = EsResultFound { _version :: DocVersion
588+ , _source :: a } deriving (Eq, Show, Generic, Typeable)
589+
590+{-| 'EsError' is the generic type that will be returned when there was a
591+ problem. If you can't parse the expected response, its a good idea to
592+ try parsing this.
593+-}
594+data EsError = EsError { errorStatus :: Int
595+ , errorMessage :: Text } deriving (Eq, Show, Generic, Typeable)
596+
597+{-| 'EsProtocolException' will be thrown if Bloodhound cannot parse a response
598+returned by the ElasticSearch server. If you encounter this error, please
599+verify that your domain data types and FromJSON instances are working properly
600+(for example, the 'a' of '[Hit a]' in 'SearchResult.searchHits.hits'). If you're
601+sure that your mappings are correct, then this error may be an indication of an
602+incompatibility between Bloodhound and ElasticSearch. Please open a bug report
603+and be sure to include the exception body.
604+-}
605+data EsProtocolException = EsProtocolException { esProtoExBody :: L.ByteString }
606+ deriving (Eq, Show, Generic, Typeable)
607+
608+instance Exception EsProtocolException
609+
610+data IndexAlias = IndexAlias { srcIndex :: IndexName
611+ , indexAlias :: IndexAliasName } deriving (Eq, Show, Generic, Typeable)
612+
613+newtype IndexAliasName = IndexAliasName { indexAliasName :: IndexName } deriving (Eq, Show, Generic, ToJSON)
614+
615+data IndexAliasAction = AddAlias IndexAlias IndexAliasCreate
616+ | RemoveAlias IndexAlias deriving (Show, Eq, Generic, Typeable)
617+
618+data IndexAliasCreate = IndexAliasCreate { aliasCreateRouting :: Maybe AliasRouting
619+ , aliasCreateFilter :: Maybe Filter}
620+ deriving (Show, Eq, Generic, Typeable)
621+
622+data AliasRouting = AllAliasRouting RoutingValue
623+ | GranularAliasRouting (Maybe SearchAliasRouting) (Maybe IndexAliasRouting)
624+ deriving (Show, Eq, Generic, Typeable)
625+
626+newtype SearchAliasRouting = SearchAliasRouting (NonEmpty RoutingValue) deriving (Show, Eq, Generic, Typeable)
627+
628+newtype IndexAliasRouting = IndexAliasRouting RoutingValue deriving (Show, Eq, Generic, ToJSON, FromJSON, Typeable)
629+
630+newtype RoutingValue = RoutingValue { routingValue :: Text } deriving (Show, Eq, Generic, ToJSON, FromJSON, Typeable)
631+
632+newtype IndexAliasesSummary = IndexAliasesSummary { indexAliasesSummary :: [IndexAliasSummary] } deriving (Show, Eq, Generic, Typeable)
633+
634+{-| 'IndexAliasSummary' is a summary of an index alias configured for a server. -}
635+data IndexAliasSummary = IndexAliasSummary { indexAliasSummaryAlias :: IndexAlias
636+ , indexAliasSummaryCreate :: IndexAliasCreate} deriving (Show, Eq, Generic, Typeable)
637+
638+{-| 'DocVersion' is an integer version number for a document between 1
639+and 9.2e+18 used for <<https://www.elastic.co/guide/en/elasticsearch/guide/current/optimistic-concurrency-control.html optimistic concurrency control>>.
640+-}
641+newtype DocVersion = DocVersion {
642+ docVersionNumber :: Int
643+ } deriving (Eq, Show, Generic, Ord, ToJSON)
644+
645+-- | Smart constructor for in-range doc version
646+mkDocVersion :: Int -> Maybe DocVersion
647+mkDocVersion i
648+ | i >= (docVersionNumber minBound) && i <= (docVersionNumber maxBound) =
649+ Just $ DocVersion i
650+ | otherwise = Nothing
651+
652+
653+{-| 'ExternalDocVersion' is a convenience wrapper if your code uses its
654+own version numbers instead of ones from ES.
655+-}
656+newtype ExternalDocVersion = ExternalDocVersion DocVersion
657+ deriving (Eq, Show, Generic, Ord, Bounded, Enum, ToJSON)
658+
659+{-| 'VersionControl' is specified when indexing documents as a
660+optimistic concurrency control.
661+-}
662+data VersionControl = NoVersionControl
663+ -- ^ Don't send a version. This is a pure overwrite.
664+ | InternalVersion DocVersion
665+ -- ^ Use the default ES versioning scheme. Only
666+ -- index the document if the version is the same
667+ -- as the one specified. Only applicable to
668+ -- updates, as you should be getting Version from
669+ -- a search result.
670+ | ExternalGT ExternalDocVersion
671+ -- ^ Use your own version numbering. Only index
672+ -- the document if the version is strictly higher
673+ -- OR the document doesn't exist. The given
674+ -- version will be used as the new version number
675+ -- for the stored document. N.B. All updates must
676+ -- increment this number, meaning there is some
677+ -- global, external ordering of updates.
678+ | ExternalGTE ExternalDocVersion
679+ -- ^ Use your own version numbering. Only index
680+ -- the document if the version is equal or higher
681+ -- than the stored version. Will succeed if there
682+ -- is no existing document. The given version will
683+ -- be used as the new version number for the
684+ -- stored document. Use with care, as this could
685+ -- result in data loss.
686+ | ForceVersion ExternalDocVersion
687+ -- ^ The document will always be indexed and the
688+ -- given version will be the new version. This is
689+ -- typically used for correcting errors. Use with
690+ -- care, as this could result in data loss.
691+ deriving (Show, Eq, Generic, Ord)
692+
693+{-| 'DocumentParent' is used to specify a parent document.
694+-}
695+newtype DocumentParent = DocumentParent DocId
696+ deriving (Eq, Show, Generic, Typeable)
697+
698+{-| 'IndexDocumentSettings' are special settings supplied when indexing
699+a document. For the best backwards compatiblity when new fields are
700+added, you should probably prefer to start with 'defaultIndexDocumentSettings'
701+-}
702+data IndexDocumentSettings =
703+ IndexDocumentSettings { idsVersionControl :: VersionControl
704+ , idsParent :: Maybe DocumentParent
705+ } deriving (Eq, Show, Generic, Typeable)
706+
707+{-| Reasonable default settings. Chooses no version control and no parent.
708+-}
709+defaultIndexDocumentSettings :: IndexDocumentSettings
710+defaultIndexDocumentSettings = IndexDocumentSettings NoVersionControl Nothing
711+
712+{-| 'Sort' is a synonym for a list of 'SortSpec's. Sort behavior is order
713+ dependent with later sorts acting as tie-breakers for earlier sorts.
714+-}
715+type Sort = [SortSpec]
716+
717+{-| The two main kinds of 'SortSpec' are 'DefaultSortSpec' and
718+ 'GeoDistanceSortSpec'. The latter takes a 'SortOrder', 'GeoPoint', and
719+ 'DistanceUnit' to express "nearness" to a single geographical point as a
720+ sort specification.
721+
722+<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort>
723+-}
724+data SortSpec = DefaultSortSpec DefaultSort
725+ | GeoDistanceSortSpec SortOrder GeoPoint DistanceUnit deriving (Eq, Show, Generic, Typeable)
726+
727+{-| 'DefaultSort' is usually the kind of 'SortSpec' you'll want. There's a
728+ 'mkSort' convenience function for when you want to specify only the most
729+ common parameters.
730+
731+<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort>
732+-}
733+data DefaultSort =
734+ DefaultSort { sortFieldName :: FieldName
735+ , sortOrder :: SortOrder
736+ -- default False
737+ , ignoreUnmapped :: Bool
738+ , sortMode :: Maybe SortMode
739+ , missingSort :: Maybe Missing
740+ , nestedFilter :: Maybe Filter } deriving (Eq, Show, Generic, Typeable)
741+
742+{-| 'SortOrder' is 'Ascending' or 'Descending', as you might expect. These get
743+ encoded into "asc" or "desc" when turned into JSON.
744+
745+<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort>
746+-}
747+data SortOrder = Ascending
748+ | Descending deriving (Eq, Show, Generic, Typeable)
749+
750+{-| 'Missing' prescribes how to handle missing fields. A missing field can be
751+ sorted last, first, or using a custom value as a substitute.
752+
753+<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#_missing_values>
754+-}
755+data Missing = LastMissing
756+ | FirstMissing
757+ | CustomMissing Text deriving (Eq, Show, Generic, Typeable)
758+
759+{-| 'SortMode' prescribes how to handle sorting array/multi-valued fields.
760+
761+http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#_sort_mode_option
762+-}
763+data SortMode = SortMin
764+ | SortMax
765+ | SortSum
766+ | SortAvg deriving (Eq, Show, Generic, Typeable)
767+
768+{-| 'mkSort' defaults everything but the 'FieldName' and the 'SortOrder' so
769+ that you can concisely describe the usual kind of 'SortSpec's you want.
770+-}
771+mkSort :: FieldName -> SortOrder -> DefaultSort
772+mkSort fieldName sOrder = DefaultSort fieldName sOrder False Nothing Nothing Nothing
773+
774+{-| 'Cache' is for telling ES whether it should cache a 'Filter' not.
775+ 'Query's cannot be cached.
776+-}
777+type Cache = Bool -- caching on/off
778+defaultCache :: Cache
779+defaultCache = False
780+
781+{-| 'PrefixValue' is used in 'PrefixQuery' as the main query component.
782+-}
783+type PrefixValue = Text
784+
785+{-| 'BooleanOperator' is the usual And/Or operators with an ES compatible
786+ JSON encoding baked in. Used all over the place.
787+-}
788+data BooleanOperator = And | Or deriving (Eq, Show, Generic, Typeable)
789+
790+{-| 'ShardCount' is part of 'IndexSettings'
791+-}
792+newtype ShardCount = ShardCount Int deriving (Eq, Show, Generic, ToJSON, Typeable)
793+
794+{-| 'ReplicaCount' is part of 'IndexSettings'
795+-}
796+newtype ReplicaCount = ReplicaCount Int deriving (Eq, Show, Generic, ToJSON, Typeable)
797+
798+{-| 'IndexName' is used to describe which index to query/create/delete
799+-}
800+newtype IndexName = IndexName Text deriving (Eq, Generic, Show, ToJSON, FromJSON, Typeable)
801+
802+{-| 'IndexSelection' is used for APIs which take a single index, a list of
803+ indexes, or the special @_all@ index.
804+-}
805+data IndexSelection = IndexList (NonEmpty IndexName)
806+ | AllIndexes deriving (Eq, Generic, Show, Typeable)
807+
808+{-| 'TemplateName' is used to describe which template to query/create/delete
809+-}
810+newtype TemplateName = TemplateName Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
811+
812+{-| 'TemplatePattern' represents a pattern which is matched against index names
813+-}
814+newtype TemplatePattern = TemplatePattern Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
407815
408− , Analysis(..)
409− , AnalyzerDefinition(..)
410− , TokenizerDefinition(..)
411− , TokenFilterDefinition(..)
412− , CharFilterDefinition(..)
413− , Ngram(..)
414− , TokenChar(..)
415− , Shingle(..)
416− , Language(..)
417− ) where
418−
419−import Bloodhound.Import
420−
421−import Database.Bloodhound.Internal.Aggregation
422−import Database.Bloodhound.Internal.Analysis
423−import Database.Bloodhound.Internal.Client
424−import Database.Bloodhound.Internal.Highlight
425−import Database.Bloodhound.Internal.Newtypes
426−import Database.Bloodhound.Internal.Query
427−import Database.Bloodhound.Internal.Sort
428−import Database.Bloodhound.Internal.Suggest
816+{-| 'MappingName' is part of mappings which are how ES describes and schematizes
817+ the data in the indices.
818+-}
819+newtype MappingName = MappingName Text deriving (Eq, Generic, Show, ToJSON, FromJSON, Typeable)
820+
821+{-| 'DocId' is a generic wrapper value for expressing unique Document IDs.
822+ Can be set by the user or created by ES itself. Often used in client
823+ functions for poking at specific documents.
824+-}
825+newtype DocId = DocId Text deriving (Eq, Generic, Show, ToJSON, FromJSON, Typeable)
826+
827+{-| 'QueryString' is used to wrap query text bodies, be they human written or not.
828+-}
829+newtype QueryString = QueryString Text deriving (Eq, Generic, Show, ToJSON, FromJSON, Typeable)
830+
831+{-| 'FieldName' is used all over the place wherever a specific field within
832+ a document needs to be specified, usually in 'Query's or 'Filter's.
833+-}
834+newtype FieldName = FieldName Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
835+
836+
837+{-| 'Script' is often used in place of 'FieldName' to specify more
838+complex ways of extracting a value from a document.
839+-}
840+newtype Script = Script { scriptText :: Text } deriving (Eq, Show, Generic, Typeable)
841+
842+{-| 'CacheName' is used in 'RegexpFilter' for describing the
843+ 'CacheKey' keyed caching behavior.
844+-}
845+newtype CacheName = CacheName Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
846+
847+{-| 'CacheKey' is used in 'RegexpFilter' to key regex caching.
848+-}
849+newtype CacheKey =
850+ CacheKey Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
851+newtype Existence =
852+ Existence Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
853+newtype NullValue =
854+ NullValue Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
855+newtype CutoffFrequency =
856+ CutoffFrequency Double deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
857+newtype Analyzer =
858+ Analyzer Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
859+newtype MaxExpansions =
860+ MaxExpansions Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
861+
862+{-| 'Lenient', if set to true, will cause format based failures to be
863+ ignored. I don't know what the bloody default is, Elasticsearch
864+ documentation didn't say what it was. Let me know if you figure it out.
865+-}
866+newtype Lenient =
867+ Lenient Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
868+newtype Tiebreaker =
869+ Tiebreaker Double deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
870+newtype Boost =
871+ Boost Double deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
872+newtype BoostTerms =
873+ BoostTerms Double deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
874+
875+{-| 'MinimumMatch' controls how many should clauses in the bool query should
876+ match. Can be an absolute value (2) or a percentage (30%) or a
877+ combination of both.
878+-}
879+newtype MinimumMatch =
880+ MinimumMatch Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
881+newtype DisableCoord =
882+ DisableCoord Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
883+newtype IgnoreTermFrequency =
884+ IgnoreTermFrequency Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
885+newtype MinimumTermFrequency =
886+ MinimumTermFrequency Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
887+newtype MaxQueryTerms =
888+ MaxQueryTerms Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
889+newtype Fuzziness =
890+ Fuzziness Double deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
891+
892+{-| 'PrefixLength' is the prefix length used in queries, defaults to 0. -}
893+newtype PrefixLength =
894+ PrefixLength Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
895+newtype TypeName =
896+ TypeName Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
897+newtype PercentMatch =
898+ PercentMatch Double deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
899+newtype StopWord =
900+ StopWord Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
901+newtype QueryPath =
902+ QueryPath Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
903+
904+{-| Allowing a wildcard at the beginning of a word (eg "*ing") is particularly
905+ heavy, because all terms in the index need to be examined, just in case
906+ they match. Leading wildcards can be disabled by setting
907+ 'AllowLeadingWildcard' to false. -}
908+newtype AllowLeadingWildcard =
909+ AllowLeadingWildcard Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
910+newtype LowercaseExpanded =
911+ LowercaseExpanded Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
912+newtype EnablePositionIncrements =
913+ EnablePositionIncrements Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
914+
915+{-| By default, wildcard terms in a query are not analyzed.
916+ Setting 'AnalyzeWildcard' to true enables best-effort analysis.
917+-}
918+newtype AnalyzeWildcard = AnalyzeWildcard Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
919+
920+{-| 'GeneratePhraseQueries' defaults to false.
921+-}
922+newtype GeneratePhraseQueries =
923+ GeneratePhraseQueries Bool deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
924+
925+{-| 'Locale' is used for string conversions - defaults to ROOT.
926+-}
927+newtype Locale = Locale Text deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
928+newtype MaxWordLength = MaxWordLength Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
929+newtype MinWordLength = MinWordLength Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
930+
931+{-| 'PhraseSlop' sets the default slop for phrases, 0 means exact
932+ phrase matches. Default is 0.
933+-}
934+newtype PhraseSlop = PhraseSlop Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
935+newtype MinDocFrequency = MinDocFrequency Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
936+newtype MaxDocFrequency = MaxDocFrequency Int deriving (Eq, Show, Generic, ToJSON, FromJSON, Typeable)
937+
938+-- | Newtype wrapper to parse ES's concerning tendency to in some APIs return a floating point number of milliseconds since epoch ಠ_ಠ
939+newtype POSIXMS = POSIXMS { posixMS :: UTCTime }
429940
430941{-| 'unpackId' is a silly convenience function that gets used once.
431942-}
@@ -433,6 +944,8 @@ unpackId :: DocId -> Text
433944unpackId (DocId docId) = docId
434945
435946type TrackSortScores = Bool
947+newtype From = From Int deriving (Eq, Show, Generic, ToJSON)
948+newtype Size = Size Int deriving (Eq, Show, Generic, ToJSON)
436949
437950data Search = Search { queryBody :: Maybe Query
438951 , filterBody :: Maybe Filter
@@ -444,74 +957,537 @@ data Search = Search { queryBody :: Maybe Query
444957 , from :: From
445958 , size :: Size
446959 , searchType :: SearchType
447− , searchAfterKey :: Maybe SearchAfterKey
448960 , fields :: Maybe [FieldName]
449− , scriptFields :: Maybe ScriptFields
450− , source :: Maybe Source
451− , suggestBody :: Maybe Suggest -- ^ Only one Suggestion request / response per Search is supported.
452− } deriving (Eq, Show)
453−
454−
455−instance ToJSON Search where
456− toJSON (Search mquery sFilter sort searchAggs
457− highlight sTrackSortScores sFrom sSize _ sAfter sFields
458− sScriptFields sSource sSuggest) =
459− omitNulls [ "query" .= query'
460− , "sort" .= sort
461− , "aggregations" .= searchAggs
462− , "highlight" .= highlight
463− , "from" .= sFrom
464− , "size" .= sSize
465− , "track_scores" .= sTrackSortScores
466− , "search_after" .= sAfter
467− , "fields" .= sFields
468− , "script_fields" .= sScriptFields
469− , "_source" .= sSource
470− , "suggest" .= sSuggest]
471−
472− where query' = case sFilter of
473− Nothing -> mquery
474− Just x ->
475− Just
476− . QueryBoolQuery
477− $ mkBoolQuery (maybeToList mquery)
478− [x] [] []
961+ , source :: Maybe Source } deriving (Eq, Show, Generic, Typeable)
479962
480963data SearchType = SearchTypeQueryThenFetch
481964 | SearchTypeDfsQueryThenFetch
482− deriving (Eq, Show)
965+ | SearchTypeCount
966+ | SearchTypeScan
967+ | SearchTypeQueryAndFetch
968+ | SearchTypeDfsQueryAndFetch
969+ deriving (Eq, Show, Generic, Typeable)
483970
484971data Source =
485972 NoSource
486973 | SourcePatterns PatternOrPatterns
487974 | SourceIncludeExclude Include Exclude
488− deriving (Eq, Show)
489−
490−instance ToJSON Source where
491− toJSON NoSource = toJSON False
492− toJSON (SourcePatterns patterns) = toJSON patterns
493− toJSON (SourceIncludeExclude incl excl) = object [ "includes" .= incl, "excludes" .= excl ]
975+ deriving (Show, Eq, Generic, Typeable)
494976
495977data PatternOrPatterns = PopPattern Pattern
496− | PopPatterns [Pattern] deriving (Eq, Read, Show)
978+ | PopPatterns [Pattern] deriving (Eq, Show, Generic, Typeable)
497979
498−instance ToJSON PatternOrPatterns where
499− toJSON (PopPattern pattern) = toJSON pattern
500− toJSON (PopPatterns patterns) = toJSON patterns
980+data Include = Include [Pattern] deriving (Eq, Show, Generic, Typeable)
981+data Exclude = Exclude [Pattern] deriving (Eq, Show, Generic, Typeable)
501982
502−data Include = Include [Pattern] deriving (Eq, Read, Show)
503−data Exclude = Exclude [Pattern] deriving (Eq, Read, Show)
983+newtype Pattern = Pattern Text deriving (Eq, Show, Generic, Typeable)
504984
505−instance ToJSON Include where
506− toJSON (Include patterns) = toJSON patterns
985+data Highlights = Highlights { globalsettings :: Maybe HighlightSettings
986+ , highlightFields :: [FieldHighlight]
987+ } deriving (Show, Eq, Generic, Typeable)
507988
508−instance ToJSON Exclude where
509− toJSON (Exclude patterns) = toJSON patterns
989+data FieldHighlight = FieldHighlight FieldName (Maybe HighlightSettings)
990+ deriving (Show, Eq, Generic, Typeable)
510991
511−newtype Pattern = Pattern Text deriving (Eq, Read, Show)
512992
513−instance ToJSON Pattern where
514− toJSON (Pattern pattern) = toJSON pattern
993+data HighlightSettings = Plain PlainHighlight
994+ | Postings PostingsHighlight
995+ | FastVector FastVectorHighlight
996+ deriving (Show, Eq, Generic, Typeable)
997+data PlainHighlight =
998+ PlainHighlight { plainCommon :: Maybe CommonHighlight
999+ , plainNonPost :: Maybe NonPostings } deriving (Show, Eq, Generic, Typeable)
1000+
1001+ -- This requires that index_options are set to 'offset' in the mapping.
1002+data PostingsHighlight = PostingsHighlight (Maybe CommonHighlight) deriving (Show, Eq, Generic, Typeable)
1003+
1004+-- This requires that term_vector is set to 'with_positions_offsets' in the mapping.
1005+data FastVectorHighlight =
1006+ FastVectorHighlight { fvCommon :: Maybe CommonHighlight
1007+ , fvNonPostSettings :: Maybe NonPostings
1008+ , boundaryChars :: Maybe Text
1009+ , boundaryMaxScan :: Maybe Int
1010+ , fragmentOffset :: Maybe Int
1011+ , matchedFields :: [Text]
1012+ , phraseLimit :: Maybe Int
1013+ } deriving (Show, Eq, Generic, Typeable)
1014+
1015+data CommonHighlight =
1016+ CommonHighlight { order :: Maybe Text
1017+ , forceSource :: Maybe Bool
1018+ , tag :: Maybe HighlightTag
1019+ , encoder :: Maybe HighlightEncoder
1020+ , noMatchSize :: Maybe Int
1021+ , highlightQuery :: Maybe Query
1022+ , requireFieldMatch :: Maybe Bool
1023+ } deriving (Show, Eq, Generic, Typeable)
1024+
1025+-- Settings that are only applicable to FastVector and Plain highlighters.
1026+data NonPostings =
1027+ NonPostings { fragmentSize :: Maybe Int
1028+ , numberOfFragments :: Maybe Int} deriving (Show, Eq, Generic, Typeable)
1029+
1030+data HighlightEncoder = DefaultEncoder
1031+ | HTMLEncoder
1032+ deriving (Show, Eq, Generic, Typeable)
1033+
1034+-- NOTE: Should the tags use some kind of HTML type, rather than Text?
1035+data HighlightTag = TagSchema Text
1036+ | CustomTags ([Text], [Text]) -- Only uses more than the first value in the lists if fvh
1037+ deriving (Show, Eq, Generic, Typeable)
1038+
1039+
1040+data Query =
1041+ TermQuery Term (Maybe Boost)
1042+ | TermsQuery Text (NonEmpty Text)
1043+ | QueryMatchQuery MatchQuery
1044+ | QueryMultiMatchQuery MultiMatchQuery
1045+ | QueryBoolQuery BoolQuery
1046+ | QueryBoostingQuery BoostingQuery
1047+ | QueryCommonTermsQuery CommonTermsQuery
1048+ | ConstantScoreFilter Filter Boost
1049+ | ConstantScoreQuery Query Boost
1050+ | QueryDisMaxQuery DisMaxQuery
1051+ | QueryFilteredQuery FilteredQuery
1052+ | QueryFuzzyLikeThisQuery FuzzyLikeThisQuery
1053+ | QueryFuzzyLikeFieldQuery FuzzyLikeFieldQuery
1054+ | QueryFuzzyQuery FuzzyQuery
1055+ | QueryHasChildQuery HasChildQuery
1056+ | QueryHasParentQuery HasParentQuery
1057+ | IdsQuery MappingName [DocId]
1058+ | QueryIndicesQuery IndicesQuery
1059+ | MatchAllQuery (Maybe Boost)
1060+ | QueryMoreLikeThisQuery MoreLikeThisQuery
1061+ | QueryMoreLikeThisFieldQuery MoreLikeThisFieldQuery
1062+ | QueryNestedQuery NestedQuery
1063+ | QueryPrefixQuery PrefixQuery
1064+ | QueryQueryStringQuery QueryStringQuery
1065+ | QuerySimpleQueryStringQuery SimpleQueryStringQuery
1066+ | QueryRangeQuery RangeQuery
1067+ | QueryRegexpQuery RegexpQuery
1068+ deriving (Eq, Show, Generic, Typeable)
1069+
1070+data RegexpQuery =
1071+ RegexpQuery { regexpQueryField :: FieldName
1072+ , regexpQuery :: Regexp
1073+ , regexpQueryFlags :: RegexpFlags
1074+ , regexpQueryBoost :: Maybe Boost
1075+ } deriving (Eq, Show, Generic, Typeable)
1076+
1077+data RangeQuery =
1078+ RangeQuery { rangeQueryField :: FieldName
1079+ , rangeQueryRange :: RangeValue
1080+ , rangeQueryBoost :: Boost } deriving (Eq, Show, Generic, Typeable)
1081+
1082+mkRangeQuery :: FieldName -> RangeValue -> RangeQuery
1083+mkRangeQuery f r = RangeQuery f r (Boost 1.0)
1084+
1085+data SimpleQueryStringQuery =
1086+ SimpleQueryStringQuery
1087+ { simpleQueryStringQuery :: QueryString
1088+ , simpleQueryStringField :: Maybe FieldOrFields
1089+ , simpleQueryStringOperator :: Maybe BooleanOperator
1090+ , simpleQueryStringAnalyzer :: Maybe Analyzer
1091+ , simpleQueryStringFlags :: Maybe (NonEmpty SimpleQueryFlag)
1092+ , simpleQueryStringLowercaseExpanded :: Maybe LowercaseExpanded
1093+ , simpleQueryStringLocale :: Maybe Locale
1094+ } deriving (Eq, Show, Generic, Typeable)
1095+
1096+data SimpleQueryFlag =
1097+ SimpleQueryAll
1098+ | SimpleQueryNone
1099+ | SimpleQueryAnd
1100+ | SimpleQueryOr
1101+ | SimpleQueryPrefix
1102+ | SimpleQueryPhrase
1103+ | SimpleQueryPrecedence
1104+ | SimpleQueryEscape
1105+ | SimpleQueryWhitespace
1106+ | SimpleQueryFuzzy
1107+ | SimpleQueryNear
1108+ | SimpleQuerySlop deriving (Eq, Show, Generic, Typeable)
1109+
1110+-- use_dis_max and tie_breaker when fields are plural?
1111+data QueryStringQuery =
1112+ QueryStringQuery
1113+ { queryStringQuery :: QueryString
1114+ , queryStringDefaultField :: Maybe FieldName
1115+ , queryStringOperator :: Maybe BooleanOperator
1116+ , queryStringAnalyzer :: Maybe Analyzer
1117+ , queryStringAllowLeadingWildcard :: Maybe AllowLeadingWildcard
1118+ , queryStringLowercaseExpanded :: Maybe LowercaseExpanded
1119+ , queryStringEnablePositionIncrements :: Maybe EnablePositionIncrements
1120+ , queryStringFuzzyMaxExpansions :: Maybe MaxExpansions
1121+ , queryStringFuzziness :: Maybe Fuzziness
1122+ , queryStringFuzzyPrefixLength :: Maybe PrefixLength
1123+ , queryStringPhraseSlop :: Maybe PhraseSlop
1124+ , queryStringBoost :: Maybe Boost
1125+ , queryStringAnalyzeWildcard :: Maybe AnalyzeWildcard
1126+ , queryStringGeneratePhraseQueries :: Maybe GeneratePhraseQueries
1127+ , queryStringMinimumShouldMatch :: Maybe MinimumMatch
1128+ , queryStringLenient :: Maybe Lenient
1129+ , queryStringLocale :: Maybe Locale
1130+ } deriving (Eq, Show, Generic, Typeable)
1131+
1132+mkQueryStringQuery :: QueryString -> QueryStringQuery
1133+mkQueryStringQuery qs =
1134+ QueryStringQuery qs Nothing Nothing
1135+ Nothing Nothing Nothing Nothing
1136+ Nothing Nothing Nothing Nothing
1137+ Nothing Nothing Nothing Nothing
1138+ Nothing Nothing
1139+
1140+data FieldOrFields = FofField FieldName
1141+ | FofFields (NonEmpty FieldName) deriving (Eq, Show, Generic, Typeable)
1142+
1143+data PrefixQuery =
1144+ PrefixQuery
1145+ { prefixQueryField :: FieldName
1146+ , prefixQueryPrefixValue :: Text
1147+ , prefixQueryBoost :: Maybe Boost } deriving (Eq, Show, Generic, Typeable)
1148+
1149+data NestedQuery =
1150+ NestedQuery
1151+ { nestedQueryPath :: QueryPath
1152+ , nestedQueryScoreType :: ScoreType
1153+ , nestedQuery :: Query } deriving (Eq, Show, Generic, Typeable)
1154+
1155+data MoreLikeThisFieldQuery =
1156+ MoreLikeThisFieldQuery
1157+ { moreLikeThisFieldText :: Text
1158+ , moreLikeThisFieldFields :: FieldName
1159+ -- default 0.3 (30%)
1160+ , moreLikeThisFieldPercentMatch :: Maybe PercentMatch
1161+ , moreLikeThisFieldMinimumTermFreq :: Maybe MinimumTermFrequency
1162+ , moreLikeThisFieldMaxQueryTerms :: Maybe MaxQueryTerms
1163+ , moreLikeThisFieldStopWords :: Maybe (NonEmpty StopWord)
1164+ , moreLikeThisFieldMinDocFrequency :: Maybe MinDocFrequency
1165+ , moreLikeThisFieldMaxDocFrequency :: Maybe MaxDocFrequency
1166+ , moreLikeThisFieldMinWordLength :: Maybe MinWordLength
1167+ , moreLikeThisFieldMaxWordLength :: Maybe MaxWordLength
1168+ , moreLikeThisFieldBoostTerms :: Maybe BoostTerms
1169+ , moreLikeThisFieldBoost :: Maybe Boost
1170+ , moreLikeThisFieldAnalyzer :: Maybe Analyzer
1171+ } deriving (Eq, Show, Generic, Typeable)
1172+
1173+data MoreLikeThisQuery =
1174+ MoreLikeThisQuery
1175+ { moreLikeThisText :: Text
1176+ , moreLikeThisFields :: Maybe (NonEmpty FieldName)
1177+ -- default 0.3 (30%)
1178+ , moreLikeThisPercentMatch :: Maybe PercentMatch
1179+ , moreLikeThisMinimumTermFreq :: Maybe MinimumTermFrequency
1180+ , moreLikeThisMaxQueryTerms :: Maybe MaxQueryTerms
1181+ , moreLikeThisStopWords :: Maybe (NonEmpty StopWord)
1182+ , moreLikeThisMinDocFrequency :: Maybe MinDocFrequency
1183+ , moreLikeThisMaxDocFrequency :: Maybe MaxDocFrequency
1184+ , moreLikeThisMinWordLength :: Maybe MinWordLength
1185+ , moreLikeThisMaxWordLength :: Maybe MaxWordLength
1186+ , moreLikeThisBoostTerms :: Maybe BoostTerms
1187+ , moreLikeThisBoost :: Maybe Boost
1188+ , moreLikeThisAnalyzer :: Maybe Analyzer
1189+ } deriving (Eq, Show, Generic, Typeable)
1190+
1191+data IndicesQuery =
1192+ IndicesQuery
1193+ { indicesQueryIndices :: [IndexName]
1194+ , indicesQuery :: Query
1195+ -- default "all"
1196+ , indicesQueryNoMatch :: Maybe Query } deriving (Eq, Show, Generic, Typeable)
1197+
1198+data HasParentQuery =
1199+ HasParentQuery
1200+ { hasParentQueryType :: TypeName
1201+ , hasParentQuery :: Query
1202+ , hasParentQueryScoreType :: Maybe ScoreType } deriving (Eq, Show, Generic, Typeable)
1203+
1204+data HasChildQuery =
1205+ HasChildQuery
1206+ { hasChildQueryType :: TypeName
1207+ , hasChildQuery :: Query
1208+ , hasChildQueryScoreType :: Maybe ScoreType } deriving (Eq, Show, Generic, Typeable)
1209+
1210+data ScoreType =
1211+ ScoreTypeMax
1212+ | ScoreTypeSum
1213+ | ScoreTypeAvg
1214+ | ScoreTypeNone deriving (Eq, Show, Generic, Typeable)
1215+
1216+data FuzzyQuery =
1217+ FuzzyQuery { fuzzyQueryField :: FieldName
1218+ , fuzzyQueryValue :: Text
1219+ , fuzzyQueryPrefixLength :: PrefixLength
1220+ , fuzzyQueryMaxExpansions :: MaxExpansions
1221+ , fuzzyQueryFuzziness :: Fuzziness
1222+ , fuzzyQueryBoost :: Maybe Boost
1223+ } deriving (Eq, Show, Generic, Typeable)
1224+
1225+data FuzzyLikeFieldQuery =
1226+ FuzzyLikeFieldQuery
1227+ { fuzzyLikeField :: FieldName
1228+ -- anaphora is good for the soul.
1229+ , fuzzyLikeFieldText :: Text
1230+ , fuzzyLikeFieldMaxQueryTerms :: MaxQueryTerms
1231+ , fuzzyLikeFieldIgnoreTermFrequency :: IgnoreTermFrequency
1232+ , fuzzyLikeFieldFuzziness :: Fuzziness
1233+ , fuzzyLikeFieldPrefixLength :: PrefixLength
1234+ , fuzzyLikeFieldBoost :: Boost
1235+ , fuzzyLikeFieldAnalyzer :: Maybe Analyzer
1236+ } deriving (Eq, Show, Generic, Typeable)
1237+
1238+data FuzzyLikeThisQuery =
1239+ FuzzyLikeThisQuery
1240+ { fuzzyLikeFields :: [FieldName]
1241+ , fuzzyLikeText :: Text
1242+ , fuzzyLikeMaxQueryTerms :: MaxQueryTerms
1243+ , fuzzyLikeIgnoreTermFrequency :: IgnoreTermFrequency
1244+ , fuzzyLikeFuzziness :: Fuzziness
1245+ , fuzzyLikePrefixLength :: PrefixLength
1246+ , fuzzyLikeBoost :: Boost
1247+ , fuzzyLikeAnalyzer :: Maybe Analyzer
1248+ } deriving (Eq, Show, Generic, Typeable)
1249+
1250+data FilteredQuery =
1251+ FilteredQuery
1252+ { filteredQuery :: Query
1253+ , filteredFilter :: Filter } deriving (Eq, Show, Generic, Typeable)
1254+
1255+data DisMaxQuery =
1256+ DisMaxQuery { disMaxQueries :: [Query]
1257+ -- default 0.0
1258+ , disMaxTiebreaker :: Tiebreaker
1259+ , disMaxBoost :: Maybe Boost
1260+ } deriving (Eq, Show, Generic, Typeable)
1261+
1262+data MatchQuery =
1263+ MatchQuery { matchQueryField :: FieldName
1264+ , matchQueryQueryString :: QueryString
1265+ , matchQueryOperator :: BooleanOperator
1266+ , matchQueryZeroTerms :: ZeroTermsQuery
1267+ , matchQueryCutoffFrequency :: Maybe CutoffFrequency
1268+ , matchQueryMatchType :: Maybe MatchQueryType
1269+ , matchQueryAnalyzer :: Maybe Analyzer
1270+ , matchQueryMaxExpansions :: Maybe MaxExpansions
1271+ , matchQueryLenient :: Maybe Lenient
1272+ , matchQueryBoost :: Maybe Boost } deriving (Eq, Show, Generic, Typeable)
1273+
1274+{-| 'mkMatchQuery' is a convenience function that defaults the less common parameters,
1275+ enabling you to provide only the 'FieldName' and 'QueryString' to make a 'MatchQuery'
1276+-}
1277+mkMatchQuery :: FieldName -> QueryString -> MatchQuery
1278+mkMatchQuery field query = MatchQuery field query Or ZeroTermsNone Nothing Nothing Nothing Nothing Nothing Nothing
1279+
1280+data MatchQueryType =
1281+ MatchPhrase
1282+ | MatchPhrasePrefix deriving (Eq, Show, Generic, Typeable)
1283+
1284+data MultiMatchQuery =
1285+ MultiMatchQuery { multiMatchQueryFields :: [FieldName]
1286+ , multiMatchQueryString :: QueryString
1287+ , multiMatchQueryOperator :: BooleanOperator
1288+ , multiMatchQueryZeroTerms :: ZeroTermsQuery
1289+ , multiMatchQueryTiebreaker :: Maybe Tiebreaker
1290+ , multiMatchQueryType :: Maybe MultiMatchQueryType
1291+ , multiMatchQueryCutoffFrequency :: Maybe CutoffFrequency
1292+ , multiMatchQueryAnalyzer :: Maybe Analyzer
1293+ , multiMatchQueryMaxExpansions :: Maybe MaxExpansions
1294+ , multiMatchQueryLenient :: Maybe Lenient } deriving (Eq, Show, Generic, Typeable)
1295+
1296+{-| 'mkMultiMatchQuery' is a convenience function that defaults the less common parameters,
1297+ enabling you to provide only the list of 'FieldName's and 'QueryString' to
1298+ make a 'MultiMatchQuery'.
1299+-}
1300+
1301+mkMultiMatchQuery :: [FieldName] -> QueryString -> MultiMatchQuery
1302+mkMultiMatchQuery matchFields query =
1303+ MultiMatchQuery matchFields query
1304+ Or ZeroTermsNone Nothing Nothing Nothing Nothing Nothing Nothing
1305+
1306+data MultiMatchQueryType =
1307+ MultiMatchBestFields
1308+ | MultiMatchMostFields
1309+ | MultiMatchCrossFields
1310+ | MultiMatchPhrase
1311+ | MultiMatchPhrasePrefix deriving (Eq, Show, Generic, Typeable)
1312+
1313+data BoolQuery =
1314+ BoolQuery { boolQueryMustMatch :: [Query]
1315+ , boolQueryMustNotMatch :: [Query]
1316+ , boolQueryShouldMatch :: [Query]
1317+ , boolQueryMinimumShouldMatch :: Maybe MinimumMatch
1318+ , boolQueryBoost :: Maybe Boost
1319+ , boolQueryDisableCoord :: Maybe DisableCoord
1320+ } deriving (Eq, Show, Generic, Typeable)
1321+
1322+mkBoolQuery :: [Query] -> [Query] -> [Query] -> BoolQuery
1323+mkBoolQuery must mustNot should =
1324+ BoolQuery must mustNot should Nothing Nothing Nothing
1325+
1326+data BoostingQuery =
1327+ BoostingQuery { positiveQuery :: Query
1328+ , negativeQuery :: Query
1329+ , negativeBoost :: Boost } deriving (Eq, Show, Generic, Typeable)
1330+
1331+data CommonTermsQuery =
1332+ CommonTermsQuery { commonField :: FieldName
1333+ , commonQuery :: QueryString
1334+ , commonCutoffFrequency :: CutoffFrequency
1335+ , commonLowFreqOperator :: BooleanOperator
1336+ , commonHighFreqOperator :: BooleanOperator
1337+ , commonMinimumShouldMatch :: Maybe CommonMinimumMatch
1338+ , commonBoost :: Maybe Boost
1339+ , commonAnalyzer :: Maybe Analyzer
1340+ , commonDisableCoord :: Maybe DisableCoord
1341+ } deriving (Eq, Show, Generic, Typeable)
1342+
1343+data CommonMinimumMatch =
1344+ CommonMinimumMatchHighLow MinimumMatchHighLow
1345+ | CommonMinimumMatch MinimumMatch
1346+ deriving (Eq, Show, Generic, Typeable)
1347+
1348+data MinimumMatchHighLow =
1349+ MinimumMatchHighLow { lowFreq :: MinimumMatch
1350+ , highFreq :: MinimumMatch } deriving (Eq, Show, Generic, Typeable)
1351+
1352+data Filter = AndFilter [Filter] Cache
1353+ | OrFilter [Filter] Cache
1354+ | NotFilter Filter Cache
1355+ | IdentityFilter
1356+ | BoolFilter BoolMatch
1357+ | ExistsFilter FieldName -- always cached
1358+ | GeoBoundingBoxFilter GeoBoundingBoxConstraint
1359+ | GeoDistanceFilter GeoPoint Distance DistanceType OptimizeBbox Cache
1360+ | GeoDistanceRangeFilter GeoPoint DistanceRange
1361+ | GeoPolygonFilter FieldName [LatLon]
1362+ | IdsFilter MappingName [DocId]
1363+ | LimitFilter Int
1364+ | MissingFilter FieldName Existence NullValue
1365+ | PrefixFilter FieldName PrefixValue Cache
1366+ | QueryFilter Query Cache
1367+ | RangeFilter FieldName RangeValue RangeExecution Cache
1368+ | RegexpFilter FieldName Regexp RegexpFlags CacheName Cache CacheKey
1369+ | TermFilter Term Cache
1370+ deriving (Eq, Show, Generic, Typeable)
1371+
1372+data ZeroTermsQuery = ZeroTermsNone
1373+ | ZeroTermsAll deriving (Eq, Show, Generic, Typeable)
1374+
1375+data RangeExecution = RangeExecutionIndex
1376+ | RangeExecutionFielddata deriving (Eq, Show, Generic, Typeable)
1377+
1378+newtype Regexp = Regexp Text deriving (Eq, Show, Generic, Typeable, FromJSON)
1379+
1380+data RegexpFlags = AllRegexpFlags
1381+ | NoRegexpFlags
1382+ | SomeRegexpFlags (NonEmpty RegexpFlag) deriving (Eq, Show, Generic, Typeable)
1383+
1384+data RegexpFlag = AnyString
1385+ | Automaton
1386+ | Complement
1387+ | Empty
1388+ | Intersection
1389+ | Interval deriving (Eq, Show, Generic, Typeable)
1390+
1391+newtype LessThan = LessThan Double deriving (Eq, Show, Generic, Typeable)
1392+newtype LessThanEq = LessThanEq Double deriving (Eq, Show, Generic, Typeable)
1393+newtype GreaterThan = GreaterThan Double deriving (Eq, Show, Generic, Typeable)
1394+newtype GreaterThanEq = GreaterThanEq Double deriving (Eq, Show, Generic, Typeable)
1395+
1396+newtype LessThanD = LessThanD UTCTime deriving (Eq, Show, Generic, Typeable)
1397+newtype LessThanEqD = LessThanEqD UTCTime deriving (Eq, Show, Generic, Typeable)
1398+newtype GreaterThanD = GreaterThanD UTCTime deriving (Eq, Show, Generic, Typeable)
1399+newtype GreaterThanEqD = GreaterThanEqD UTCTime deriving (Eq, Show, Generic, Typeable)
1400+
1401+data RangeValue = RangeDateLte LessThanEqD
1402+ | RangeDateLt LessThanD
1403+ | RangeDateGte GreaterThanEqD
1404+ | RangeDateGt GreaterThanD
1405+ | RangeDateGtLt GreaterThanD LessThanD
1406+ | RangeDateGteLte GreaterThanEqD LessThanEqD
1407+ | RangeDateGteLt GreaterThanEqD LessThanD
1408+ | RangeDateGtLte GreaterThanD LessThanEqD
1409+ | RangeDoubleLte LessThanEq
1410+ | RangeDoubleLt LessThan
1411+ | RangeDoubleGte GreaterThanEq
1412+ | RangeDoubleGt GreaterThan
1413+ | RangeDoubleGtLt GreaterThan LessThan
1414+ | RangeDoubleGteLte GreaterThanEq LessThanEq
1415+ | RangeDoubleGteLt GreaterThanEq LessThan
1416+ | RangeDoubleGtLte GreaterThan LessThanEq
1417+ deriving (Eq, Show, Generic, Typeable)
1418+
1419+rangeValueToPair :: RangeValue -> [Pair]
1420+rangeValueToPair rv = case rv of
1421+ RangeDateLte (LessThanEqD t) -> ["lte" .= t]
1422+ RangeDateGte (GreaterThanEqD t) -> ["gte" .= t]
1423+ RangeDateLt (LessThanD t) -> ["lt" .= t]
1424+ RangeDateGt (GreaterThanD t) -> ["gt" .= t]
1425+ RangeDateGteLte (GreaterThanEqD l) (LessThanEqD g) -> ["gte" .= l, "lte" .= g]
1426+ RangeDateGtLte (GreaterThanD l) (LessThanEqD g) -> ["gt" .= l, "lte" .= g]
1427+ RangeDateGteLt (GreaterThanEqD l) (LessThanD g) -> ["gte" .= l, "lt" .= g]
1428+ RangeDateGtLt (GreaterThanD l) (LessThanD g) -> ["gt" .= l, "lt" .= g]
1429+ RangeDoubleLte (LessThanEq t) -> ["lte" .= t]
1430+ RangeDoubleGte (GreaterThanEq t) -> ["gte" .= t]
1431+ RangeDoubleLt (LessThan t) -> ["lt" .= t]
1432+ RangeDoubleGt (GreaterThan t) -> ["gt" .= t]
1433+ RangeDoubleGteLte (GreaterThanEq l) (LessThanEq g) -> ["gte" .= l, "lte" .= g]
1434+ RangeDoubleGtLte (GreaterThan l) (LessThanEq g) -> ["gt" .= l, "lte" .= g]
1435+ RangeDoubleGteLt (GreaterThanEq l) (LessThan g) -> ["gte" .= l, "lt" .= g]
1436+ RangeDoubleGtLt (GreaterThan l) (LessThan g) -> ["gt" .= l, "lt" .= g]
1437+
1438+data Term = Term { termField :: Text
1439+ , termValue :: Text } deriving (Eq, Show, Generic, Typeable)
1440+
1441+data BoolMatch = MustMatch Term Cache
1442+ | MustNotMatch Term Cache
1443+ | ShouldMatch [Term] Cache deriving (Eq, Show, Generic, Typeable)
1444+
1445+-- "memory" or "indexed"
1446+data GeoFilterType = GeoFilterMemory
1447+ | GeoFilterIndexed deriving (Eq, Show, Generic, Typeable)
1448+
1449+data LatLon = LatLon { lat :: Double
1450+ , lon :: Double } deriving (Eq, Show, Generic, Typeable)
1451+
1452+data GeoBoundingBox =
1453+ GeoBoundingBox { topLeft :: LatLon
1454+ , bottomRight :: LatLon } deriving (Eq, Show, Generic, Typeable)
1455+
1456+data GeoBoundingBoxConstraint =
1457+ GeoBoundingBoxConstraint { geoBBField :: FieldName
1458+ , constraintBox :: GeoBoundingBox
1459+ , bbConstraintcache :: Cache
1460+ , geoType :: GeoFilterType
1461+ } deriving (Eq, Show, Generic, Typeable)
1462+
1463+data GeoPoint =
1464+ GeoPoint { geoField :: FieldName
1465+ , latLon :: LatLon} deriving (Eq, Show, Generic, Typeable)
1466+
1467+data DistanceUnit = Miles
1468+ | Yards
1469+ | Feet
1470+ | Inches
1471+ | Kilometers
1472+ | Meters
1473+ | Centimeters
1474+ | Millimeters
1475+ | NauticalMiles deriving (Eq, Show, Generic, Typeable)
1476+
1477+data DistanceType = Arc
1478+ | SloppyArc -- doesn't exist <1.0
1479+ | Plane deriving (Eq, Show, Generic, Typeable)
1480+
1481+data OptimizeBbox = OptimizeGeoFilterType GeoFilterType
1482+ | NoOptimizeBbox deriving (Eq, Show, Generic, Typeable)
1483+
1484+data Distance =
1485+ Distance { coefficient :: Double
1486+ , unit :: DistanceUnit } deriving (Eq, Show, Generic, Typeable)
1487+
1488+data DistanceRange =
1489+ DistanceRange { distanceFrom :: Distance
1490+ , distanceTo :: Distance } deriving (Eq, Show, Generic, Typeable)
5151491
5161492data SearchResult a =
5171493 SearchResult { took :: Int
@@ -519,24 +1495,2122 @@ data SearchResult a =
5191495 , shards :: ShardResult
5201496 , searchHits :: SearchHits a
5211497 , aggregations :: Maybe AggregationResults
522− , scrollId :: Maybe ScrollId
523− -- ^ Only one Suggestion request / response per
524− -- Search is supported.
525− , suggest :: Maybe NamedSuggestionResponse
526− }
527− deriving (Eq, Show)
1498+ , scrollId :: Maybe ScrollId } deriving (Eq, Show, Generic, Typeable)
5281499
529−instance (FromJSON a) => FromJSON (SearchResult a) where
530− parseJSON (Object v) = SearchResult <$>
531− v .: "took" <*>
532− v .: "timed_out" <*>
533− v .: "_shards" <*>
534− v .: "hits" <*>
535− v .:? "aggregations" <*>
536− v .:? "_scroll_id" <*>
537− v .:? "suggest"
538− parseJSON _ = empty
1500+newtype ScrollId = ScrollId Text deriving (Eq, Show, Generic, Ord, ToJSON, FromJSON)
1501+
1502+type Score = Maybe Double
1503+
1504+data SearchHits a =
1505+ SearchHits { hitsTotal :: Int
1506+ , maxScore :: Score
1507+ , hits :: [Hit a] } deriving (Eq, Show, Generic, Typeable)
1508+
1509+
1510+instance Monoid (SearchHits a) where
1511+ mempty = SearchHits 0 Nothing mempty
1512+ mappend (SearchHits ta ma ha) (SearchHits tb mb hb) =
1513+ SearchHits (ta + tb) (max ma mb) (ha <> hb)
1514+
1515+
1516+data Hit a =
1517+ Hit { hitIndex :: IndexName
1518+ , hitType :: MappingName
1519+ , hitDocId :: DocId
1520+ , hitScore :: Score
1521+ , hitSource :: Maybe a
1522+ , hitHighlight :: Maybe HitHighlight } deriving (Eq, Show, Generic, Typeable)
1523+
1524+data ShardResult =
1525+ ShardResult { shardTotal :: Int
1526+ , shardsSuccessful :: Int
1527+ , shardsFailed :: Int } deriving (Eq, Show, Generic, Typeable)
1528+
1529+type HitHighlight = M.Map Text [Text]
1530+
1531+showText :: Show a => a -> Text
1532+showText = T.pack . show
1533+
1534+readMay :: Read a => String -> Maybe a
1535+readMay s = case reads s of
1536+ (a, ""):_ -> Just a
1537+ _ -> Nothing
1538+
1539+parseReadText :: Read a => Text -> Parser a
1540+parseReadText = maybe mzero return . readMay . T.unpack
1541+
1542+type Aggregations = M.Map Text Aggregation
1543+
1544+emptyAggregations :: Aggregations
1545+emptyAggregations = M.empty
1546+
1547+mkAggregations :: Text -> Aggregation -> Aggregations
1548+mkAggregations name aggregation = M.insert name aggregation emptyAggregations
1549+
1550+data TermOrder = TermOrder{ termSortField :: Text
1551+ , termSortOrder :: SortOrder } deriving (Eq, Show, Generic, Typeable)
1552+
1553+data TermInclusion = TermInclusion Text
1554+ | TermPattern Text Text deriving (Eq, Show, Generic, Typeable)
1555+
1556+data CollectionMode = BreadthFirst
1557+ | DepthFirst deriving (Eq, Show, Generic, Typeable)
1558+
1559+data ExecutionHint = Ordinals
1560+ | GlobalOrdinals
1561+ | GlobalOrdinalsHash
1562+ | GlobalOrdinalsLowCardinality
1563+ | Map deriving (Eq, Show, Generic, Typeable)
1564+
1565+data TimeInterval = Weeks
1566+ | Days
1567+ | Hours
1568+ | Minutes
1569+ | Seconds deriving (Eq)
1570+
1571+data Interval = Year
1572+ | Quarter
1573+ | Month
1574+ | Week
1575+ | Day
1576+ | Hour
1577+ | Minute
1578+ | Second
1579+ | FractionalInterval Float TimeInterval deriving (Eq, Show, Generic, Typeable)
1580+
1581+data Aggregation = TermsAgg TermsAggregation
1582+ | DateHistogramAgg DateHistogramAggregation
1583+ | ValueCountAgg ValueCountAggregation
1584+ | FilterAgg FilterAggregation
1585+ | DateRangeAgg DateRangeAggregation
1586+ | MissingAgg MissingAggregation deriving (Eq, Show, Generic, Typeable)
1587+
1588+data MissingAggregation = MissingAggregation
1589+ { maField :: Text
1590+ } deriving (Eq, Show, Generic, Typeable)
1591+
1592+data TermsAggregation = TermsAggregation { term :: Either Text Text
1593+ , termInclude :: Maybe TermInclusion
1594+ , termExclude :: Maybe TermInclusion
1595+ , termOrder :: Maybe TermOrder
1596+ , termMinDocCount :: Maybe Int
1597+ , termSize :: Maybe Int
1598+ , termShardSize :: Maybe Int
1599+ , termCollectMode :: Maybe CollectionMode
1600+ , termExecutionHint :: Maybe ExecutionHint
1601+ , termAggs :: Maybe Aggregations
1602+ } deriving (Eq, Show, Generic, Typeable)
1603+
1604+data DateHistogramAggregation = DateHistogramAggregation { dateField :: FieldName
1605+ , dateInterval :: Interval
1606+ , dateFormat :: Maybe Text
1607+ -- pre and post deprecated in 1.5
1608+ , datePreZone :: Maybe Text
1609+ , datePostZone :: Maybe Text
1610+ , datePreOffset :: Maybe Text
1611+ , datePostOffset :: Maybe Text
1612+ , dateAggs :: Maybe Aggregations
1613+ } deriving (Eq, Show, Generic, Typeable)
1614+
1615+
1616+data DateRangeAggregation = DateRangeAggregation { draField :: FieldName
1617+ , draFormat :: Maybe Text
1618+ , draRanges :: NonEmpty DateRangeAggRange
1619+ } deriving (Eq, Show, Generic, Typeable)
1620+
1621+data DateRangeAggRange = DateRangeFrom DateMathExpr
1622+ | DateRangeTo DateMathExpr
1623+ | DateRangeFromAndTo DateMathExpr DateMathExpr deriving (Eq, Show, Generic, Typeable)
1624+
1625+-- | See <https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#date-math> for more information.
1626+data DateMathExpr = DateMathExpr DateMathAnchor [DateMathModifier] deriving (Eq, Show, Generic, Typeable)
1627+
1628+
1629+-- | Starting point for a date range. This along with the 'DateMathModifiers' gets you the date ES will start from.
1630+data DateMathAnchor = DMNow
1631+ | DMDate Day deriving (Eq, Show, Generic, Typeable)
1632+
1633+data DateMathModifier = AddTime Int DateMathUnit
1634+ | SubtractTime Int DateMathUnit
1635+ | RoundDownTo DateMathUnit deriving (Eq, Show, Generic, Typeable)
1636+
1637+data DateMathUnit = DMYear
1638+ | DMMonth
1639+ | DMWeek
1640+ | DMDay
1641+ | DMHour
1642+ | DMMinute
1643+ | DMSecond deriving (Eq, Show, Generic, Typeable)
1644+
1645+-- | See <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html> for more information.
1646+data ValueCountAggregation = FieldValueCount FieldName
1647+ | ScriptValueCount Script deriving (Eq, Show, Generic, Typeable)
1648+
1649+-- | Single-bucket filter aggregations. See <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html#search-aggregations-bucket-filter-aggregation> for more information.
1650+data FilterAggregation = FilterAggregation { faFilter :: Filter
1651+ , faAggs :: Maybe Aggregations} deriving (Eq, Show, Generic, Typeable)
1652+
1653+mkTermsAggregation :: Text -> TermsAggregation
1654+mkTermsAggregation t = TermsAggregation (Left t) Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing
1655+
1656+mkTermsScriptAggregation :: Text -> TermsAggregation
1657+mkTermsScriptAggregation t = TermsAggregation (Right t) Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing
1658+
1659+mkDateHistogram :: FieldName -> Interval -> DateHistogramAggregation
1660+mkDateHistogram t i = DateHistogramAggregation t i Nothing Nothing Nothing Nothing Nothing Nothing
1661+
1662+instance ToJSON Version where
1663+ toJSON Version {..} = object ["number" .= number
1664+ ,"build_hash" .= build_hash
1665+ ,"build_timestamp" .= build_timestamp
1666+ ,"build_snapshot" .= build_snapshot
1667+ ,"lucene_version" .= lucene_version]
1668+
1669+instance FromJSON Version where
1670+ parseJSON = withObject "Version" parse
1671+ where parse o = Version
1672+ <$> o .: "number"
1673+ <*> o .: "build_hash"
1674+ <*> o .: "build_timestamp"
1675+ <*> o .: "build_snapshot"
1676+ <*> o .: "lucene_version"
1677+
1678+instance ToJSON TermOrder where
1679+ toJSON (TermOrder termSortField termSortOrder) = object [termSortField .= termSortOrder]
1680+
1681+instance ToJSON TermInclusion where
1682+ toJSON (TermInclusion x) = toJSON x
1683+ toJSON (TermPattern pattern flags) = omitNulls [ "pattern" .= pattern,
1684+ "flags" .= flags]
1685+
1686+instance ToJSON CollectionMode where
1687+ toJSON BreadthFirst = "breadth_first"
1688+ toJSON DepthFirst = "depth_first"
1689+
1690+instance ToJSON ExecutionHint where
1691+ toJSON Ordinals = "ordinals"
1692+ toJSON GlobalOrdinals = "global_ordinals"
1693+ toJSON GlobalOrdinalsHash = "global_ordinals_hash"
1694+ toJSON GlobalOrdinalsLowCardinality = "global_ordinals_low_cardinality"
1695+ toJSON Map = "map"
1696+
1697+instance ToJSON Interval where
1698+ toJSON Year = "year"
1699+ toJSON Quarter = "quarter"
1700+ toJSON Month = "month"
1701+ toJSON Week = "week"
1702+ toJSON Day = "day"
1703+ toJSON Hour = "hour"
1704+ toJSON Minute = "minute"
1705+ toJSON Second = "second"
1706+ toJSON (FractionalInterval fraction interval) = toJSON $ show fraction ++ show interval
1707+
1708+instance Show TimeInterval where
1709+ show Weeks = "w"
1710+ show Days = "d"
1711+ show Hours = "h"
1712+ show Minutes = "m"
1713+ show Seconds = "s"
1714+
1715+instance ToJSON Aggregation where
1716+ toJSON (TermsAgg (TermsAggregation term include exclude order minDocCount size shardSize collectMode executionHint termAggs)) =
1717+ omitNulls ["terms" .= omitNulls [ toJSON' term,
1718+ "include" .= include,
1719+ "exclude" .= exclude,
1720+ "order" .= order,
1721+ "min_doc_count" .= minDocCount,
1722+ "size" .= size,
1723+ "shard_size" .= shardSize,
1724+ "collect_mode" .= collectMode,
1725+ "execution_hint" .= executionHint
1726+ ],
1727+ "aggs" .= termAggs ]
1728+ where
1729+ toJSON' x = case x of { Left y -> "field" .= y; Right y -> "script" .= y }
1730+
1731+ toJSON (DateHistogramAgg (DateHistogramAggregation field interval format preZone postZone preOffset postOffset dateHistoAggs)) =
1732+ omitNulls ["date_histogram" .= omitNulls [ "field" .= field,
1733+ "interval" .= interval,
1734+ "format" .= format,
1735+ "pre_zone" .= preZone,
1736+ "post_zone" .= postZone,
1737+ "pre_offset" .= preOffset,
1738+ "post_offset" .= postOffset
1739+ ],
1740+ "aggs" .= dateHistoAggs ]
1741+ toJSON (ValueCountAgg a) = object ["value_count" .= v]
1742+ where v = case a of
1743+ (FieldValueCount (FieldName n)) -> object ["field" .= n]
1744+ (ScriptValueCount (Script s)) -> object ["script" .= s]
1745+ toJSON (FilterAgg (FilterAggregation filt ags)) =
1746+ omitNulls [ "filter" .= filt
1747+ , "aggs" .= ags]
1748+ toJSON (DateRangeAgg a) = object [ "date_range" .= a
1749+ ]
1750+ toJSON (MissingAgg (MissingAggregation{..})) =
1751+ object ["missing" .= object ["field" .= maField]]
1752+
1753+instance ToJSON DateRangeAggregation where
1754+ toJSON DateRangeAggregation {..} =
1755+ omitNulls [ "field" .= draField
1756+ , "format" .= draFormat
1757+ , "ranges" .= toList draRanges
1758+ ]
1759+
1760+instance ToJSON DateRangeAggRange where
1761+ toJSON (DateRangeFrom e) = object [ "from" .= e ]
1762+ toJSON (DateRangeTo e) = object [ "to" .= e ]
1763+ toJSON (DateRangeFromAndTo f t) = object [ "from" .= f, "to" .= t ]
1764+
1765+instance ToJSON DateMathExpr where
1766+ toJSON (DateMathExpr a mods) = String (fmtA a <> mconcat (fmtMod <$> mods))
1767+ where fmtA DMNow = "now"
1768+ fmtA (DMDate date) = case toGregorian date of
1769+ (y,m,d) -> showText y <> "-" <>
1770+ showText m <> "-" <>
1771+ showText d <> "||"
1772+ fmtMod (AddTime n u) = "+" <> showText n <> fmtU u
1773+ fmtMod (SubtractTime n u) = "-" <> showText n <> fmtU u
1774+ fmtMod (RoundDownTo u) = "/" <> fmtU u
1775+ fmtU DMYear = "y"
1776+ fmtU DMMonth = "M"
1777+ fmtU DMWeek = "w"
1778+ fmtU DMDay = "d"
1779+ fmtU DMHour = "h"
1780+ fmtU DMMinute = "m"
1781+ fmtU DMSecond = "s"
1782+
1783+
1784+type AggregationResults = M.Map Text Value
1785+
1786+class BucketAggregation a where
1787+ key :: a -> BucketValue
1788+ docCount :: a -> Int
1789+ aggs :: a -> Maybe AggregationResults
1790+
1791+
1792+data Bucket a = Bucket { buckets :: [a]} deriving (Show)
1793+
1794+data BucketValue = TextValue Text
1795+ | ScientificValue Scientific
1796+ | BoolValue Bool deriving (Show)
1797+
1798+data MissingResult = MissingResult { missingDocCount :: Int } deriving (Show)
1799+
1800+data TermsResult = TermsResult { termKey :: BucketValue
1801+ , termsDocCount :: Int
1802+ , termsAggs :: Maybe AggregationResults } deriving (Show)
1803+
1804+data DateHistogramResult = DateHistogramResult { dateKey :: Int
1805+ , dateKeyStr :: Maybe Text
1806+ , dateDocCount :: Int
1807+ , dateHistogramAggs :: Maybe AggregationResults } deriving (Show)
1808+
1809+data DateRangeResult = DateRangeResult { dateRangeKey :: Text
1810+ , dateRangeFrom :: Maybe UTCTime
1811+ , dateRangeFromAsString :: Maybe Text
1812+ , dateRangeTo :: Maybe UTCTime
1813+ , dateRangeToAsString :: Maybe Text
1814+ , dateRangeDocCount :: Int
1815+ , dateRangeAggs :: Maybe AggregationResults } deriving (Show, Eq, Generic, Typeable)
1816+
1817+toTerms :: Text -> AggregationResults -> Maybe (Bucket TermsResult)
1818+toTerms = toAggResult
1819+
1820+toDateHistogram :: Text -> AggregationResults -> Maybe (Bucket DateHistogramResult)
1821+toDateHistogram = toAggResult
1822+
1823+toMissing :: Text -> AggregationResults -> Maybe MissingResult
1824+toMissing = toAggResult
1825+
1826+toAggResult :: (FromJSON a) => Text -> AggregationResults -> Maybe a
1827+toAggResult t a = M.lookup t a >>= deserialize
1828+ where deserialize = parseMaybe parseJSON
1829+
1830+instance BucketAggregation TermsResult where
1831+ key = termKey
1832+ docCount = termsDocCount
1833+ aggs = termsAggs
1834+
1835+instance BucketAggregation DateHistogramResult where
1836+ key = TextValue . showText . dateKey
1837+ docCount = dateDocCount
1838+ aggs = dateHistogramAggs
1839+
1840+instance BucketAggregation DateRangeResult where
1841+ key = TextValue . dateRangeKey
1842+ docCount = dateRangeDocCount
1843+ aggs = dateRangeAggs
1844+
1845+instance (FromJSON a, BucketAggregation a) => FromJSON (Bucket a) where
1846+ parseJSON (Object v) = Bucket <$>
1847+ v .: "buckets"
1848+ parseJSON _ = mempty
1849+
1850+instance FromJSON BucketValue where
1851+ parseJSON (String t) = return $ TextValue t
1852+ parseJSON (Number s) = return $ ScientificValue s
1853+ parseJSON (Bool b) = return $ BoolValue b
1854+ parseJSON _ = mempty
1855+
1856+instance FromJSON MissingResult where
1857+ parseJSON = withObject "MissingResult" parse
1858+ where parse v = MissingResult <$> v .: "doc_count"
1859+
1860+instance FromJSON TermsResult where
1861+ parseJSON (Object v) = TermsResult <$>
1862+ v .: "key" <*>
1863+ v .: "doc_count" <*>
1864+ v .:? "aggregations"
1865+ parseJSON _ = mempty
1866+
1867+instance FromJSON DateHistogramResult where
1868+ parseJSON (Object v) = DateHistogramResult <$>
1869+ v .: "key" <*>
1870+ v .:? "key_as_string" <*>
1871+ v .: "doc_count" <*>
1872+ v .:? "aggregations"
1873+ parseJSON _ = mempty
1874+
1875+instance FromJSON DateRangeResult where
1876+ parseJSON = withObject "DateRangeResult" parse
1877+ where parse v = DateRangeResult <$>
1878+ v .: "key" <*>
1879+ (fmap posixMS <$> v .:? "from") <*>
1880+ v .:? "from_as_string" <*>
1881+ (fmap posixMS <$> v .:? "to") <*>
1882+ v .:? "to_as_string" <*>
1883+ v .: "doc_count" <*>
1884+ v .:? "aggregations"
1885+
1886+instance FromJSON POSIXMS where
1887+ parseJSON = withScientific "POSIXMS" (return . parse)
1888+ where parse n = let n' = truncate n :: Integer
1889+ in POSIXMS (posixSecondsToUTCTime (fromInteger (n' `div` 1000)))
1890+
1891+instance Monoid Filter where
1892+ mempty = IdentityFilter
1893+ mappend a b = AndFilter [a, b] defaultCache
1894+
1895+instance Seminearring Filter where
1896+ a <||> b = OrFilter [a, b] defaultCache
1897+
1898+instance ToJSON Filter where
1899+ toJSON (AndFilter filters cache) =
1900+ object ["and" .=
1901+ object [ "filters" .= fmap toJSON filters
1902+ , "_cache" .= cache]]
1903+
1904+ toJSON (OrFilter filters cache) =
1905+ object ["or" .=
1906+ object [ "filters" .= fmap toJSON filters
1907+ , "_cache" .= cache]]
1908+
1909+ toJSON (NotFilter notFilter cache) =
1910+ object ["not" .=
1911+ object ["filter" .= notFilter
1912+ , "_cache" .= cache]]
1913+
1914+ toJSON (IdentityFilter) =
1915+ object ["match_all" .= object []]
1916+
1917+ toJSON (TermFilter (Term termFilterField termFilterValue) cache) =
1918+ object ["term" .= object base]
1919+ where base = [termFilterField .= termFilterValue,
1920+ "_cache" .= cache]
1921+
1922+ toJSON (ExistsFilter (FieldName fieldName)) =
1923+ object ["exists" .= object
1924+ ["field" .= fieldName]]
1925+
1926+ toJSON (BoolFilter boolMatch) =
1927+ object ["bool" .= boolMatch]
1928+
1929+ toJSON (GeoBoundingBoxFilter bbConstraint) =
1930+ object ["geo_bounding_box" .= bbConstraint]
1931+
1932+ toJSON (GeoDistanceFilter (GeoPoint (FieldName distanceGeoField) geoDistLatLon)
1933+ distance distanceType optimizeBbox cache) =
1934+ object ["geo_distance" .=
1935+ object ["distance" .= distance
1936+ , "distance_type" .= distanceType
1937+ , "optimize_bbox" .= optimizeBbox
1938+ , distanceGeoField .= geoDistLatLon
1939+ , "_cache" .= cache]]
1940+
1941+ toJSON (GeoDistanceRangeFilter (GeoPoint (FieldName gddrField) drLatLon)
1942+ (DistanceRange geoDistRangeDistFrom drDistanceTo)) =
1943+ object ["geo_distance_range" .=
1944+ object ["from" .= geoDistRangeDistFrom
1945+ , "to" .= drDistanceTo
1946+ , gddrField .= drLatLon]]
1947+
1948+ toJSON (GeoPolygonFilter (FieldName geoPolygonFilterField) latLons) =
1949+ object ["geo_polygon" .=
1950+ object [geoPolygonFilterField .=
1951+ object ["points" .= fmap toJSON latLons]]]
1952+
1953+ toJSON (IdsFilter (MappingName mappingName) values) =
1954+ object ["ids" .=
1955+ object ["type" .= mappingName
1956+ , "values" .= fmap unpackId values]]
1957+
1958+ toJSON (LimitFilter limit) =
1959+ object ["limit" .= object ["value" .= limit]]
1960+
1961+ toJSON (MissingFilter (FieldName fieldName) (Existence existence) (NullValue nullValue)) =
1962+ object ["missing" .=
1963+ object ["field" .= fieldName
1964+ , "existence" .= existence
1965+ , "null_value" .= nullValue]]
1966+
1967+ toJSON (PrefixFilter (FieldName fieldName) fieldValue cache) =
1968+ object ["prefix" .=
1969+ object [fieldName .= fieldValue
1970+ , "_cache" .= cache]]
1971+
1972+ toJSON (QueryFilter query False) =
1973+ object ["query" .= toJSON query ]
1974+ toJSON (QueryFilter query True) =
1975+ object ["fquery" .=
1976+ object [ "query" .= toJSON query
1977+ , "_cache" .= True ]]
1978+
1979+ toJSON (RangeFilter (FieldName fieldName) rangeValue rangeExecution cache) =
1980+ object ["range" .=
1981+ object [ fieldName .= object (rangeValueToPair rangeValue)
1982+ , "execution" .= rangeExecution
1983+ , "_cache" .= cache]]
1984+
1985+ toJSON (RegexpFilter (FieldName fieldName)
1986+ (Regexp regexText) flags (CacheName cacheName) cache (CacheKey cacheKey)) =
1987+ object ["regexp" .=
1988+ object [fieldName .=
1989+ object ["value" .= regexText
1990+ , "flags" .= flags]
1991+ , "_name" .= cacheName
1992+ , "_cache" .= cache
1993+ , "_cache_key" .= cacheKey]]
1994+
1995+instance FromJSON Filter where
1996+ parseJSON = withObject "Filter" parse
1997+ where parse o = andFilter `taggedWith` "and"
1998+ <|> orFilter `taggedWith` "or"
1999+ <|> notFilter `taggedWith` "not"
2000+ <|> identityFilter `taggedWith` "match_all"
2001+ <|> boolFilter `taggedWith` "bool"
2002+ <|> existsFilter `taggedWith` "exists"
2003+ <|> geoBoundingBoxFilter `taggedWith` "geo_bounding_box"
2004+ <|> geoDistanceFilter `taggedWith` "geo_distance"
2005+ <|> geoDistanceRangeFilter `taggedWith` "geo_distance_range"
2006+ <|> geoPolygonFilter `taggedWith` "geo_polygon"
2007+ <|> idsFilter `taggedWith` "ids"
2008+ <|> limitFilter `taggedWith` "limit"
2009+ <|> missingFilter `taggedWith` "missing"
2010+ <|> prefixFilter `taggedWith` "prefix"
2011+ <|> queryFilter `taggedWith` "query"
2012+ <|> fqueryFilter `taggedWith` "fquery"
2013+ <|> rangeFilter `taggedWith` "range"
2014+ <|> regexpFilter `taggedWith` "regexp"
2015+ <|> termFilter `taggedWith` "term"
2016+ where taggedWith parser k = parser =<< o .: k
2017+ andFilter o = AndFilter <$> o .: "filters"
2018+ <*> o .:? "_cache" .!= defaultCache
2019+ orFilter o = OrFilter <$> o .: "filters"
2020+ <*> o .:? "_cache" .!= defaultCache
2021+ notFilter o = NotFilter <$> o .: "filter"
2022+ <*> o .: "_cache" .!= defaultCache
2023+ identityFilter :: Object -> Parser Filter
2024+ identityFilter m
2025+ | HM.null m = pure IdentityFilter
2026+ | otherwise = fail ("Identityfilter expected empty object but got " <> show m)
2027+ boolFilter = pure . BoolFilter
2028+ existsFilter o = ExistsFilter <$> o .: "field"
2029+ geoBoundingBoxFilter = pure . GeoBoundingBoxFilter
2030+ geoDistanceFilter o = do
2031+ case HM.toList (deleteSeveral ["distance", "distance_type", "optimize_bbox", "_cache"] o) of
2032+ [(fn, v)] -> do
2033+ gp <- GeoPoint (FieldName fn) <$> parseJSON v
2034+ GeoDistanceFilter gp <$> o .: "distance"
2035+ <*> o .: "distance_type"
2036+ <*> o .: "optimize_bbox"
2037+ <*> o .:? "_cache" .!= defaultCache
2038+ _ -> fail "Could not find GeoDistanceFilter field name"
2039+ geoDistanceRangeFilter o = do
2040+ case HM.toList (deleteSeveral ["from", "to"] o) of
2041+ [(fn, v)] -> do
2042+ gp <- GeoPoint (FieldName fn) <$> parseJSON v
2043+ rng <- DistanceRange <$> o .: "from" <*> o .: "to"
2044+ return (GeoDistanceRangeFilter gp rng)
2045+ _ -> fail "Could not find GeoDistanceRangeFilter field name"
2046+ geoPolygonFilter = fieldTagged $ \fn o -> GeoPolygonFilter fn <$> o .: "points"
2047+ idsFilter o = IdsFilter <$> o .: "type"
2048+ <*> o .: "values"
2049+ limitFilter o = LimitFilter <$> o .: "value"
2050+ missingFilter o = MissingFilter <$> o .: "field"
2051+ <*> o .: "existence"
2052+ <*> o .: "null_value"
2053+ prefixFilter o = case HM.toList (HM.delete "_cache" o) of
2054+ [(fn, String v)] -> PrefixFilter (FieldName fn) v <$> o .:? "_cache" .!= defaultCache
2055+ _ -> fail "Could not parse PrefixFilter"
2056+
2057+ queryFilter q = pure (QueryFilter q False)
2058+ fqueryFilter o = QueryFilter <$> o .: "query" <*> pure True
2059+ rangeFilter o = case HM.toList (deleteSeveral ["execution", "_cache"] o) of
2060+ [(fn, v)] -> RangeFilter (FieldName fn)
2061+ <$> parseJSON v
2062+ <*> o .: "execution"
2063+ <*> o .:? "_cache" .!= defaultCache
2064+ _ -> fail "Could not find field name for RangeFilter"
2065+ regexpFilter o = case HM.toList (deleteSeveral ["_name", "_cache", "_cache_key"] o) of
2066+ [(fn, Object o')] -> RegexpFilter (FieldName fn)
2067+ <$> o' .: "value"
2068+ <*> o' .: "flags"
2069+ <*> o .: "_name"
2070+ <*> o .:? "_cache" .!= defaultCache
2071+ <*> o .: "_cache_key"
2072+ _ -> fail "Could not find field name for RegexpFilter"
2073+ termFilter o = case HM.toList (HM.delete "_cache" o) of
2074+ [(termField, String termVal)] -> TermFilter (Term termField termVal)
2075+ <$> o .:? "_cache" .!= defaultCache
2076+ _ -> fail "Could not find term field for TermFilter"
2077+
2078+fieldTagged :: Monad m => (FieldName -> Object -> m a) -> Object -> m a
2079+fieldTagged f o = case HM.toList o of
2080+ [(k, Object o')] -> f (FieldName k) o'
2081+ _ -> fail "Expected object with 1 field-named key"
2082+
2083+instance ToJSON GeoPoint where
2084+ toJSON (GeoPoint (FieldName geoPointField) geoPointLatLon) =
2085+ object [ geoPointField .= geoPointLatLon ]
2086+
2087+
2088+instance ToJSON Query where
2089+ toJSON (TermQuery (Term termQueryField termQueryValue) boost) =
2090+ object [ "term" .=
2091+ object [termQueryField .= object merged]]
2092+ where
2093+ base = [ "value" .= termQueryValue ]
2094+ boosted = maybe [] (return . ("boost" .=)) boost
2095+ merged = mappend base boosted
2096+
2097+ toJSON (TermsQuery fieldName terms) =
2098+ object [ "terms" .= object conjoined ]
2099+ where conjoined = [fieldName .= terms]
2100+
2101+ toJSON (IdsQuery idsQueryMappingName docIds) =
2102+ object [ "ids" .= object conjoined ]
2103+ where conjoined = [ "type" .= idsQueryMappingName
2104+ , "values" .= fmap toJSON docIds ]
2105+
2106+ toJSON (QueryQueryStringQuery qQueryStringQuery) =
2107+ object [ "query_string" .= qQueryStringQuery ]
2108+
2109+ toJSON (QueryMatchQuery matchQuery) =
2110+ object [ "match" .= matchQuery ]
2111+
2112+ toJSON (QueryMultiMatchQuery multiMatchQuery) =
2113+ toJSON multiMatchQuery
2114+
2115+ toJSON (QueryBoolQuery boolQuery) =
2116+ object [ "bool" .= boolQuery ]
2117+
2118+ toJSON (QueryBoostingQuery boostingQuery) =
2119+ object [ "boosting" .= boostingQuery ]
2120+
2121+ toJSON (QueryCommonTermsQuery commonTermsQuery) =
2122+ object [ "common" .= commonTermsQuery ]
2123+
2124+ toJSON (ConstantScoreFilter csFilter boost) =
2125+ object ["constant_score" .= object ["filter" .= csFilter
2126+ , "boost" .= boost]]
2127+
2128+ toJSON (ConstantScoreQuery query boost) =
2129+ object ["constant_score" .= object ["query" .= query
2130+ , "boost" .= boost]]
2131+
2132+ toJSON (QueryDisMaxQuery disMaxQuery) =
2133+ object [ "dis_max" .= disMaxQuery ]
2134+
2135+ toJSON (QueryFilteredQuery qFilteredQuery) =
2136+ object [ "filtered" .= qFilteredQuery ]
2137+
2138+ toJSON (QueryFuzzyLikeThisQuery fuzzyQuery) =
2139+ object [ "fuzzy_like_this" .= fuzzyQuery ]
2140+
2141+ toJSON (QueryFuzzyLikeFieldQuery fuzzyFieldQuery) =
2142+ object [ "fuzzy_like_this_field" .= fuzzyFieldQuery ]
2143+
2144+ toJSON (QueryFuzzyQuery fuzzyQuery) =
2145+ object [ "fuzzy" .= fuzzyQuery ]
2146+
2147+ toJSON (QueryHasChildQuery childQuery) =
2148+ object [ "has_child" .= childQuery ]
2149+
2150+ toJSON (QueryHasParentQuery parentQuery) =
2151+ object [ "has_parent" .= parentQuery ]
2152+
2153+ toJSON (QueryIndicesQuery qIndicesQuery) =
2154+ object [ "indices" .= qIndicesQuery ]
2155+
2156+ toJSON (MatchAllQuery boost) =
2157+ object [ "match_all" .= omitNulls [ "boost" .= boost ] ]
2158+
2159+ toJSON (QueryMoreLikeThisQuery query) =
2160+ object [ "more_like_this" .= query ]
2161+
2162+ toJSON (QueryMoreLikeThisFieldQuery query) =
2163+ object [ "more_like_this_field" .= query ]
2164+
2165+ toJSON (QueryNestedQuery query) =
2166+ object [ "nested" .= query ]
2167+
2168+ toJSON (QueryPrefixQuery query) =
2169+ object [ "prefix" .= query ]
2170+
2171+ toJSON (QueryRangeQuery query) =
2172+ object [ "range" .= query ]
2173+
2174+ toJSON (QueryRegexpQuery query) =
2175+ object [ "regexp" .= query ]
2176+
2177+ toJSON (QuerySimpleQueryStringQuery query) =
2178+ object [ "simple_query_string" .= query ]
2179+
2180+instance FromJSON Query where
2181+ parseJSON v = withObject "Query" parse v
2182+ where parse o = termQuery `taggedWith` "term"
2183+ <|> termsQuery `taggedWith` "terms"
2184+ <|> idsQuery `taggedWith` "ids"
2185+ <|> queryQueryStringQuery `taggedWith` "query_string"
2186+ <|> queryMatchQuery `taggedWith` "match"
2187+ <|> queryMultiMatchQuery
2188+ <|> queryBoolQuery `taggedWith` "bool"
2189+ <|> queryBoostingQuery `taggedWith` "boosting"
2190+ <|> queryCommonTermsQuery `taggedWith` "common"
2191+ <|> constantScoreFilter `taggedWith` "constant_score"
2192+ <|> constantScoreQuery `taggedWith` "constant_score"
2193+ <|> queryDisMaxQuery `taggedWith` "dis_max"
2194+ <|> queryFilteredQuery `taggedWith` "filtered"
2195+ <|> queryFuzzyLikeThisQuery `taggedWith` "fuzzy_like_this"
2196+ <|> queryFuzzyLikeFieldQuery `taggedWith` "fuzzy_like_this_field"
2197+ <|> queryFuzzyQuery `taggedWith` "fuzzy"
2198+ <|> queryHasChildQuery `taggedWith` "has_child"
2199+ <|> queryHasParentQuery `taggedWith` "has_parent"
2200+ <|> queryIndicesQuery `taggedWith` "indices"
2201+ <|> matchAllQuery `taggedWith` "match_all"
2202+ <|> queryMoreLikeThisQuery `taggedWith` "more_like_this"
2203+ <|> queryMoreLikeThisFieldQuery `taggedWith` "more_like_this_field"
2204+ <|> queryNestedQuery `taggedWith` "nested"
2205+ <|> queryPrefixQuery `taggedWith` "prefix"
2206+ <|> queryRangeQuery `taggedWith` "range"
2207+ <|> queryRegexpQuery `taggedWith` "regexp"
2208+ <|> querySimpleQueryStringQuery `taggedWith` "simple_query_string"
2209+ where taggedWith parser k = parser =<< o .: k
2210+ termQuery = fieldTagged $ \(FieldName fn) o ->
2211+ TermQuery <$> (Term fn <$> o .: "value") <*> o .:? "boost"
2212+ termsQuery o = case HM.toList o of
2213+ [(fn, vs)] -> do vals <- parseJSON vs
2214+ case vals of
2215+ x:xs -> return (TermsQuery fn (x :| xs))
2216+ _ -> fail "Expected non empty list of values"
2217+ _ -> fail "Expected object with 1 field-named key"
2218+ idsQuery o = IdsQuery <$> o .: "type"
2219+ <*> o .: "values"
2220+ queryQueryStringQuery = pure . QueryQueryStringQuery
2221+ queryMatchQuery = pure . QueryMatchQuery
2222+ queryMultiMatchQuery = QueryMultiMatchQuery <$> parseJSON v
2223+ queryBoolQuery = pure . QueryBoolQuery
2224+ queryBoostingQuery = pure . QueryBoostingQuery
2225+ queryCommonTermsQuery = pure . QueryCommonTermsQuery
2226+ constantScoreFilter o = case HM.lookup "filter" o of
2227+ Just x -> ConstantScoreFilter <$> parseJSON x
2228+ <*> o .: "boost"
2229+ _ -> fail "Does not appear to be a ConstantScoreFilter"
2230+ constantScoreQuery o = case HM.lookup "query" o of
2231+ Just x -> ConstantScoreQuery <$> parseJSON x
2232+ <*> o .: "boost"
2233+ _ -> fail "Does not appear to be a ConstantScoreQuery"
2234+ queryDisMaxQuery = pure . QueryDisMaxQuery
2235+ queryFilteredQuery = pure . QueryFilteredQuery
2236+ queryFuzzyLikeThisQuery = pure . QueryFuzzyLikeThisQuery
2237+ queryFuzzyLikeFieldQuery = pure . QueryFuzzyLikeFieldQuery
2238+ queryFuzzyQuery = pure . QueryFuzzyQuery
2239+ queryHasChildQuery = pure . QueryHasChildQuery
2240+ queryHasParentQuery = pure . QueryHasParentQuery
2241+ queryIndicesQuery = pure . QueryIndicesQuery
2242+ matchAllQuery o = MatchAllQuery <$> o .:? "boost"
2243+ queryMoreLikeThisQuery = pure . QueryMoreLikeThisQuery
2244+ queryMoreLikeThisFieldQuery = pure . QueryMoreLikeThisFieldQuery
2245+ queryNestedQuery = pure . QueryNestedQuery
2246+ queryPrefixQuery = pure . QueryPrefixQuery
2247+ queryRangeQuery = pure . QueryRangeQuery
2248+ queryRegexpQuery = pure . QueryRegexpQuery
2249+ querySimpleQueryStringQuery = pure . QuerySimpleQueryStringQuery
2250+
2251+
2252+omitNulls :: [(Text, Value)] -> Value
2253+omitNulls = object . filter notNull where
2254+ notNull (_, Null) = False
2255+ notNull (_, Array a) = (not . V.null) a
2256+ notNull _ = True
2257+
2258+
2259+instance ToJSON SimpleQueryStringQuery where
2260+ toJSON SimpleQueryStringQuery {..} =
2261+ omitNulls (base ++ maybeAdd)
2262+ where base = [ "query" .= simpleQueryStringQuery ]
2263+ maybeAdd = [ "fields" .= simpleQueryStringField
2264+ , "default_operator" .= simpleQueryStringOperator
2265+ , "analyzer" .= simpleQueryStringAnalyzer
2266+ , "flags" .= simpleQueryStringFlags
2267+ , "lowercase_expanded_terms" .= simpleQueryStringLowercaseExpanded
2268+ , "locale" .= simpleQueryStringLocale ]
2269+
2270+instance FromJSON SimpleQueryStringQuery where
2271+ parseJSON = withObject "SimpleQueryStringQuery" parse
2272+ where parse o = SimpleQueryStringQuery <$> o .: "query"
2273+ <*> o .:? "fields"
2274+ <*> o .:? "default_operator"
2275+ <*> o .:? "analyzer"
2276+ <*> (parseFlags <$> o .:? "flags")
2277+ <*> o .:? "lowercase_expanded_terms"
2278+ <*> o .:? "locale"
2279+ parseFlags (Just (x:xs)) = Just (x :| xs)
2280+ parseFlags _ = Nothing
2281+
2282+instance ToJSON FieldOrFields where
2283+ toJSON (FofField fieldName) =
2284+ toJSON fieldName
2285+ toJSON (FofFields fieldNames) =
2286+ toJSON fieldNames
2287+
2288+instance FromJSON FieldOrFields where
2289+ parseJSON v = FofField <$> parseJSON v
2290+ <|> FofFields <$> (parseNEJSON =<< parseJSON v)
2291+
2292+instance ToJSON SimpleQueryFlag where
2293+ toJSON SimpleQueryAll = "ALL"
2294+ toJSON SimpleQueryNone = "NONE"
2295+ toJSON SimpleQueryAnd = "AND"
2296+ toJSON SimpleQueryOr = "OR"
2297+ toJSON SimpleQueryPrefix = "PREFIX"
2298+ toJSON SimpleQueryPhrase = "PHRASE"
2299+ toJSON SimpleQueryPrecedence = "PRECEDENCE"
2300+ toJSON SimpleQueryEscape = "ESCAPE"
2301+ toJSON SimpleQueryWhitespace = "WHITESPACE"
2302+ toJSON SimpleQueryFuzzy = "FUZZY"
2303+ toJSON SimpleQueryNear = "NEAR"
2304+ toJSON SimpleQuerySlop = "SLOP"
2305+
2306+instance FromJSON SimpleQueryFlag where
2307+ parseJSON = withText "SimpleQueryFlag" parse
2308+ where parse "ALL" = pure SimpleQueryAll
2309+ parse "NONE" = pure SimpleQueryNone
2310+ parse "AND" = pure SimpleQueryAnd
2311+ parse "OR" = pure SimpleQueryOr
2312+ parse "PREFIX" = pure SimpleQueryPrefix
2313+ parse "PHRASE" = pure SimpleQueryPhrase
2314+ parse "PRECEDENCE" = pure SimpleQueryPrecedence
2315+ parse "ESCAPE" = pure SimpleQueryEscape
2316+ parse "WHITESPACE" = pure SimpleQueryWhitespace
2317+ parse "FUZZY" = pure SimpleQueryFuzzy
2318+ parse "NEAR" = pure SimpleQueryNear
2319+ parse "SLOP" = pure SimpleQuerySlop
2320+ parse f = fail ("Unexpected SimpleQueryFlag: " <> show f)
2321+
2322+instance ToJSON RegexpQuery where
2323+ toJSON (RegexpQuery (FieldName rqQueryField)
2324+ (Regexp regexpQueryQuery) rqQueryFlags
2325+ rqQueryBoost) =
2326+ object [ rqQueryField .= omitNulls base ]
2327+ where base = [ "value" .= regexpQueryQuery
2328+ , "flags" .= rqQueryFlags
2329+ , "boost" .= rqQueryBoost ]
2330+
2331+instance FromJSON RegexpQuery where
2332+ parseJSON = withObject "RegexpQuery" parse
2333+ where parse = fieldTagged $ \fn o ->
2334+ RegexpQuery fn
2335+ <$> o .: "value"
2336+ <*> o .: "flags"
2337+ <*> o .:? "boost"
2338+
2339+instance ToJSON QueryStringQuery where
2340+ toJSON (QueryStringQuery qsQueryString
2341+ qsDefaultField qsOperator
2342+ qsAnalyzer qsAllowWildcard
2343+ qsLowercaseExpanded qsEnablePositionIncrements
2344+ qsFuzzyMaxExpansions qsFuzziness
2345+ qsFuzzyPrefixLength qsPhraseSlop
2346+ qsBoost qsAnalyzeWildcard
2347+ qsGeneratePhraseQueries qsMinimumShouldMatch
2348+ qsLenient qsLocale) =
2349+ omitNulls base
2350+ where
2351+ base = [ "query" .= qsQueryString
2352+ , "default_field" .= qsDefaultField
2353+ , "default_operator" .= qsOperator
2354+ , "analyzer" .= qsAnalyzer
2355+ , "allow_leading_wildcard" .= qsAllowWildcard
2356+ , "lowercase_expanded_terms" .= qsLowercaseExpanded
2357+ , "enable_position_increments" .= qsEnablePositionIncrements
2358+ , "fuzzy_max_expansions" .= qsFuzzyMaxExpansions
2359+ , "fuzziness" .= qsFuzziness
2360+ , "fuzzy_prefix_length" .= qsFuzzyPrefixLength
2361+ , "phrase_slop" .= qsPhraseSlop
2362+ , "boost" .= qsBoost
2363+ , "analyze_wildcard" .= qsAnalyzeWildcard
2364+ , "auto_generate_phrase_queries" .= qsGeneratePhraseQueries
2365+ , "minimum_should_match" .= qsMinimumShouldMatch
2366+ , "lenient" .= qsLenient
2367+ , "locale" .= qsLocale ]
2368+
2369+instance FromJSON QueryStringQuery where
2370+ parseJSON = withObject "QueryStringQuery" parse
2371+ where parse o = QueryStringQuery
2372+ <$> o .: "query"
2373+ <*> o .:? "default_field"
2374+ <*> o .:? "default_operator"
2375+ <*> o .:? "analyzer"
2376+ <*> o .:? "allow_leading_wildcard"
2377+ <*> o .:? "lowercase_expanded_terms"
2378+ <*> o .:? "enable_position_increments"
2379+ <*> o .:? "fuzzy_max_expansions"
2380+ <*> o .:? "fuzziness"
2381+ <*> o .:? "fuzzy_prefix_length"
2382+ <*> o .:? "phrase_slop"
2383+ <*> o .:? "boost"
2384+ <*> o .:? "analyze_wildcard"
2385+ <*> o .:? "auto_generate_phrase_queries"
2386+ <*> o .:? "minimum_should_match"
2387+ <*> o .:? "lenient"
2388+ <*> o .:? "locale"
2389+
2390+instance ToJSON RangeQuery where
2391+ toJSON (RangeQuery (FieldName fieldName) range boost) =
2392+ object [ fieldName .= object conjoined ]
2393+ where conjoined = [ "boost" .= boost ] ++ (rangeValueToPair range)
2394+
2395+instance FromJSON RangeQuery where
2396+ parseJSON = withObject "RangeQuery" parse
2397+ where parse = fieldTagged $ \fn o ->
2398+ RangeQuery fn
2399+ <$> parseJSON (Object o)
2400+ <*> o .: "boost"
2401+
2402+instance FromJSON RangeValue where
2403+ parseJSON = withObject "RangeValue" parse
2404+ where parse o = parseDate o
2405+ <|> parseDouble o
2406+ parseDate o = do lt <- o .:? "lt"
2407+ lte <- o .:? "lte"
2408+ gt <- o .:? "gt"
2409+ gte <- o .:? "gte"
2410+ case (lt, lte, gt, gte) of
2411+ (Just a, _, Just b, _) -> return (RangeDateGtLt (GreaterThanD b) (LessThanD a))
2412+ (Just a, _, _, Just b)-> return (RangeDateGteLt (GreaterThanEqD b) (LessThanD a))
2413+ (_, Just a, Just b, _)-> return (RangeDateGtLte (GreaterThanD b) (LessThanEqD a))
2414+ (_, Just a, _, Just b)-> return (RangeDateGteLte (GreaterThanEqD b) (LessThanEqD a))
2415+ (_, _, Just a, _)-> return (RangeDateGt (GreaterThanD a))
2416+ (Just a, _, _, _)-> return (RangeDateLt (LessThanD a))
2417+ (_, _, _, Just a)-> return (RangeDateGte (GreaterThanEqD a))
2418+ (_, Just a, _, _)-> return (RangeDateLte (LessThanEqD a))
2419+ (Nothing, Nothing, Nothing, Nothing) -> mzero
2420+ parseDouble o = do lt <- o .:? "lt"
2421+ lte <- o .:? "lte"
2422+ gt <- o .:? "gt"
2423+ gte <- o .:? "gte"
2424+ case (lt, lte, gt, gte) of
2425+ (Just a, _, Just b, _) -> return (RangeDoubleGtLt (GreaterThan b) (LessThan a))
2426+ (Just a, _, _, Just b)-> return (RangeDoubleGteLt (GreaterThanEq b) (LessThan a))
2427+ (_, Just a, Just b, _)-> return (RangeDoubleGtLte (GreaterThan b) (LessThanEq a))
2428+ (_, Just a, _, Just b)-> return (RangeDoubleGteLte (GreaterThanEq b) (LessThanEq a))
2429+ (_, _, Just a, _)-> return (RangeDoubleGt (GreaterThan a))
2430+ (Just a, _, _, _)-> return (RangeDoubleLt (LessThan a))
2431+ (_, _, _, Just a)-> return (RangeDoubleGte (GreaterThanEq a))
2432+ (_, Just a, _, _)-> return (RangeDoubleLte (LessThanEq a))
2433+ (Nothing, Nothing, Nothing, Nothing) -> mzero
2434+
2435+instance ToJSON PrefixQuery where
2436+ toJSON (PrefixQuery (FieldName fieldName) queryValue boost) =
2437+ object [ fieldName .= omitNulls base ]
2438+ where base = [ "value" .= queryValue
2439+ , "boost" .= boost ]
2440+
2441+instance FromJSON PrefixQuery where
2442+ parseJSON = withObject "PrefixQuery" parse
2443+ where parse = fieldTagged $ \fn o ->
2444+ PrefixQuery fn
2445+ <$> o .: "value"
2446+ <*> o .:? "boost"
2447+
2448+instance ToJSON NestedQuery where
2449+ toJSON (NestedQuery nqPath nqScoreType nqQuery) =
2450+ object [ "path" .= nqPath
2451+ , "score_mode" .= nqScoreType
2452+ , "query" .= nqQuery ]
2453+
2454+instance FromJSON NestedQuery where
2455+ parseJSON = withObject "NestedQuery" parse
2456+ where parse o = NestedQuery
2457+ <$> o .: "path"
2458+ <*> o .: "score_mode"
2459+ <*> o .: "query"
2460+
2461+instance ToJSON MoreLikeThisFieldQuery where
2462+ toJSON (MoreLikeThisFieldQuery text (FieldName fieldName)
2463+ percent mtf mqt stopwords mindf maxdf
2464+ minwl maxwl boostTerms boost analyzer) =
2465+ object [ fieldName .= omitNulls base ]
2466+ where base = [ "like_text" .= text
2467+ , "percent_terms_to_match" .= percent
2468+ , "min_term_freq" .= mtf
2469+ , "max_query_terms" .= mqt
2470+ , "stop_words" .= stopwords
2471+ , "min_doc_freq" .= mindf
2472+ , "max_doc_freq" .= maxdf
2473+ , "min_word_length" .= minwl
2474+ , "max_word_length" .= maxwl
2475+ , "boost_terms" .= boostTerms
2476+ , "boost" .= boost
2477+ , "analyzer" .= analyzer ]
2478+
2479+instance FromJSON MoreLikeThisFieldQuery where
2480+ parseJSON = withObject "MoreLikeThisFieldQuery" parse
2481+ where parse = fieldTagged $ \fn o ->
2482+ MoreLikeThisFieldQuery
2483+ <$> o .: "like_text"
2484+ <*> pure fn
2485+ <*> o .:? "percent_terms_to_match"
2486+ <*> o .:? "min_term_freq"
2487+ <*> o .:? "max_query_terms"
2488+ -- <*> (optionalNE =<< o .:? "stop_words")
2489+ <*> o .:? "stop_words"
2490+ <*> o .:? "min_doc_freq"
2491+ <*> o .:? "max_doc_freq"
2492+ <*> o .:? "min_word_length"
2493+ <*> o .:? "max_word_length"
2494+ <*> o .:? "boost_terms"
2495+ <*> o .:? "boost"
2496+ <*> o .:? "analyzer"
2497+ -- optionalNE = maybe (pure Nothing) (fmap Just . parseNEJSON)
2498+
2499+instance ToJSON MoreLikeThisQuery where
2500+ toJSON (MoreLikeThisQuery text fields percent
2501+ mtf mqt stopwords mindf maxdf
2502+ minwl maxwl boostTerms boost analyzer) =
2503+ omitNulls base
2504+ where base = [ "like_text" .= text
2505+ , "fields" .= fields
2506+ , "percent_terms_to_match" .= percent
2507+ , "min_term_freq" .= mtf
2508+ , "max_query_terms" .= mqt
2509+ , "stop_words" .= stopwords
2510+ , "min_doc_freq" .= mindf
2511+ , "max_doc_freq" .= maxdf
2512+ , "min_word_length" .= minwl
2513+ , "max_word_length" .= maxwl
2514+ , "boost_terms" .= boostTerms
2515+ , "boost" .= boost
2516+ , "analyzer" .= analyzer ]
2517+
2518+instance FromJSON MoreLikeThisQuery where
2519+ parseJSON = withObject "MoreLikeThisQuery" parse
2520+ where parse o = MoreLikeThisQuery
2521+ <$> o .: "like_text"
2522+ -- <*> (optionalNE =<< o .:? "fields")
2523+ <*> o .:? "fields"
2524+ <*> o .:? "percent_terms_to_match"
2525+ <*> o .:? "min_term_freq"
2526+ <*> o .:? "max_query_terms"
2527+ -- <*> (optionalNE =<< o .:? "stop_words")
2528+ <*> o .:? "stop_words"
2529+ <*> o .:? "min_doc_freq"
2530+ <*> o .:? "max_doc_freq"
2531+ <*> o .:? "min_word_length"
2532+ <*> o .:? "max_word_length"
2533+ <*> o .:? "boost_terms"
2534+ <*> o .:? "boost"
2535+ <*> o .:? "analyzer"
2536+ -- optionalNE = maybe (pure Nothing) (fmap Just . parseNEJSON)
2537+
2538+instance ToJSON IndicesQuery where
2539+ toJSON (IndicesQuery indices query noMatch) =
2540+ omitNulls [ "indices" .= indices
2541+ , "no_match_query" .= noMatch
2542+ , "query" .= query ]
2543+
2544+instance FromJSON IndicesQuery where
2545+ parseJSON = withObject "IndicesQuery" parse
2546+ where parse o = IndicesQuery
2547+ <$> o .:? "indices" .!= []
2548+ <*> o .: "query"
2549+ <*> o .:? "no_match_query"
2550+
2551+instance ToJSON HasParentQuery where
2552+ toJSON (HasParentQuery queryType query scoreType) =
2553+ omitNulls [ "parent_type" .= queryType
2554+ , "score_type" .= scoreType
2555+ , "query" .= query ]
2556+
2557+instance FromJSON HasParentQuery where
2558+ parseJSON = withObject "HasParentQuery" parse
2559+ where parse o = HasParentQuery
2560+ <$> o .: "parent_type"
2561+ <*> o .: "query"
2562+ <*> o .:? "score_type"
2563+
2564+instance ToJSON HasChildQuery where
2565+ toJSON (HasChildQuery queryType query scoreType) =
2566+ omitNulls [ "query" .= query
2567+ , "score_type" .= scoreType
2568+ , "type" .= queryType ]
2569+
2570+instance FromJSON HasChildQuery where
2571+ parseJSON = withObject "HasChildQuery" parse
2572+ where parse o = HasChildQuery
2573+ <$> o .: "type"
2574+ <*> o .: "query"
2575+ <*> o .:? "score_type"
2576+
2577+instance ToJSON FuzzyQuery where
2578+ toJSON (FuzzyQuery (FieldName fieldName) queryText
2579+ prefixLength maxEx fuzziness boost) =
2580+ object [ fieldName .= omitNulls base ]
2581+ where base = [ "value" .= queryText
2582+ , "fuzziness" .= fuzziness
2583+ , "prefix_length" .= prefixLength
2584+ , "boost" .= boost
2585+ , "max_expansions" .= maxEx ]
2586+
2587+instance FromJSON FuzzyQuery where
2588+ parseJSON = withObject "FuzzyQuery" parse
2589+ where parse = fieldTagged $ \fn o ->
2590+ FuzzyQuery fn
2591+ <$> o .: "value"
2592+ <*> o .: "prefix_length"
2593+ <*> o .: "max_expansions"
2594+ <*> o .: "fuzziness"
2595+ <*> o .:? "boost"
2596+
2597+instance ToJSON FuzzyLikeFieldQuery where
2598+ toJSON (FuzzyLikeFieldQuery (FieldName fieldName)
2599+ fieldText maxTerms ignoreFreq fuzziness prefixLength
2600+ boost analyzer) =
2601+ object [ fieldName .=
2602+ omitNulls [ "like_text" .= fieldText
2603+ , "max_query_terms" .= maxTerms
2604+ , "ignore_tf" .= ignoreFreq
2605+ , "fuzziness" .= fuzziness
2606+ , "prefix_length" .= prefixLength
2607+ , "analyzer" .= analyzer
2608+ , "boost" .= boost ]]
2609+
2610+instance FromJSON FuzzyLikeFieldQuery where
2611+ parseJSON = withObject "FuzzyLikeFieldQuery" parse
2612+ where parse = fieldTagged $ \fn o ->
2613+ FuzzyLikeFieldQuery fn
2614+ <$> o .: "like_text"
2615+ <*> o .: "max_query_terms"
2616+ <*> o .: "ignore_tf"
2617+ <*> o .: "fuzziness"
2618+ <*> o .: "prefix_length"
2619+ <*> o .: "boost"
2620+ <*> o .:? "analyzer"
2621+
2622+instance ToJSON FuzzyLikeThisQuery where
2623+ toJSON (FuzzyLikeThisQuery fields text maxTerms
2624+ ignoreFreq fuzziness prefixLength boost analyzer) =
2625+ omitNulls base
2626+ where base = [ "fields" .= fields
2627+ , "like_text" .= text
2628+ , "max_query_terms" .= maxTerms
2629+ , "ignore_tf" .= ignoreFreq
2630+ , "fuzziness" .= fuzziness
2631+ , "prefix_length" .= prefixLength
2632+ , "analyzer" .= analyzer
2633+ , "boost" .= boost ]
2634+
2635+instance FromJSON FuzzyLikeThisQuery where
2636+ parseJSON = withObject "FuzzyLikeThisQuery" parse
2637+ where parse o = FuzzyLikeThisQuery
2638+ <$> o .:? "fields" .!= []
2639+ <*> o .: "like_text"
2640+ <*> o .: "max_query_terms"
2641+ <*> o .: "ignore_tf"
2642+ <*> o .: "fuzziness"
2643+ <*> o .: "prefix_length"
2644+ <*> o .: "boost"
2645+ <*> o .:? "analyzer"
2646+
2647+instance ToJSON FilteredQuery where
2648+ toJSON (FilteredQuery query fFilter) =
2649+ object [ "query" .= query
2650+ , "filter" .= fFilter ]
2651+
2652+instance FromJSON FilteredQuery where
2653+ parseJSON = withObject "FilteredQuery" parse
2654+ where parse o = FilteredQuery
2655+ <$> o .: "query"
2656+ <*> o .: "filter"
2657+
2658+instance ToJSON DisMaxQuery where
2659+ toJSON (DisMaxQuery queries tiebreaker boost) =
2660+ omitNulls base
2661+ where base = [ "queries" .= queries
2662+ , "boost" .= boost
2663+ , "tie_breaker" .= tiebreaker ]
2664+
2665+instance FromJSON DisMaxQuery where
2666+ parseJSON = withObject "DisMaxQuery" parse
2667+ where parse o = DisMaxQuery
2668+ <$> o .:? "queries" .!= []
2669+ <*> o .: "tie_breaker"
2670+ <*> o .:? "boost"
2671+
2672+instance ToJSON CommonTermsQuery where
2673+ toJSON (CommonTermsQuery (FieldName fieldName)
2674+ (QueryString query) cf lfo hfo msm
2675+ boost analyzer disableCoord) =
2676+ object [fieldName .= omitNulls base ]
2677+ where base = [ "query" .= query
2678+ , "cutoff_frequency" .= cf
2679+ , "low_freq_operator" .= lfo
2680+ , "minimum_should_match" .= msm
2681+ , "boost" .= boost
2682+ , "analyzer" .= analyzer
2683+ , "disable_coord" .= disableCoord
2684+ , "high_freq_operator" .= hfo ]
2685+
2686+instance FromJSON CommonTermsQuery where
2687+ parseJSON = withObject "CommonTermsQuery" parse
2688+ where parse = fieldTagged $ \fn o ->
2689+ CommonTermsQuery fn
2690+ <$> o .: "query"
2691+ <*> o .: "cutoff_frequency"
2692+ <*> o .: "low_freq_operator"
2693+ <*> o .: "high_freq_operator"
2694+ <*> o .:? "minimum_should_match"
2695+ <*> o .:? "boost"
2696+ <*> o .:? "analyzer"
2697+ <*> o .:? "disable_coord"
2698+
2699+instance ToJSON CommonMinimumMatch where
2700+ toJSON (CommonMinimumMatch mm) = toJSON mm
2701+ toJSON (CommonMinimumMatchHighLow (MinimumMatchHighLow lowF highF)) =
2702+ object [ "low_freq" .= lowF
2703+ , "high_freq" .= highF ]
2704+
2705+instance FromJSON CommonMinimumMatch where
2706+ parseJSON v = parseMinimum v
2707+ <|> parseMinimumHighLow v
2708+ where parseMinimum = fmap CommonMinimumMatch . parseJSON
2709+ parseMinimumHighLow = fmap CommonMinimumMatchHighLow . withObject "CommonMinimumMatchHighLow" (\o ->
2710+ MinimumMatchHighLow
2711+ <$> o .: "low_freq"
2712+ <*> o .: "high_freq")
2713+
2714+
2715+instance ToJSON BoostingQuery where
2716+ toJSON (BoostingQuery bqPositiveQuery bqNegativeQuery bqNegativeBoost) =
2717+ object [ "positive" .= bqPositiveQuery
2718+ , "negative" .= bqNegativeQuery
2719+ , "negative_boost" .= bqNegativeBoost ]
2720+
2721+instance FromJSON BoostingQuery where
2722+ parseJSON = withObject "BoostingQuery" parse
2723+ where parse o = BoostingQuery
2724+ <$> o .: "positive"
2725+ <*> o .: "negative"
2726+ <*> o .: "negative_boost"
2727+
2728+instance ToJSON BoolQuery where
2729+ toJSON (BoolQuery mustM notM shouldM bqMin boost disableCoord) =
2730+ omitNulls base
2731+ where base = [ "must" .= mustM
2732+ , "must_not" .= notM
2733+ , "should" .= shouldM
2734+ , "minimum_should_match" .= bqMin
2735+ , "boost" .= boost
2736+ , "disable_coord" .= disableCoord ]
2737+
2738+instance FromJSON BoolQuery where
2739+ parseJSON = withObject "BoolQuery" parse
2740+ where parse o = BoolQuery
2741+ <$> o .:? "must" .!= []
2742+ <*> o .:? "must_not" .!= []
2743+ <*> o .:? "should" .!= []
2744+ <*> o .:? "minimum_should_match"
2745+ <*> o .:? "boost"
2746+ <*> o .:? "disable_coord"
2747+
2748+instance ToJSON MatchQuery where
2749+ toJSON (MatchQuery (FieldName fieldName)
2750+ (QueryString mqQueryString) booleanOperator
2751+ zeroTermsQuery cutoffFrequency matchQueryType
2752+ analyzer maxExpansions lenient boost) =
2753+ object [ fieldName .= omitNulls base ]
2754+ where base = [ "query" .= mqQueryString
2755+ , "operator" .= booleanOperator
2756+ , "zero_terms_query" .= zeroTermsQuery
2757+ , "cutoff_frequency" .= cutoffFrequency
2758+ , "type" .= matchQueryType
2759+ , "analyzer" .= analyzer
2760+ , "max_expansions" .= maxExpansions
2761+ , "lenient" .= lenient
2762+ , "boost" .= boost ]
2763+
2764+instance FromJSON MatchQuery where
2765+ parseJSON = withObject "MatchQuery" parse
2766+ where parse = fieldTagged $ \fn o ->
2767+ MatchQuery fn
2768+ <$> o .: "query"
2769+ <*> o .: "operator"
2770+ <*> o .: "zero_terms_query"
2771+ <*> o .:? "cutoff_frequency"
2772+ <*> o .:? "type"
2773+ <*> o .:? "analyzer"
2774+ <*> o .:? "max_expansions"
2775+ <*> o .:? "lenient"
2776+ <*> o .:? "boost"
2777+
2778+instance ToJSON MultiMatchQuery where
2779+ toJSON (MultiMatchQuery fields (QueryString query) boolOp
2780+ ztQ tb mmqt cf analyzer maxEx lenient) =
2781+ object ["multi_match" .= omitNulls base]
2782+ where base = [ "fields" .= fmap toJSON fields
2783+ , "query" .= query
2784+ , "operator" .= boolOp
2785+ , "zero_terms_query" .= ztQ
2786+ , "tiebreaker" .= tb
2787+ , "type" .= mmqt
2788+ , "cutoff_frequency" .= cf
2789+ , "analyzer" .= analyzer
2790+ , "max_expansions" .= maxEx
2791+ , "lenient" .= lenient ]
2792+
2793+instance FromJSON MultiMatchQuery where
2794+ parseJSON = withObject "MultiMatchQuery" parse
2795+ where parse raw = do o <- raw .: "multi_match"
2796+ MultiMatchQuery
2797+ <$> o .:? "fields" .!= []
2798+ <*> o .: "query"
2799+ <*> o .: "operator"
2800+ <*> o .: "zero_terms_query"
2801+ <*> o .:? "tiebreaker"
2802+ <*> o .:? "type"
2803+ <*> o .:? "cutoff_frequency"
2804+ <*> o .:? "analyzer"
2805+ <*> o .:? "max_expansions"
2806+ <*> o .:? "lenient"
2807+
2808+instance ToJSON MultiMatchQueryType where
2809+ toJSON MultiMatchBestFields = "best_fields"
2810+ toJSON MultiMatchMostFields = "most_fields"
2811+ toJSON MultiMatchCrossFields = "cross_fields"
2812+ toJSON MultiMatchPhrase = "phrase"
2813+ toJSON MultiMatchPhrasePrefix = "phrase_prefix"
2814+
2815+instance FromJSON MultiMatchQueryType where
2816+ parseJSON = withText "MultiMatchPhrasePrefix" parse
2817+ where parse "best_fields" = pure MultiMatchBestFields
2818+ parse "most_fields" = pure MultiMatchMostFields
2819+ parse "cross_fields" = pure MultiMatchCrossFields
2820+ parse "phrase" = pure MultiMatchPhrase
2821+ parse "phrase_prefix" = pure MultiMatchPhrasePrefix
2822+ parse t = fail ("Unexpected MultiMatchPhrasePrefix: " <> show t)
2823+
2824+instance ToJSON BooleanOperator where
2825+ toJSON And = String "and"
2826+ toJSON Or = String "or"
2827+
2828+instance FromJSON BooleanOperator where
2829+ parseJSON = withText "BooleanOperator" parse
2830+ where parse "and" = pure And
2831+ parse "or" = pure Or
2832+ parse o = fail ("Unexpected BooleanOperator: " <> show o)
2833+
2834+instance ToJSON ZeroTermsQuery where
2835+ toJSON ZeroTermsNone = String "none"
2836+ toJSON ZeroTermsAll = String "all"
2837+
2838+instance FromJSON ZeroTermsQuery where
2839+ parseJSON = withText "ZeroTermsQuery" parse
2840+ where parse "none" = pure ZeroTermsNone
2841+ parse "all" = pure ZeroTermsAll
2842+ parse q = fail ("Unexpected ZeroTermsQuery: " <> show q)
2843+
2844+instance ToJSON MatchQueryType where
2845+ toJSON MatchPhrase = "phrase"
2846+ toJSON MatchPhrasePrefix = "phrase_prefix"
2847+
2848+instance FromJSON MatchQueryType where
2849+ parseJSON = withText "MatchQueryType" parse
2850+ where parse "phrase" = pure MatchPhrase
2851+ parse "phrase_prefix" = pure MatchPhrasePrefix
2852+ parse t = fail ("Unexpected MatchQueryType: " <> show t)
2853+
2854+instance FromJSON Status where
2855+ parseJSON (Object v) = Status <$>
2856+ v .:? "ok" <*>
2857+ v .: "status" <*>
2858+ v .: "name" <*>
2859+ v .: "version" <*>
2860+ v .: "tagline"
2861+ parseJSON _ = empty
2862+
2863+
2864+instance ToJSON IndexSettings where
2865+ toJSON (IndexSettings s r) = object ["settings" .=
2866+ object ["index" .=
2867+ object ["number_of_shards" .= s, "number_of_replicas" .= r]
2868+ ]
2869+ ]
2870+
2871+instance FromJSON IndexSettings where
2872+ parseJSON = withObject "IndexSettings" parse
2873+ where parse o = do s <- o .: "settings"
2874+ i <- s .: "index"
2875+ IndexSettings <$> i .: "number_of_shards"
2876+ <*> i .: "number_of_replicas"
2877+
2878+instance ToJSON UpdatableIndexSetting where
2879+ toJSON (NumberOfReplicas x) = oPath ("index" :| ["number_of_replicas"]) x
2880+ toJSON (AutoExpandReplicas x) = oPath ("index" :| ["auto_expand_replicas"]) x
2881+ toJSON (RefreshInterval x) = oPath ("index" :| ["refresh_interval"]) (NominalDiffTimeJSON x)
2882+ toJSON (IndexConcurrency x) = oPath ("index" :| ["concurrency"]) x
2883+ toJSON (FailOnMergeFailure x) = oPath ("index" :| ["fail_on_merge_failure"]) x
2884+ toJSON (TranslogFlushThresholdOps x) = oPath ("index" :| ["translog", "flush_threshold_ops"]) x
2885+ toJSON (TranslogFlushThresholdSize x) = oPath ("index" :| ["translog", "flush_threshold_size"]) x
2886+ toJSON (TranslogFlushThresholdPeriod x) = oPath ("index" :| ["translog", "flush_threshold_period"]) (NominalDiffTimeJSON x)
2887+ toJSON (TranslogDisableFlush x) = oPath ("index" :| ["translog", "disable_flush"]) x
2888+ toJSON (CacheFilterMaxSize x) = oPath ("index" :| ["cache", "filter", "max_size"]) x
2889+ toJSON (CacheFilterExpire x) = oPath ("index" :| ["cache", "filter", "expire"]) (NominalDiffTimeJSON <$> x)
2890+ toJSON (GatewaySnapshotInterval x) = oPath ("index" :| ["gateway", "snapshot_interval"]) (NominalDiffTimeJSON x)
2891+ toJSON (RoutingAllocationInclude fs) = oPath ("index" :| ["routing", "allocation", "include"]) (attrFilterJSON fs)
2892+ toJSON (RoutingAllocationExclude fs) = oPath ("index" :| ["routing", "allocation", "exclude"]) (attrFilterJSON fs)
2893+ toJSON (RoutingAllocationRequire fs) = oPath ("index" :| ["routing", "allocation", "require"]) (attrFilterJSON fs)
2894+ toJSON (RoutingAllocationEnable x) = oPath ("index" :| ["routing", "allocation", "enable"]) x
2895+ toJSON (RoutingAllocationShardsPerNode x) = oPath ("index" :| ["routing", "allocation", "total_shards_per_node"]) x
2896+ toJSON (RecoveryInitialShards x) = oPath ("index" :| ["recovery", "initial_shards"]) x
2897+ toJSON (GCDeletes x) = oPath ("index" :| ["gc_deletes"]) (NominalDiffTimeJSON x)
2898+ toJSON (TTLDisablePurge x) = oPath ("index" :| ["ttl", "disable_purge"]) x
2899+ toJSON (TranslogFSType x) = oPath ("index" :| ["translog", "fs", "type"]) x
2900+ toJSON (IndexCompoundFormat x) = oPath ("index" :| ["compound_format"]) x
2901+ toJSON (IndexCompoundOnFlush x) = oPath ("index" :| ["compound_on_flush"]) x
2902+ toJSON (WarmerEnabled x) = oPath ("index" :| ["warmer", "enabled"]) x
2903+ toJSON (BlocksReadOnly x) = oPath ("blocks" :| ["read_only"]) x
2904+ toJSON (BlocksRead x) = oPath ("blocks" :| ["read"]) x
2905+ toJSON (BlocksWrite x) = oPath ("blocks" :| ["write"]) x
2906+ toJSON (BlocksMetaData x) = oPath ("blocks" :| ["metadata"]) x
2907+
2908+instance FromJSON UpdatableIndexSetting where
2909+ parseJSON = withObject "UpdatableIndexSetting" parse
2910+ where parse o = numberOfReplicas `taggedAt` ["index", "number_of_replicas"]
2911+ <|> autoExpandReplicas `taggedAt` ["index", "auto_expand_replicas"]
2912+ <|> refreshInterval `taggedAt` ["index", "refresh_interval"]
2913+ <|> indexConcurrency `taggedAt` ["index", "concurrency"]
2914+ <|> failOnMergeFailure `taggedAt` ["index", "fail_on_merge_failure"]
2915+ <|> translogFlushThresholdOps `taggedAt` ["index", "translog", "flush_threshold_ops"]
2916+ <|> translogFlushThresholdSize `taggedAt` ["index", "translog", "flush_threshold_size"]
2917+ <|> translogFlushThresholdPeriod `taggedAt` ["index", "translog", "flush_threshold_period"]
2918+ <|> translogDisableFlush `taggedAt` ["index", "translog", "disable_flush"]
2919+ <|> cacheFilterMaxSize `taggedAt` ["index", "cache", "filter", "max_size"]
2920+ <|> cacheFilterExpire `taggedAt` ["index", "cache", "filter", "expire"]
2921+ <|> gatewaySnapshotInterval `taggedAt` ["index", "gateway", "snapshot_interval"]
2922+ <|> routingAllocationInclude `taggedAt` ["index", "routing", "allocation", "include"]
2923+ <|> routingAllocationExclude `taggedAt` ["index", "routing", "allocation", "exclude"]
2924+ <|> routingAllocationRequire `taggedAt` ["index", "routing", "allocation", "require"]
2925+ <|> routingAllocationEnable `taggedAt` ["index", "routing", "allocation", "enable"]
2926+ <|> routingAllocationShardsPerNode `taggedAt` ["index", "routing", "allocation", "total_shards_per_node"]
2927+ <|> recoveryInitialShards `taggedAt` ["index", "recovery", "initial_shards"]
2928+ <|> gcDeletes `taggedAt` ["index", "gc_deletes"]
2929+ <|> ttlDisablePurge `taggedAt` ["index", "ttl", "disable_purge"]
2930+ <|> translogFSType `taggedAt` ["index", "translog", "fs", "type"]
2931+ <|> compoundFormat `taggedAt` ["index", "compound_format"]
2932+ <|> compoundOnFlush `taggedAt` ["index", "compound_on_flush"]
2933+ <|> warmerEnabled `taggedAt` ["index", "warmer", "enabled"]
2934+ <|> blocksReadOnly `taggedAt` ["blocks", "read_only"]
2935+ <|> blocksRead `taggedAt` ["blocks", "read"]
2936+ <|> blocksWrite `taggedAt` ["blocks", "write"]
2937+ <|> blocksMetaData `taggedAt` ["blocks", "metadata"]
2938+ where taggedAt f ks = taggedAt' f (Object o) ks
2939+ taggedAt' f v [] = f =<< (parseJSON v <|> (parseJSON =<< unStringlyTypeJSON v))
2940+ taggedAt' f v (k:ks) = withObject "Object" (\o -> do v' <- o .: k
2941+ taggedAt' f v' ks) v
2942+ numberOfReplicas = pure . NumberOfReplicas
2943+ autoExpandReplicas = pure . AutoExpandReplicas
2944+ refreshInterval = pure . RefreshInterval . ndtJSON
2945+ indexConcurrency = pure . IndexConcurrency
2946+ failOnMergeFailure = pure . FailOnMergeFailure
2947+ translogFlushThresholdOps = pure . TranslogFlushThresholdOps
2948+ translogFlushThresholdSize = pure . TranslogFlushThresholdSize
2949+ translogFlushThresholdPeriod = pure . TranslogFlushThresholdPeriod . ndtJSON
2950+ translogDisableFlush = pure . TranslogDisableFlush
2951+ cacheFilterMaxSize = pure . CacheFilterMaxSize
2952+ cacheFilterExpire = pure . CacheFilterExpire . fmap ndtJSON
2953+ gatewaySnapshotInterval = pure . GatewaySnapshotInterval . ndtJSON
2954+ routingAllocationInclude = fmap RoutingAllocationInclude . parseAttrFilter
2955+ routingAllocationExclude = fmap RoutingAllocationExclude . parseAttrFilter
2956+ routingAllocationRequire = fmap RoutingAllocationRequire . parseAttrFilter
2957+ routingAllocationEnable = pure . RoutingAllocationEnable
2958+ routingAllocationShardsPerNode = pure . RoutingAllocationShardsPerNode
2959+ recoveryInitialShards = pure . RecoveryInitialShards
2960+ gcDeletes = pure . GCDeletes . ndtJSON
2961+ ttlDisablePurge = pure . TTLDisablePurge
2962+ translogFSType = pure . TranslogFSType
2963+ compoundFormat = pure . IndexCompoundFormat
2964+ compoundOnFlush = pure . IndexCompoundOnFlush
2965+ warmerEnabled = pure . WarmerEnabled
2966+ blocksReadOnly = pure . BlocksReadOnly
2967+ blocksRead = pure . BlocksRead
2968+ blocksWrite = pure . BlocksWrite
2969+ blocksMetaData = pure . BlocksMetaData
2970+
2971+instance FromJSON IndexSettingsSummary where
2972+ parseJSON = withObject "IndexSettingsSummary" parse
2973+ where parse o = case HM.toList o of
2974+ [(ixn, v@(Object o'))] -> IndexSettingsSummary (IndexName ixn)
2975+ <$> parseJSON v
2976+ <*> (fmap (filter (not . redundant)) . parseSettings =<< o' .: "settings")
2977+ _ -> fail "Expected single-key object with index name"
2978+ redundant (NumberOfReplicas _) = True
2979+ redundant _ = False
2980+
2981+-- | For some reason in the settings API, all leaf values get returned
2982+-- as strings. This function attepmts to recover from this for all
2983+-- non-recursive JSON types. If nothing can be done or the same value
2984+-- would be return, it returns 'mzero'
2985+unStringlyTypeJSON :: MonadPlus m => Value -> m Value
2986+unStringlyTypeJSON (String "true") = return (Bool True)
2987+unStringlyTypeJSON (String "false") = return (Bool False)
2988+unStringlyTypeJSON (String "null") = return Null
2989+unStringlyTypeJSON (String t) = case readMay (T.unpack t) of
2990+ Just n -> return (Number n)
2991+ Nothing -> mzero
2992+unStringlyTypeJSON _ = mzero
2993+
2994+
2995+parseSettings :: Object -> Parser [UpdatableIndexSetting]
2996+parseSettings o = do
2997+ o' <- o .: "index"
2998+ -- slice the index object into singleton hashmaps and try to parse each
2999+ parses <- forM (HM.toList o') $ \(k, v) -> do
3000+ -- blocks are now nested into the "index" key, which is not how they're serialized
3001+ let atRoot = Object (HM.singleton k v)
3002+ let atIndex = Object (HM.singleton "index" atRoot)
3003+ optional (parseJSON atRoot <|> parseJSON atIndex)
3004+ return (catMaybes parses)
3005+
3006+oPath :: ToJSON a => NonEmpty Text -> a -> Value
3007+oPath (k :| []) v = object [k .= v]
3008+oPath (k:| (h:t)) v = object [k .= oPath (h :| t) v]
3009+
3010+attrFilterJSON :: NonEmpty NodeAttrFilter -> Value
3011+attrFilterJSON fs = object [ n .= T.intercalate "," (toList vs)
3012+ | NodeAttrFilter (NodeAttrName n) vs <- toList fs]
3013+
3014+parseAttrFilter :: Value -> Parser (NonEmpty NodeAttrFilter)
3015+parseAttrFilter = withObject "NonEmpty NodeAttrFilter" parse
3016+ where parse o = case HM.toList o of
3017+ [] -> fail "Expected non-empty list of NodeAttrFilters"
3018+ x:xs -> DT.mapM (uncurry parse') (x :| xs)
3019+ parse' n = withText "Text" $ \t ->
3020+ case T.splitOn "," t of
3021+ fv:fvs -> return (NodeAttrFilter (NodeAttrName n) (fv :| fvs))
3022+ [] -> fail "Expected non-empty list of filter values"
3023+
3024+instance ToJSON ReplicaBounds where
3025+ toJSON (ReplicasBounded a b) = String (showText a <> "-" <> showText b)
3026+ toJSON (ReplicasLowerBounded a) = String (showText a <> "-all")
3027+ toJSON ReplicasUnbounded = Bool False
3028+
3029+instance FromJSON ReplicaBounds where
3030+ parseJSON v = withText "ReplicaBounds" parseText v
3031+ <|> withBool "ReplicaBounds" parseBool v
3032+ where parseText t = case T.splitOn "-" t of
3033+ [a, "all"] -> ReplicasLowerBounded <$> parseReadText a
3034+ [a, b] -> ReplicasBounded <$> parseReadText a
3035+ <*> parseReadText b
3036+ _ -> fail ("Could not parse ReplicaBounds: " <> show t)
3037+ parseBool False = pure ReplicasUnbounded
3038+ parseBool _ = fail "ReplicasUnbounded cannot be represented with True"
3039+
3040+instance ToJSON AllocationPolicy where
3041+ toJSON AllocAll = String "all"
3042+ toJSON AllocPrimaries = String "primaries"
3043+ toJSON AllocNewPrimaries = String "new_primaries"
3044+ toJSON AllocNone = String "none"
3045+
3046+instance FromJSON AllocationPolicy where
3047+ parseJSON = withText "AllocationPolicy" parse
3048+ where parse "all" = pure AllocAll
3049+ parse "primaries" = pure AllocPrimaries
3050+ parse "new_primaries" = pure AllocNewPrimaries
3051+ parse "none" = pure AllocNone
3052+ parse t = fail ("Invlaid AllocationPolicy: " <> show t)
3053+
3054+instance ToJSON InitialShardCount where
3055+ toJSON QuorumShards = String "quorum"
3056+ toJSON QuorumMinus1Shards = String "quorum-1"
3057+ toJSON FullShards = String "full"
3058+ toJSON FullMinus1Shards = String "full-1"
3059+ toJSON (ExplicitShards x) = toJSON x
3060+
3061+instance FromJSON InitialShardCount where
3062+ parseJSON v = withText "InitialShardCount" parseText v
3063+ <|> ExplicitShards <$> parseJSON v
3064+ where parseText "quorum" = pure QuorumShards
3065+ parseText "quorum-1" = pure QuorumMinus1Shards
3066+ parseText "full" = pure FullShards
3067+ parseText "full-1" = pure FullMinus1Shards
3068+ parseText _ = mzero
3069+
3070+instance ToJSON FSType where
3071+ toJSON FSSimple = "simple"
3072+ toJSON FSBuffered = "buffered"
3073+
3074+instance FromJSON FSType where
3075+ parseJSON = withText "FSType" parse
3076+ where parse "simple" = pure FSSimple
3077+ parse "buffered" = pure FSBuffered
3078+ parse t = fail ("Invalid FSType: " <> show t)
3079+
3080+instance ToJSON CompoundFormat where
3081+ toJSON (CompoundFileFormat x) = Bool x
3082+ toJSON (MergeSegmentVsTotalIndex x) = toJSON x
3083+
3084+instance FromJSON CompoundFormat where
3085+ parseJSON v = CompoundFileFormat <$> parseJSON v
3086+ <|> MergeSegmentVsTotalIndex <$> parseJSON v
3087+
3088+instance ToJSON NominalDiffTimeJSON where
3089+ toJSON (NominalDiffTimeJSON t) = String (showText (round t :: Integer) <> "s")
3090+
3091+instance FromJSON NominalDiffTimeJSON where
3092+ parseJSON = withText "NominalDiffTime" parse
3093+ where parse t = case T.takeEnd 1 t of
3094+ "s" -> NominalDiffTimeJSON . fromInteger <$> parseReadText (T.dropEnd 1 t)
3095+ _ -> fail "Invalid or missing NominalDiffTime unit (expected s)"
3096+
3097+instance ToJSON IndexTemplate where
3098+ toJSON (IndexTemplate p s m) = merge
3099+ (object [ "template" .= p
3100+ , "mappings" .= foldl' merge (object []) m
3101+ ])
3102+ (toJSON s)
3103+ where
3104+ merge (Object o1) (Object o2) = toJSON $ HM.union o1 o2
3105+ merge o Null = o
3106+ merge _ _ = undefined
3107+
3108+instance (FromJSON a) => FromJSON (EsResult a) where
3109+ parseJSON jsonVal@(Object v) = do
3110+ found <- v .:? "found" .!= False
3111+ fr <- if found
3112+ then parseJSON jsonVal
3113+ else return Nothing
3114+ EsResult <$> v .: "_index" <*>
3115+ v .: "_type" <*>
3116+ v .: "_id" <*>
3117+ pure fr
3118+ parseJSON _ = empty
3119+
3120+instance (FromJSON a) => FromJSON (EsResultFound a) where
3121+ parseJSON (Object v) = EsResultFound <$>
3122+ v .: "_version" <*>
3123+ v .: "_source"
3124+ parseJSON _ = empty
3125+
3126+instance FromJSON EsError where
3127+ parseJSON (Object v) = EsError <$>
3128+ v .: "status" <*>
3129+ v .: "error"
3130+ parseJSON _ = empty
3131+
3132+instance FromJSON IndexAliasesSummary where
3133+ parseJSON = withObject "IndexAliasesSummary" parse
3134+ where parse o = IndexAliasesSummary . mconcat <$> mapM (uncurry go) (HM.toList o)
3135+ go ixn = withObject "index aliases" $ \ia -> do
3136+ aliases <- ia .:? "aliases" .!= mempty
3137+ forM (HM.toList aliases) $ \(aName, v) -> do
3138+ let indexAlias = IndexAlias (IndexName ixn) (IndexAliasName (IndexName aName))
3139+ IndexAliasSummary indexAlias <$> parseJSON v
3140+
3141+
3142+instance ToJSON IndexAliasAction where
3143+ toJSON (AddAlias ia opts) = object ["add" .= (iaObj <> optsObj)]
3144+ where Object iaObj = toJSON ia
3145+ Object optsObj = toJSON opts
3146+ toJSON (RemoveAlias ia) = object ["remove" .= iaObj]
3147+ where Object iaObj = toJSON ia
3148+
3149+instance ToJSON IndexAlias where
3150+ toJSON IndexAlias {..} = object ["index" .= srcIndex
3151+ , "alias" .= indexAlias
3152+ ]
3153+
3154+instance ToJSON IndexAliasCreate where
3155+ toJSON IndexAliasCreate {..} = Object (filterObj <> routingObj)
3156+ where filterObj = maybe mempty (HM.singleton "filter" . toJSON) aliasCreateFilter
3157+ Object routingObj = maybe (Object mempty) toJSON aliasCreateRouting
3158+
3159+instance ToJSON AliasRouting where
3160+ toJSON (AllAliasRouting v) = object ["routing" .= v]
3161+ toJSON (GranularAliasRouting srch idx) = object (catMaybes prs)
3162+ where prs = [("search_routing" .=) <$> srch
3163+ ,("index_routing" .=) <$> idx]
3164+
3165+instance FromJSON AliasRouting where
3166+ parseJSON = withObject "AliasRouting" parse
3167+ where parse o = parseAll o <|> parseGranular o
3168+ parseAll o = AllAliasRouting <$> o .: "routing"
3169+ parseGranular o = do
3170+ sr <- o .:? "search_routing"
3171+ ir <- o .:? "index_routing"
3172+ if isNothing sr && isNothing ir
3173+ then fail "Both search_routing and index_routing can't be blank"
3174+ else return (GranularAliasRouting sr ir)
3175+
3176+instance FromJSON IndexAliasCreate where
3177+ parseJSON v = withObject "IndexAliasCreate" parse v
3178+ where parse o = IndexAliasCreate <$> optional (parseJSON v)
3179+ <*> o .:? "filter"
3180+
3181+instance ToJSON SearchAliasRouting where
3182+ toJSON (SearchAliasRouting rvs) = toJSON (T.intercalate "," (routingValue <$> toList rvs))
3183+
3184+instance FromJSON SearchAliasRouting where
3185+ parseJSON = withText "SearchAliasRouting" parse
3186+ where parse t = SearchAliasRouting <$> parseNEJSON (String <$> T.splitOn "," t)
3187+
3188+instance ToJSON Search where
3189+ toJSON (Search query sFilter sort searchAggs highlight sTrackSortScores sFrom sSize _ sFields sSource) =
3190+ omitNulls [ "query" .= query
3191+ , "filter" .= sFilter
3192+ , "sort" .= sort
3193+ , "aggregations" .= searchAggs
3194+ , "highlight" .= highlight
3195+ , "from" .= sFrom
3196+ , "size" .= sSize
3197+ , "track_scores" .= sTrackSortScores
3198+ , "fields" .= sFields
3199+ , "_source" .= sSource]
3200+
3201+
3202+instance ToJSON Source where
3203+ toJSON NoSource = toJSON False
3204+ toJSON (SourcePatterns patterns) = toJSON patterns
3205+ toJSON (SourceIncludeExclude incl excl) = object [ "include" .= incl, "exclude" .= excl ]
3206+
3207+instance ToJSON PatternOrPatterns where
3208+ toJSON (PopPattern pattern) = toJSON pattern
3209+ toJSON (PopPatterns patterns) = toJSON patterns
3210+
3211+instance ToJSON Include where
3212+ toJSON (Include patterns) = toJSON patterns
3213+
3214+instance ToJSON Exclude where
3215+ toJSON (Exclude patterns) = toJSON patterns
3216+
3217+instance ToJSON Pattern where
3218+ toJSON (Pattern pattern) = toJSON pattern
3219+
3220+
3221+instance ToJSON FieldHighlight where
3222+ toJSON (FieldHighlight (FieldName fName) (Just fSettings)) =
3223+ object [ fName .= fSettings ]
3224+ toJSON (FieldHighlight (FieldName fName) Nothing) =
3225+ object [ fName .= emptyObject ]
3226+
3227+instance ToJSON Highlights where
3228+ toJSON (Highlights global fields) =
3229+ omitNulls (("fields" .= fields)
3230+ : highlightSettingsPairs global)
3231+
3232+instance ToJSON HighlightSettings where
3233+ toJSON hs = omitNulls (highlightSettingsPairs (Just hs))
3234+
3235+highlightSettingsPairs :: Maybe HighlightSettings -> [Pair]
3236+highlightSettingsPairs Nothing = []
3237+highlightSettingsPairs (Just (Plain plh)) = plainHighPairs (Just plh)
3238+highlightSettingsPairs (Just (Postings ph)) = postHighPairs (Just ph)
3239+highlightSettingsPairs (Just (FastVector fvh)) = fastVectorHighPairs (Just fvh)
3240+
3241+
3242+plainHighPairs :: Maybe PlainHighlight -> [Pair]
3243+plainHighPairs Nothing = []
3244+plainHighPairs (Just (PlainHighlight plCom plNonPost)) =
3245+ [ "type" .= String "plain"]
3246+ ++ commonHighlightPairs plCom
3247+ ++ nonPostingsToPairs plNonPost
3248+
3249+postHighPairs :: Maybe PostingsHighlight -> [Pair]
3250+postHighPairs Nothing = []
3251+postHighPairs (Just (PostingsHighlight pCom)) =
3252+ ("type" .= String "postings")
3253+ : commonHighlightPairs pCom
3254+
3255+fastVectorHighPairs :: Maybe FastVectorHighlight -> [Pair]
3256+fastVectorHighPairs Nothing = []
3257+fastVectorHighPairs (Just
3258+ (FastVectorHighlight fvCom fvNonPostSettings fvBoundChars
3259+ fvBoundMaxScan fvFragOff fvMatchedFields
3260+ fvPhraseLim)) =
3261+ [ "type" .= String "fvh"
3262+ , "boundary_chars" .= fvBoundChars
3263+ , "boundary_max_scan" .= fvBoundMaxScan
3264+ , "fragment_offset" .= fvFragOff
3265+ , "matched_fields" .= fvMatchedFields
3266+ , "phraseLimit" .= fvPhraseLim]
3267+ ++ commonHighlightPairs fvCom
3268+ ++ nonPostingsToPairs fvNonPostSettings
3269+
3270+deleteSeveral :: (Eq k, Hashable k) => [k] -> HM.HashMap k v -> HM.HashMap k v
3271+deleteSeveral ks hm = foldr HM.delete hm ks
3272+
3273+commonHighlightPairs :: Maybe CommonHighlight -> [Pair]
3274+commonHighlightPairs Nothing = []
3275+commonHighlightPairs (Just (CommonHighlight chScore chForceSource chTag chEncoder
3276+ chNoMatchSize chHighlightQuery
3277+ chRequireFieldMatch)) =
3278+ [ "order" .= chScore
3279+ , "force_source" .= chForceSource
3280+ , "encoder" .= chEncoder
3281+ , "no_match_size" .= chNoMatchSize
3282+ , "highlight_query" .= chHighlightQuery
3283+ , "require_fieldMatch" .= chRequireFieldMatch]
3284+ ++ highlightTagToPairs chTag
3285+
3286+
3287+nonPostingsToPairs :: Maybe NonPostings -> [Pair]
3288+nonPostingsToPairs Nothing = []
3289+nonPostingsToPairs (Just (NonPostings npFragSize npNumOfFrags)) =
3290+ [ "fragment_size" .= npFragSize
3291+ , "number_of_fragments" .= npNumOfFrags]
3292+
3293+parseNEJSON :: (FromJSON a) => [Value] -> Parser (NonEmpty a)
3294+parseNEJSON [] = fail "Expected non-empty list"
3295+parseNEJSON (x:xs) = DT.mapM parseJSON (x :| xs)
3296+
3297+
3298+instance ToJSON HighlightEncoder where
3299+ toJSON DefaultEncoder = String "default"
3300+ toJSON HTMLEncoder = String "html"
3301+
3302+highlightTagToPairs :: Maybe HighlightTag -> [Pair]
3303+highlightTagToPairs (Just (TagSchema _)) = [ "scheme" .= String "default"]
3304+highlightTagToPairs (Just (CustomTags (pre, post))) = [ "pre_tags" .= pre
3305+ , "post_tags" .= post]
3306+highlightTagToPairs Nothing = []
3307+
3308+instance ToJSON SortSpec where
3309+ toJSON (DefaultSortSpec
3310+ (DefaultSort (FieldName dsSortFieldName) dsSortOrder dsIgnoreUnmapped
3311+ dsSortMode dsMissingSort dsNestedFilter)) =
3312+ object [dsSortFieldName .= omitNulls base] where
3313+ base = [ "order" .= dsSortOrder
3314+ , "ignore_unmapped" .= dsIgnoreUnmapped
3315+ , "mode" .= dsSortMode
3316+ , "missing" .= dsMissingSort
3317+ , "nested_filter" .= dsNestedFilter ]
3318+
3319+ toJSON (GeoDistanceSortSpec gdsSortOrder (GeoPoint (FieldName field) gdsLatLon) units) =
3320+ object [ "unit" .= units
3321+ , field .= gdsLatLon
3322+ , "order" .= gdsSortOrder ]
3323+
3324+
3325+instance ToJSON SortOrder where
3326+ toJSON Ascending = String "asc"
3327+ toJSON Descending = String "desc"
3328+
3329+
3330+instance ToJSON SortMode where
3331+ toJSON SortMin = String "min"
3332+ toJSON SortMax = String "max"
3333+ toJSON SortSum = String "sum"
3334+ toJSON SortAvg = String "avg"
3335+
3336+
3337+instance ToJSON Missing where
3338+ toJSON LastMissing = String "_last"
3339+ toJSON FirstMissing = String "_first"
3340+ toJSON (CustomMissing txt) = String txt
3341+
3342+
3343+instance ToJSON ScoreType where
3344+ toJSON ScoreTypeMax = "max"
3345+ toJSON ScoreTypeAvg = "avg"
3346+ toJSON ScoreTypeSum = "sum"
3347+ toJSON ScoreTypeNone = "none"
3348+
3349+instance FromJSON ScoreType where
3350+ parseJSON = withText "ScoreType" parse
3351+ where parse "max" = pure ScoreTypeMax
3352+ parse "avg" = pure ScoreTypeAvg
3353+ parse "sum" = pure ScoreTypeSum
3354+ parse "none" = pure ScoreTypeNone
3355+ parse t = fail ("Unexpected ScoreType: " <> show t)
3356+
3357+instance ToJSON Distance where
3358+ toJSON (Distance dCoefficient dUnit) =
3359+ String boltedTogether where
3360+ coefText = showText dCoefficient
3361+ (String unitText) = toJSON dUnit
3362+ boltedTogether = mappend coefText unitText
3363+
3364+instance FromJSON Distance where
3365+ parseJSON = withText "Distance" parse
3366+ where parse t = Distance <$> parseCoeff nT
3367+ <*> parseJSON (String unitT)
3368+ where (nT, unitT) = T.span validForNumber t
3369+ -- may be a better way to do this
3370+ validForNumber '-' = True
3371+ validForNumber '.' = True
3372+ validForNumber 'e' = True
3373+ validForNumber c = isNumber c
3374+ parseCoeff "" = fail "Empty string cannot be parsed as number"
3375+ parseCoeff s = return (read (T.unpack s))
3376+
3377+instance ToJSON DistanceUnit where
3378+ toJSON Miles = String "mi"
3379+ toJSON Yards = String "yd"
3380+ toJSON Feet = String "ft"
3381+ toJSON Inches = String "in"
3382+ toJSON Kilometers = String "km"
3383+ toJSON Meters = String "m"
3384+ toJSON Centimeters = String "cm"
3385+ toJSON Millimeters = String "mm"
3386+ toJSON NauticalMiles = String "nmi"
3387+
3388+
3389+instance FromJSON DistanceUnit where
3390+ parseJSON = withText "DistanceUnit" parse
3391+ where parse "mi" = pure Miles
3392+ parse "yd" = pure Yards
3393+ parse "ft" = pure Feet
3394+ parse "in" = pure Inches
3395+ parse "km" = pure Kilometers
3396+ parse "m" = pure Meters
3397+ parse "cm" = pure Centimeters
3398+ parse "mm" = pure Millimeters
3399+ parse "nmi" = pure NauticalMiles
3400+ parse u = fail ("Unrecognized DistanceUnit: " <> show u)
3401+
3402+instance ToJSON DistanceType where
3403+ toJSON Arc = String "arc"
3404+ toJSON SloppyArc = String "sloppy_arc"
3405+ toJSON Plane = String "plane"
3406+
3407+instance FromJSON DistanceType where
3408+ parseJSON = withText "DistanceType" parse
3409+ where parse "arc" = pure Arc
3410+ parse "sloppy_arc" = pure SloppyArc
3411+ parse "plane" = pure Plane
3412+ parse t = fail ("Unrecognized DistanceType: " <> show t)
3413+
3414+
3415+instance ToJSON OptimizeBbox where
3416+ toJSON NoOptimizeBbox = String "none"
3417+ toJSON (OptimizeGeoFilterType gft) = toJSON gft
3418+
3419+instance FromJSON OptimizeBbox where
3420+ parseJSON v = withText "NoOptimizeBbox" parseNoOptimize v
3421+ <|> parseOptimize v
3422+ where parseNoOptimize "none" = pure NoOptimizeBbox
3423+ parseNoOptimize _ = mzero
3424+ parseOptimize = fmap OptimizeGeoFilterType . parseJSON
3425+
3426+instance ToJSON GeoBoundingBoxConstraint where
3427+ toJSON (GeoBoundingBoxConstraint
3428+ (FieldName gbbcGeoBBField) gbbcConstraintBox cache type') =
3429+ object [gbbcGeoBBField .= gbbcConstraintBox
3430+ , "_cache" .= cache
3431+ , "type" .= type']
3432+
3433+instance FromJSON GeoBoundingBoxConstraint where
3434+ parseJSON = withObject "GeoBoundingBoxConstraint" parse
3435+ where parse o = case HM.toList (deleteSeveral ["type", "_cache"] o) of
3436+ [(fn, v)] -> GeoBoundingBoxConstraint (FieldName fn)
3437+ <$> parseJSON v
3438+ <*> o .:? "_cache" .!= defaultCache
3439+ <*> o .: "type"
3440+ _ -> fail "Could not find field name for GeoBoundingBoxConstraint"
3441+
3442+instance ToJSON GeoFilterType where
3443+ toJSON GeoFilterMemory = String "memory"
3444+ toJSON GeoFilterIndexed = String "indexed"
3445+
3446+instance FromJSON GeoFilterType where
3447+ parseJSON = withText "GeoFilterType" parse
3448+ where parse "memory" = pure GeoFilterMemory
3449+ parse "indexed" = pure GeoFilterIndexed
3450+ parse t = fail ("Unrecognized GeoFilterType: " <> show t)
3451+
3452+instance ToJSON GeoBoundingBox where
3453+ toJSON (GeoBoundingBox gbbTopLeft gbbBottomRight) =
3454+ object ["top_left" .= gbbTopLeft
3455+ , "bottom_right" .= gbbBottomRight]
3456+
3457+instance FromJSON GeoBoundingBox where
3458+ parseJSON = withObject "GeoBoundingBox" parse
3459+ where parse o = GeoBoundingBox
3460+ <$> o .: "top_left"
3461+ <*> o .: "bottom_right"
3462+
3463+instance ToJSON LatLon where
3464+ toJSON (LatLon lLat lLon) =
3465+ object ["lat" .= lLat
3466+ , "lon" .= lLon]
3467+
3468+instance FromJSON LatLon where
3469+ parseJSON = withObject "LatLon" parse
3470+ where parse o = LatLon <$> o .: "lat"
3471+ <*> o .: "lon"
3472+
3473+-- index for smaller ranges, fielddata for longer ranges
3474+instance ToJSON RangeExecution where
3475+ toJSON RangeExecutionIndex = "index"
3476+ toJSON RangeExecutionFielddata = "fielddata"
3477+
3478+
3479+instance FromJSON RangeExecution where
3480+ parseJSON = withText "RangeExecution" parse
3481+ where parse "index" = pure RangeExecutionIndex
3482+ parse "fielddata" = pure RangeExecutionFielddata
3483+ parse t = error ("Unrecognized RangeExecution " <> show t)
3484+
3485+instance ToJSON RegexpFlags where
3486+ toJSON AllRegexpFlags = String "ALL"
3487+ toJSON NoRegexpFlags = String "NONE"
3488+ toJSON (SomeRegexpFlags (h :| fs)) = String $ T.intercalate "|" flagStrs
3489+ where flagStrs = map flagStr . nub $ h:fs
3490+ flagStr AnyString = "ANYSTRING"
3491+ flagStr Automaton = "AUTOMATON"
3492+ flagStr Complement = "COMPLEMENT"
3493+ flagStr Empty = "EMPTY"
3494+ flagStr Intersection = "INTERSECTION"
3495+ flagStr Interval = "INTERVAL"
3496+
3497+instance FromJSON RegexpFlags where
3498+ parseJSON = withText "RegexpFlags" parse
3499+ where parse "ALL" = pure AllRegexpFlags
3500+ parse "NONE" = pure NoRegexpFlags
3501+ parse t = SomeRegexpFlags <$> parseNEJSON (String <$> T.splitOn "|" t)
3502+
3503+instance FromJSON RegexpFlag where
3504+ parseJSON = withText "RegexpFlag" parse
3505+ where parse "ANYSTRING" = pure AnyString
3506+ parse "AUTOMATON" = pure Automaton
3507+ parse "COMPLEMENT" = pure Complement
3508+ parse "EMPTY" = pure Empty
3509+ parse "INTERSECTION" = pure Intersection
3510+ parse "INTERVAL" = pure Interval
3511+ parse f = fail ("Unknown RegexpFlag: " <> show f)
3512+
3513+instance ToJSON Term where
3514+ toJSON (Term field value) = object ["term" .= object
3515+ [field .= value]]
3516+
3517+instance FromJSON Term where
3518+ parseJSON = withObject "Term" parse
3519+ where parse o = do termObj <- o .: "term"
3520+ case HM.toList termObj of
3521+ [(fn, v)] -> Term fn <$> parseJSON v
3522+ _ -> fail "Expected object with 1 field-named key"
3523+
3524+instance ToJSON BoolMatch where
3525+ toJSON (MustMatch term cache) = object ["must" .= term,
3526+ "_cache" .= cache]
3527+ toJSON (MustNotMatch term cache) = object ["must_not" .= term,
3528+ "_cache" .= cache]
3529+ toJSON (ShouldMatch terms cache) = object ["should" .= fmap toJSON terms,
3530+ "_cache" .= cache]
3531+
3532+instance FromJSON BoolMatch where
3533+ parseJSON = withObject "BoolMatch" parse
3534+ where parse o = mustMatch `taggedWith` "must"
3535+ <|> mustNotMatch `taggedWith` "must_not"
3536+ <|> shouldMatch `taggedWith` "should"
3537+ where taggedWith parser k = parser =<< o .: k
3538+ mustMatch t = MustMatch t <$> o .:? "_cache" .!= defaultCache
3539+ mustNotMatch t = MustNotMatch t <$> o .:? "_cache" .!= defaultCache
3540+ shouldMatch t = ShouldMatch t <$> o .:? "_cache" .!= defaultCache
3541+
3542+instance (FromJSON a) => FromJSON (SearchResult a) where
3543+ parseJSON (Object v) = SearchResult <$>
3544+ v .: "took" <*>
3545+ v .: "timed_out" <*>
3546+ v .: "_shards" <*>
3547+ v .: "hits" <*>
3548+ v .:? "aggregations" <*>
3549+ v .:? "_scroll_id"
3550+ parseJSON _ = empty
3551+
3552+instance (FromJSON a) => FromJSON (SearchHits a) where
3553+ parseJSON (Object v) = SearchHits <$>
3554+ v .: "total" <*>
3555+ v .: "max_score" <*>
3556+ v .: "hits"
3557+ parseJSON _ = empty
3558+
3559+instance (FromJSON a) => FromJSON (Hit a) where
3560+ parseJSON (Object v) = Hit <$>
3561+ v .: "_index" <*>
3562+ v .: "_type" <*>
3563+ v .: "_id" <*>
3564+ v .: "_score" <*>
3565+ v .:? "_source" <*>
3566+ v .:? "highlight"
3567+ parseJSON _ = empty
3568+
3569+instance FromJSON ShardResult where
3570+ parseJSON (Object v) = ShardResult <$>
3571+ v .: "total" <*>
3572+ v .: "successful" <*>
3573+ v .: "failed"
3574+ parseJSON _ = empty
3575+
3576+
3577+instance FromJSON DocVersion where
3578+ parseJSON v = do
3579+ i <- parseJSON v
3580+ maybe (fail "DocVersion out of range") return $ mkDocVersion i
3581+
3582+-- This insanity is because ES *sometimes* returns Replica/Shard counts as strings
3583+instance FromJSON ReplicaCount where
3584+ parseJSON v = parseAsInt v
3585+ <|> parseAsString v
3586+ where parseAsInt = fmap ReplicaCount . parseJSON
3587+ parseAsString = withText "ReplicaCount" (fmap ReplicaCount . parseReadText)
3588+
3589+instance FromJSON ShardCount where
3590+ parseJSON v = parseAsInt v
3591+ <|> parseAsString v
3592+ where parseAsInt = fmap ShardCount . parseJSON
3593+ parseAsString = withText "ShardCount" (fmap ShardCount . parseReadText)
3594+
3595+instance Bounded DocVersion where
3596+ minBound = DocVersion 1
3597+ maxBound = DocVersion 9200000000000000000 -- 9.2e+18
3598+
3599+instance Enum DocVersion where
3600+ succ x
3601+ | x /= maxBound = DocVersion (succ $ docVersionNumber x)
3602+ | otherwise = succError "DocVersion"
3603+ pred x
3604+ | x /= minBound = DocVersion (pred $ docVersionNumber x)
3605+ | otherwise = predError "DocVersion"
3606+ toEnum i =
3607+ fromMaybe (error $ show i ++ " out of DocVersion range") $ mkDocVersion i
3608+ fromEnum = docVersionNumber
3609+ enumFrom = boundedEnumFrom
3610+ enumFromThen = boundedEnumFromThen
3611+
3612+-- | Username type used for HTTP Basic authentication. See 'basicAuthHook'.
3613+newtype EsUsername = EsUsername { esUsername :: Text } deriving (Show, Eq)
5393614
540−newtype ScrollId =
541− ScrollId Text
542− deriving (Eq, Show, Ord, ToJSON, FromJSON)
3615+-- | Password type used for HTTP Basic authentication. See 'basicAuthHook'.
3616+newtype EsPassword = EsPassword { esPassword :: Text } deriving (Show, Eq)
src/Database/Bloodhound/Types/Class.hsnew file+17
@@ -0,0 +1,17 @@
1+{-# LANGUAGE CPP #-}
2+module Database.Bloodhound.Types.Class
3+ ( Seminearring(..) )
4+ where
5+
6+#if !MIN_VERSION_base(4,8,0)
7+import Data.Monoid
8+#endif
9+
10+class Monoid a => Seminearring a where
11+ -- 0, +, *
12+ (<||>) :: a -> a -> a
13+ (<&&>) :: a -> a -> a
14+ (<&&>) = mappend
15+
16+infixr 5 <||>
17+infixr 5 <&&>
src/Database/Bloodhound/Types/Internal.hsnew file+56
@@ -0,0 +1,56 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE DeriveGeneric #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5+
6+-------------------------------------------------------------------------------
7+-- |
8+-- Module : Database.Bloodhound.Types.Internal
9+-- Copyright : (C) 2014 Chris Allen
10+-- License : BSD-style (see the file LICENSE)
11+-- Maintainer : Chris Allen <cma@bitemyapp.com>
12+-- Stability : provisional
13+-- Portability : DeriveGeneric, RecordWildCards
14+--
15+-- Internal data types for Bloodhound. These types may change without
16+-- notice so import at your own risk.
17+-------------------------------------------------------------------------------
18+module Database.Bloodhound.Types.Internal
19+ ( BHEnv(..)
20+ , Server(..)
21+ , MonadBH(..)
22+ ) where
23+
24+
25+import Control.Applicative
26+import Control.Monad.Reader
27+import Data.Text (Text)
28+import Data.Typeable (Typeable)
29+import GHC.Generics (Generic)
30+import Network.HTTP.Client
31+
32+{-| Common environment for Elasticsearch calls. Connections will be
33+ pipelined according to the provided HTTP connection manager.
34+-}
35+data BHEnv = BHEnv { bhServer :: Server
36+ , bhManager :: Manager
37+ , bhRequestHook :: Request -> IO Request
38+ -- ^ Low-level hook that is run before every request is sent. Used to implement custom authentication strategies. Defaults to 'return' with 'mkBHEnv'.
39+ }
40+
41+instance (Functor m, Applicative m, MonadIO m) => MonadBH (ReaderT BHEnv m) where
42+ getBHEnv = ask
43+
44+{-| 'Server' is used with the client functions to point at the ES instance
45+-}
46+newtype Server = Server Text deriving (Eq, Show, Generic, Typeable)
47+
48+{-| All API calls to Elasticsearch operate within
49+ MonadBH
50+ . The idea is that it can be easily embedded in your
51+ own monad transformer stack. A default instance for a ReaderT and
52+ alias 'BH' is provided for the simple case.
53+-}
54+class (Functor m, Applicative m, MonadIO m) => MonadBH m where
55+ getBHEnv :: m BHEnv
56+
stack-7.10.yamlnew file+15
@@ -0,0 +1,15 @@
1+flags: {}
2+packages:
3+- '.'
4+extra-deps:
5+- aeson-0.11.1.0
6+- fail-4.9.0.0
7+- http-types-0.9
8+- http-client-0.4.24
9+- attoparsec-0.13.0.1
10+- doctest-0.10.1
11+- doctest-prop-0.2.0.1
12+- quickcheck-properties-0.1
13+- semigroups-0.18.0.1
14+- uri-bytestring-0.1.9
15+resolver: lts-5.1
stack-7.8.yamlnew file+14
@@ -0,0 +1,14 @@
1+flags:
2+ aeson:
3+ old-locale: true
4+packages:
5+- '.'
6+extra-deps:
7+- aeson-0.11.1.0
8+- http-types-0.9
9+- http-client-0.4.24
10+- attoparsec-0.13.0.1
11+- doctest-0.10.1
12+- doctest-prop-0.2.0.1
13+- quickcheck-properties-0.1
14+resolver: lts-2.18
stack-8.0.yamldeleted−12
@@ -1,12 +0,0 @@
1−flags:
2− bloodhound-examples:
3− werror: true
4−
5−packages:
6−- '.'
7−- './examples'
8−extra-deps:
9− - quickcheck-properties-0.1
10− - quickcheck-arbitrary-template-0.2.0.0
11−
12−resolver: lts-8.14
stack-8.2.yamldeleted−15
@@ -1,15 +0,0 @@
1−flags:
2− bloodhound-examples:
3− werror: true
4−
5−packages:
6− - '.'
7− - './examples'
8−
9−extra-deps:
10− - aeson-1.3.0.0
11− - http-types-0.12.1
12− - quickcheck-arbitrary-template-0.2.0.0
13− - quickcheck-properties-0.1
14−
15−resolver: lts-11.6
stack-8.2.yaml.lockdeleted−40
@@ -1,40 +0,0 @@
1−# This file was autogenerated by Stack.
2−# You should not edit this file by hand.
3−# For more information, please see the documentation at:
4−# https://docs.haskellstack.org/en/stable/lock_files
5−
6−packages:
7−- completed:
8− hackage: aeson-1.3.0.0@sha256:23c353da98033eab7dca65d496df6c79c929f8d1413119648d1de01e703fbd3b,6539
9− pantry-tree:
10− size: 39767
11− sha256: 68512381071165c48e123cf515c1098ee455ec75b56724e31f6d570d3c865c47
12− original:
13− hackage: aeson-1.3.0.0
14−- completed:
15− hackage: http-types-0.12.1@sha256:12ce2fc081fde3cf219b630c2fb3815183a64eee236ba7aa735f666eab949610,2035
16− pantry-tree:
17− size: 832
18− sha256: c66c35b8f4f1b8b82f99cf8de3711027b5d0cc64bd031ab84375100038f81310
19− original:
20− hackage: http-types-0.12.1
21−- completed:
22− hackage: quickcheck-arbitrary-template-0.2.0.0@sha256:c8afad9c6e1f2a1d9813bb6c94158a99f7d6edeae8bb696b29d6c450f67811ec,2025
23− pantry-tree:
24− size: 625
25− sha256: 64262d8f3365305c35babbb2f5727ea3287c3fad61d3b66c3a2c68185fe92c5a
26− original:
27− hackage: quickcheck-arbitrary-template-0.2.0.0
28−- completed:
29− hackage: quickcheck-properties-0.1@sha256:3bd0890e84ec4cf1c1e6e475152c2c0d7c85915a051cf4e8bf9ec70c32df735c,1268
30− pantry-tree:
31− size: 550
32− sha256: 12264d8a89883b42e78c313792f8cba9af51c8fda915fce34e9780ff6972cf7e
33− original:
34− hackage: quickcheck-properties-0.1
35−snapshots:
36−- completed:
37− size: 507208
38− url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/11/6.yaml
39− sha256: 99d52f009dc5a53ac61ffc4e6044f910ca7b28b4596b6962135a48e8c7d3d093
40− original: lts-11.6
stack-8.4.yamldeleted−15
@@ -1,15 +0,0 @@
1−flags:
2− bloodhound-examples:
3− werror: true
4−
5−packages:
6− - '.'
7− - './examples'
8−
9−# extra-deps:
10−# - aeson-1.3.0.0
11−# - http-types-0.12.1
12−# - quickcheck-arbitrary-template-0.2.0.0
13−# - quickcheck-properties-0.1
14−
15−resolver: lts-12.6
stack-8.4.yaml.lockdeleted−12
@@ -1,12 +0,0 @@
1−# This file was autogenerated by Stack.
2−# You should not edit this file by hand.
3−# For more information, please see the documentation at:
4−# https://docs.haskellstack.org/en/stable/lock_files
5−
6−packages: []
7−snapshots:
8−- completed:
9− size: 502349
10− url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/12/6.yaml
11− sha256: fbce9f11b2f1c637855eb29fe952f3ac16c35d46836df0dee0cc54a85e1e33d6
12− original: lts-12.6
stack-8.6.yamldeleted−14
@@ -1,14 +0,0 @@
1−flags:
2− bloodhound-examples:
3− werror: true
4−
5−packages:
6− - '.'
7− - './examples'
8−
9−extra-deps:
10− - git: https://github.com/bitemyapp/quickcheck-arbitrary-template.git
11− commit: bf9cee96a88ecce2ff920ce74c166a38712e5ed2
12− - quickcheck-properties-0.1
13−
14−resolver: lts-13.30
stack-8.6.yaml.lockdeleted−33
@@ -1,33 +0,0 @@
1−# This file was autogenerated by Stack.
2−# You should not edit this file by hand.
3−# For more information, please see the documentation at:
4−# https://docs.haskellstack.org/en/stable/lock_files
5−
6−packages:
7−- completed:
8− cabal-file:
9− size: 2026
10− sha256: d340ae2f3fd0b54b2f899d482072be24f41eddac8ea081f11d9db260b14264c8
11− name: quickcheck-arbitrary-template
12− version: 0.2.0.0
13− git: https://github.com/bitemyapp/quickcheck-arbitrary-template.git
14− pantry-tree:
15− size: 859
16− sha256: a6c70780465af154ada9481c0a5ffcda1b069d249522634c578218c3c390cbf1
17− commit: bf9cee96a88ecce2ff920ce74c166a38712e5ed2
18− original:
19− git: https://github.com/bitemyapp/quickcheck-arbitrary-template.git
20− commit: bf9cee96a88ecce2ff920ce74c166a38712e5ed2
21−- completed:
22− hackage: quickcheck-properties-0.1@sha256:3bd0890e84ec4cf1c1e6e475152c2c0d7c85915a051cf4e8bf9ec70c32df735c,1268
23− pantry-tree:
24− size: 550
25− sha256: 12264d8a89883b42e78c313792f8cba9af51c8fda915fce34e9780ff6972cf7e
26− original:
27− hackage: quickcheck-properties-0.1
28−snapshots:
29−- completed:
30− size: 500539
31− url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/13/30.yaml
32− sha256: 59ad6b944c9903847fecdc1d4815e8500c1f9999d80fd1b4d2d66e408faec44b
33− original: lts-13.30
stack.yaml+1−1
@@ -1 +1 @@
1−stack-8.6.yaml
1+stack-7.10.yaml
stack.yaml.lockdeleted−12
@@ -1,12 +0,0 @@
1−# This file was autogenerated by Stack.
2−# You should not edit this file by hand.
3−# For more information, please see the documentation at:
4−# https://docs.haskellstack.org/en/stable/lock_files
5−
6−packages: []
7−snapshots:
8−- completed:
9− size: 500539
10− url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/13/30.yaml
11− sha256: 59ad6b944c9903847fecdc1d4815e8500c1f9999d80fd1b4d2d66e408faec44b
12− original: lts-13.30
tests/Test/Aggregation.hsdeleted−147
@@ -1,147 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Aggregation (spec) where
4−
5−import Test.Common
6−import Test.Import
7−
8−import Control.Error (fmapL, note)
9−import qualified Data.Map as M
10−import qualified Database.Bloodhound
11−
12−spec :: Spec
13−spec =
14− describe "Aggregation API" $ do
15− it "returns term aggregation results" $ withTestEnv $ do
16− _ <- insertData
17− let terms = TermsAgg $ mkTermsAggregation "user"
18− let search = mkAggregateSearch Nothing $ mkAggregations "users" terms
19− searchExpectAggs search
20− searchValidBucketAgg search "users" toTerms
21−
22− it "return sub-aggregation results" $ withTestEnv $ do
23− _ <- insertData
24− let subaggs = mkAggregations "age_agg" . TermsAgg $ mkTermsAggregation "age"
25− agg = TermsAgg $ (mkTermsAggregation "user") { termAggs = Just subaggs}
26− search = mkAggregateSearch Nothing $ mkAggregations "users" agg
27− reply <- searchByIndex testIndex search
28− let result = decode (responseBody reply) :: Maybe (SearchResult Tweet)
29− usersAggResults = result >>= aggregations >>= toTerms "users"
30− subAggResults = usersAggResults >>= (listToMaybe . buckets) >>= termsAggs >>= toTerms "age_agg"
31− subAddResultsExists = isJust subAggResults
32− liftIO $ subAddResultsExists `shouldBe` True
33−
34− it "returns cardinality aggregation results" $ withTestEnv $ do
35− _ <- insertData
36− let cardinality = CardinalityAgg $ mkCardinalityAggregation $ FieldName "user"
37− let search = mkAggregateSearch Nothing $ mkAggregations "users" cardinality
38− let search' = search { Database.Bloodhound.from = From 0, size = Size 0 }
39− searchExpectAggs search'
40− let docCountPair k n = (k, object ["value" .= Number n])
41− res <- searchTweets search'
42− liftIO $
43− fmap aggregations res `shouldBe` Right (Just (M.fromList [ docCountPair "users" 1]))
44−
45− it "returns stats aggregation results" $ withTestEnv $ do
46− _ <- insertData
47− let stats = StatsAgg $ mkStatsAggregation $ FieldName "age"
48− let search = mkAggregateSearch Nothing $ mkAggregations "users" stats
49− let search' = search { Database.Bloodhound.from = From 0, size = Size 0 }
50− searchExpectAggs search'
51− let statsAggRes k n = (k, object [ "max" .= Number n
52− , "avg" .= Number n
53− , "count" .= Number 1
54− , "min" .= Number n
55− , "sum" .= Number n])
56− res <- searchTweets search'
57− liftIO $
58− fmap aggregations res `shouldBe` Right (Just (M.fromList [ statsAggRes "users" 10000]))
59−
60− it "can give collection hint parameters to term aggregations" $ when' (atleast es13) $ withTestEnv $ do
61− _ <- insertData
62− let terms = TermsAgg $ (mkTermsAggregation "user") { termCollectMode = Just BreadthFirst }
63− let search = mkAggregateSearch Nothing $ mkAggregations "users" terms
64− searchExpectAggs search
65− searchValidBucketAgg search "users" toTerms
66−
67− -- One of these fails with 1.7.3
68− it "can give execution hint parameters to term aggregations" $ when' (atmost es11) $ withTestEnv $ do
69− _ <- insertData
70− searchTermsAggHint [Map, Ordinals]
71−
72− it "can give execution hint parameters to term aggregations" $ when' (is es12) $ withTestEnv $ do
73− _ <- insertData
74− searchTermsAggHint [GlobalOrdinals, GlobalOrdinalsHash, GlobalOrdinalsLowCardinality, Map, Ordinals]
75−
76− it "can give execution hint parameters to term aggregations" $ when' (atleast es12) $ withTestEnv $ do
77− _ <- insertData
78− searchTermsAggHint [GlobalOrdinals, GlobalOrdinalsHash, GlobalOrdinalsLowCardinality, Map]
79− -- One of the above.
80−
81− it "can execute value_count aggregations" $ withTestEnv $ do
82− _ <- insertData
83− _ <- insertOther
84− let ags = mkAggregations "user_count" (ValueCountAgg (FieldValueCount (FieldName "user"))) <>
85− mkAggregations "bogus_count" (ValueCountAgg (FieldValueCount (FieldName "bogus")))
86− let search = mkAggregateSearch Nothing ags
87− let docCountPair k n = (k, object ["value" .= Number n])
88− res <- searchTweets search
89− liftIO $
90− fmap aggregations res `shouldBe` Right (Just (M.fromList [ docCountPair "user_count" 2
91− , docCountPair "bogus_count" 0
92− ]))
93−
94− it "can execute date_range aggregations" $ withTestEnv $ do
95− let now = fromGregorian 2015 3 14
96− let ltAMonthAgo = UTCTime (fromGregorian 2015 3 1) 0
97− let ltAWeekAgo = UTCTime (fromGregorian 2015 3 10) 0
98− let oldDoc = exampleTweet { postDate = ltAMonthAgo }
99− let newDoc = exampleTweet { postDate = ltAWeekAgo }
100− _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings oldDoc (DocId "1")
101− _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings newDoc (DocId "2")
102− _ <- refreshIndex testIndex
103− let thisMonth = DateRangeFrom (DateMathExpr (DMDate now) [SubtractTime 1 DMMonth])
104− let thisWeek = DateRangeFrom (DateMathExpr (DMDate now) [SubtractTime 1 DMWeek])
105− let agg = DateRangeAggregation (FieldName "postDate") Nothing (thisMonth :| [thisWeek])
106− let ags = mkAggregations "date_ranges" (DateRangeAgg agg)
107− let search = mkAggregateSearch Nothing ags
108− res <- searchTweets search
109− liftIO $ hitsTotal . searchHits <$> res `shouldBe` Right 2
110− let bucks = do magrs <- fmapL show (aggregations <$> res)
111− agrs <- note "no aggregations returned" magrs
112− rawBucks <- note "no date_ranges aggregation" $ M.lookup "date_ranges" agrs
113− parseEither parseJSON rawBucks
114− let fromMonthT = UTCTime (fromGregorian 2015 2 14) 0
115− let fromWeekT = UTCTime (fromGregorian 2015 3 7) 0
116− liftIO $ buckets <$> bucks `shouldBe` Right [ DateRangeResult "2015-02-14T00:00:00.000Z-*"
117− (Just fromMonthT)
118− (Just "2015-02-14T00:00:00.000Z")
119− Nothing
120− Nothing
121− 2
122− Nothing
123− , DateRangeResult "2015-03-07T00:00:00.000Z-*"
124− (Just fromWeekT)
125− (Just "2015-03-07T00:00:00.000Z")
126− Nothing
127− Nothing
128− 1
129− Nothing
130− ]
131−
132− it "returns date histogram aggregation results" $ withTestEnv $ do
133− _ <- insertData
134− let histogram = DateHistogramAgg $ mkDateHistogram (FieldName "postDate") Minute
135− let search = mkAggregateSearch Nothing (mkAggregations "byDate" histogram)
136− searchExpectAggs search
137− searchValidBucketAgg search "byDate" toDateHistogram
138−
139− it "can execute missing aggregations" $ withTestEnv $ do
140− _ <- insertData
141− _ <- insertExtra
142− let ags = mkAggregations "missing_agg" (MissingAgg (MissingAggregation "extra"))
143− let search = mkAggregateSearch Nothing ags
144− let docCountPair k n = (k, object ["doc_count" .= Number n])
145− res <- searchTweets search
146− liftIO $
147− fmap aggregations res `shouldBe` Right (Just (M.fromList [docCountPair "missing_agg" 1]))
tests/Test/ApproxEq.hsdeleted−63
@@ -1,63 +0,0 @@
1−{-# LANGUAGE DefaultSignatures #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−
4−module Test.ApproxEq where
5−
6−import Database.Bloodhound
7−
8−import Test.Import
9−
10−import qualified Data.List.NonEmpty as NE
11−
12−-- | Typeclass for "equal where it matters". Use this to specify
13−-- less-strict equivalence for things such as lists that can wind up
14−-- in an unpredictable order
15−class ApproxEq a where
16− (=~) :: a -> a -> Bool
17−
18− showApproxEq :: a -> String
19− default showApproxEq :: (Show a) => a -> String
20− showApproxEq = show
21−
22−(==~) :: (ApproxEq a) => a -> a -> Property
23−a ==~ b = counterexample (showApproxEq a ++ " !=~ " ++ showApproxEq b) (a =~ b)
24−
25−instance ApproxEq NominalDiffTime where (=~) = (==)
26−instance ApproxEq Bool where (=~) = (==)
27−instance ApproxEq Int where (=~) = (==)
28−instance (Eq a, Show a) => ApproxEq (Maybe a) where (=~) = (==)
29−instance ApproxEq Char where
30− (=~) = (==)
31−
32−instance ApproxEq NodeAttrFilter where (=~) = (==)
33−instance ApproxEq NodeAttrName where (=~) = (==)
34−instance (Eq a, Show a) => ApproxEq (NonEmpty a) where (=~) = (==)
35−instance (ApproxEq l, Show l, ApproxEq r, Show r) => ApproxEq (Either l r) where
36− Left a =~ Left b = a =~ b
37− Right a =~ Right b = a =~ b
38− _ =~ _ = False
39− showApproxEq (Left x) = "Left " <> showApproxEq x
40− showApproxEq (Right x) = "Right " <> showApproxEq x
41−instance (ApproxEq a, Show a) => ApproxEq [a] where
42− as =~ bs = and (zipWith (=~) as bs)
43−instance ApproxEq ReplicaCount where (=~) = (==)
44−instance ApproxEq ReplicaBounds where (=~) = (==)
45−instance ApproxEq Bytes where (=~) = (==)
46−instance ApproxEq AllocationPolicy where (=~) = (==)
47−instance ApproxEq InitialShardCount where (=~) = (==)
48−instance ApproxEq FSType where (=~) = (==)
49−
50−-- | Due to the way nodeattrfilters get serialized here, they may come
51−-- out in a different order, but they are morally equivalent
52−instance ApproxEq UpdatableIndexSetting where
53− RoutingAllocationInclude a =~ RoutingAllocationInclude b =
54− NE.sort a =~ NE.sort b
55− RoutingAllocationExclude a =~ RoutingAllocationExclude b =
56− NE.sort a =~ NE.sort b
57− RoutingAllocationRequire a =~ RoutingAllocationRequire b =
58− NE.sort a =~ NE.sort b
59− a =~ b = a == b
60− showApproxEq (RoutingAllocationInclude xs) = show (RoutingAllocationInclude (NE.sort xs))
61− showApproxEq (RoutingAllocationExclude xs) = show (RoutingAllocationExclude (NE.sort xs))
62− showApproxEq (RoutingAllocationRequire xs) = show (RoutingAllocationRequire (NE.sort xs))
63− showApproxEq x = show x
tests/Test/BulkAPI.hsdeleted−95
@@ -1,95 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.BulkAPI (spec) where
4−
5−import Test.Common
6−import Test.Import
7−
8−import qualified Data.Vector as V
9−import qualified Lens.Micro.Aeson as LMA
10−
11−newtype BulkTest =
12− BulkTest Text
13− deriving (Eq, Show)
14−
15−instance ToJSON BulkTest where
16− toJSON (BulkTest name') =
17− object ["name" .= name']
18−
19−instance FromJSON BulkTest where
20− parseJSON = withObject "BulkTest" parse
21− where
22− parse o = do
23− t <- o .: "name"
24− BulkTest <$> parseJSON t
25−
26−spec :: Spec
27−spec =
28− describe "Bulk API" $
29− it "inserts all documents we request" $ withTestEnv $ do
30− _ <- insertData
31− let firstTest = BulkTest "blah"
32− let secondTest = BulkTest "bloo"
33− let thirdTest = BulkTest "graffle"
34− let fourthTest = BulkTest "garabadoo"
35− let fifthTest = BulkTest "serenity"
36− let firstDoc = BulkIndex testIndex
37− testMapping (DocId "2") (toJSON firstTest)
38− let secondDoc = BulkCreate testIndex
39− testMapping (DocId "3") (toJSON secondTest)
40− let thirdDoc = BulkCreateEncoding testIndex
41− testMapping (DocId "4") (toEncoding thirdTest)
42− let fourthDoc = BulkIndexAuto testIndex
43− testMapping (toJSON fourthTest)
44− let fifthDoc = BulkIndexEncodingAuto testIndex
45− testMapping (toEncoding fifthTest)
46− let stream = V.fromList [firstDoc, secondDoc, thirdDoc, fourthDoc, fifthDoc]
47− _ <- bulk stream
48− -- liftIO $ pPrint bulkResp
49− _ <- refreshIndex testIndex
50− -- liftIO $ pPrint refreshResp
51− fDoc <- getDocument testIndex testMapping (DocId "2")
52− sDoc <- getDocument testIndex testMapping (DocId "3")
53− tDoc <- getDocument testIndex testMapping (DocId "4")
54− -- note that we cannot query for fourthDoc and fifthDoc since we
55− -- do not know their autogenerated ids.
56− let maybeFirst =
57− eitherDecode
58− $ responseBody fDoc
59− :: Either String (EsResult BulkTest)
60− let maybeSecond =
61− eitherDecode
62− $ responseBody sDoc
63− :: Either String (EsResult BulkTest)
64− let maybeThird =
65− eitherDecode
66− $ responseBody tDoc
67− :: Either String (EsResult BulkTest)
68− -- liftIO $ pPrint [maybeFirst, maybeSecond, maybeThird]
69− liftIO $ do
70− fmap getSource maybeFirst `shouldBe` Right (Just firstTest)
71− fmap getSource maybeSecond `shouldBe` Right (Just secondTest)
72− fmap getSource maybeThird `shouldBe` Right (Just thirdTest)
73− -- Since we can't get the docs by doc id, we check for their existence in
74− -- a match all query.
75− let query = MatchAllQuery Nothing
76− let search = mkSearch (Just query) Nothing
77− resp <- searchByIndex testIndex search
78− parsed <- parseEsResponse resp :: BH IO (Either EsError (SearchResult Value))
79− case parsed of
80− Left e ->
81− liftIO $ expectationFailure ("Expected a script-transformed result but got: " <> show e)
82− (Right sr) -> do
83− liftIO $
84− hitsTotal (searchHits sr) `shouldBe` 6
85− let nameList :: [Text]
86− nameList =
87− hits (searchHits sr)
88− ^.. traverse
89− . to hitSource
90− . _Just
91− . LMA.key "name"
92− . _String
93− liftIO $
94− nameList
95− `shouldBe` ["blah","bloo","graffle","garabadoo","serenity"]
tests/Test/Common.hsdeleted−292
@@ -1,292 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE TemplateHaskell #-}
3−
4−module Test.Common where
5−
6−import Test.Import
7−
8−import qualified Data.Map as M
9−import qualified Data.SemVer as SemVer
10−import qualified Network.HTTP.Types.Status as NHTS
11−
12−testServer :: Server
13−testServer = Server "http://localhost:9200"
14−testIndex :: IndexName
15−testIndex = IndexName "bloodhound-tests-twitter-1"
16−testMapping :: MappingName
17−testMapping = MappingName "tweet"
18−
19−withTestEnv :: BH IO a -> IO a
20−withTestEnv = withBH defaultManagerSettings testServer
21−
22−data Location = Location { lat :: Double
23− , lon :: Double } deriving (Eq, Show)
24−
25−data Tweet = Tweet { user :: Text
26− , postDate :: UTCTime
27− , message :: Text
28− , age :: Int
29− , location :: Location
30− , extra :: Maybe Text }
31− deriving (Eq, Show)
32−
33−$(deriveJSON defaultOptions ''Location)
34−$(deriveJSON defaultOptions ''Tweet)
35−
36−data ParentMapping = ParentMapping deriving (Eq, Show)
37−
38−instance ToJSON ParentMapping where
39− toJSON ParentMapping =
40− object ["properties" .=
41− object [ "user" .= object ["type" .= ("string" :: Text)
42− , "fielddata" .= True
43− ]
44− -- Serializing the date as a date is breaking other tests, mysteriously.
45− -- , "postDate" .= object [ "type" .= ("date" :: Text)
46− -- , "format" .= ("YYYY-MM-dd`T`HH:mm:ss.SSSZZ" :: Text)]
47− , "message" .= object ["type" .= ("string" :: Text)]
48− , "age" .= object ["type" .= ("integer" :: Text)]
49− , "location" .= object ["type" .= ("geo_point" :: Text)]
50− , "extra" .= object ["type" .= ("keyword" :: Text)]
51− ]]
52−
53−es11 :: SemVer.Version
54−es11 = SemVer.version 1 1 0 [] []
55−
56−es13 :: SemVer.Version
57−es13 = SemVer.version 1 3 0 [] []
58−
59−es12 :: SemVer.Version
60−es12 = SemVer.version 1 2 0 [] []
61−
62−es14 :: SemVer.Version
63−es14 = SemVer.version 1 4 0 [] []
64−
65−es15 :: SemVer.Version
66−es15 = SemVer.version 1 5 0 [] []
67−
68−es16 :: SemVer.Version
69−es16 = SemVer.version 1 6 0 [] []
70−
71−es20 :: SemVer.Version
72−es20 = SemVer.version 2 0 0 [] []
73−
74−es50 :: SemVer.Version
75−es50 = SemVer.version 5 0 0 [] []
76−
77−getServerVersion :: IO (Maybe SemVer.Version)
78−getServerVersion = fmap extractVersion <$> withTestEnv getStatus
79− where
80− extractVersion = versionNumber . number . version
81−
82−createExampleIndex :: (MonadBH m) => m Reply
83−createExampleIndex =
84− createIndex (IndexSettings (ShardCount 1) (ReplicaCount 0)) testIndex
85−
86−deleteExampleIndex :: (MonadBH m) => m Reply
87−deleteExampleIndex =
88− deleteIndex testIndex
89−
90−validateStatus :: Show body => Response body -> Int -> Expectation
91−validateStatus resp expected =
92− if actual == expected
93− then return ()
94− else expectationFailure ("Expected " <> show expected <> " but got " <> show actual <> ": " <> show body)
95− where
96− actual = NHTS.statusCode (responseStatus resp)
97− body = responseBody resp
98−
99−data ChildMapping = ChildMapping deriving (Eq, Show)
100−
101−instance ToJSON ChildMapping where
102− toJSON ChildMapping =
103− object ["_parent" .= object ["type" .= ("parent" :: Text)]
104− , "properties" .=
105− object [ "user" .= object ["type" .= ("string" :: Text)
106− , "fielddata" .= True
107− ]
108− -- Serializing the date as a date is breaking other tests, mysteriously.
109− -- , "postDate" .= object [ "type" .= ("date" :: Text)
110− -- , "format" .= ("YYYY-MM-dd`T`HH:mm:ss.SSSZZ" :: Text)]
111− , "message" .= object ["type" .= ("string" :: Text)]
112− , "age" .= object ["type" .= ("integer" :: Text)]
113− , "location" .= object ["type" .= ("geo_point" :: Text)]
114− , "extra" .= object ["type" .= ("keyword" :: Text)]
115− ]]
116−
117−data TweetMapping = TweetMapping deriving (Eq, Show)
118−
119−instance ToJSON TweetMapping where
120− toJSON TweetMapping =
121− object ["tweet" .=
122− object ["properties" .=
123− object [ "user" .= object [ "type" .= ("string" :: Text)
124− , "fielddata" .= True
125− ]
126− -- Serializing the date as a date is breaking other tests, mysteriously.
127− -- , "postDate" .= object [ "type" .= ("date" :: Text)
128− -- , "format" .= ("YYYY-MM-dd`T`HH:mm:ss.SSSZZ" :: Text)]
129− , "message" .= object ["type" .= ("string" :: Text)]
130− , "age" .= object ["type" .= ("integer" :: Text)]
131− , "location" .= object ["type" .= ("geo_point" :: Text)]
132− , "extra" .= object ["type" .= ("keyword" :: Text)]
133− ]]]
134−
135−exampleTweet :: Tweet
136−exampleTweet = Tweet { user = "bitemyapp"
137− , postDate = UTCTime
138− (ModifiedJulianDay 55000)
139− (secondsToDiffTime 10)
140− , message = "Use haskell!"
141− , age = 10000
142− , location = Location 40.12 (-71.34)
143− , extra = Nothing }
144−
145−tweetWithExtra :: Tweet
146−tweetWithExtra = Tweet { user = "bitemyapp"
147− , postDate = UTCTime
148− (ModifiedJulianDay 55000)
149− (secondsToDiffTime 10)
150− , message = "Use haskell!"
151− , age = 10000
152− , location = Location 40.12 (-71.34)
153− , extra = Just "blah blah" }
154−
155−newAge :: Int
156−newAge = 31337
157−
158−newUser :: Text
159−newUser = "someotherapp"
160−
161−tweetPatch :: Value
162−tweetPatch =
163− object [ "age" .= newAge
164− , "user" .= newUser
165− ]
166−
167−patchedTweet :: Tweet
168−patchedTweet = exampleTweet{age = newAge, user = newUser}
169−
170−otherTweet :: Tweet
171−otherTweet = Tweet { user = "notmyapp"
172− , postDate = UTCTime
173− (ModifiedJulianDay 55000)
174− (secondsToDiffTime 11)
175− , message = "Use haskell!"
176− , age = 1000
177− , location = Location 40.12 (-71.34)
178− , extra = Nothing }
179−
180−resetIndex :: BH IO ()
181−resetIndex = do
182− _ <- deleteExampleIndex
183− _ <- createExampleIndex
184− _ <- putMapping testIndex testMapping TweetMapping
185− return ()
186−
187−insertData :: BH IO Reply
188−insertData = do
189− resetIndex
190− insertData' defaultIndexDocumentSettings
191−
192−insertData' :: IndexDocumentSettings -> BH IO Reply
193−insertData' ids = do
194− r <- indexDocument testIndex testMapping ids exampleTweet (DocId "1")
195− _ <- refreshIndex testIndex
196− return r
197−
198−updateData :: BH IO Reply
199−updateData = do
200− r <- updateDocument testIndex testMapping defaultIndexDocumentSettings tweetPatch (DocId "1")
201− _ <- refreshIndex testIndex
202− return r
203−
204−insertOther :: BH IO ()
205−insertOther = do
206− _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings otherTweet (DocId "2")
207− _ <- refreshIndex testIndex
208− return ()
209−
210−insertExtra :: BH IO ()
211−insertExtra = do
212− _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings tweetWithExtra (DocId "4")
213− _ <- refreshIndex testIndex
214− return ()
215−
216−insertWithSpaceInId :: BH IO ()
217−insertWithSpaceInId = do
218− _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings exampleTweet (DocId "Hello World")
219− _ <- refreshIndex testIndex
220− return ()
221−
222−searchTweet :: Search -> BH IO (Either EsError Tweet)
223−searchTweet search = do
224− result <- searchTweets search
225− let myTweet :: Either EsError Tweet
226− myTweet = grabFirst result
227− return myTweet
228−
229−searchTweets :: Search -> BH IO (Either EsError (SearchResult Tweet))
230−searchTweets search = parseEsResponse =<< searchByIndex testIndex search
231−
232−searchExpectNoResults :: Search -> BH IO ()
233−searchExpectNoResults search = do
234− result <- searchTweets search
235− let emptyHits = fmap (hits . searchHits) result
236− liftIO $
237− emptyHits `shouldBe` Right []
238−
239−searchExpectAggs :: Search -> BH IO ()
240−searchExpectAggs search = do
241− reply <- searchByIndex testIndex search
242− let isEmpty x = return (M.null x)
243− let result = decode (responseBody reply) :: Maybe (SearchResult Tweet)
244− liftIO $
245− (result >>= aggregations >>= isEmpty) `shouldBe` Just False
246−
247−searchValidBucketAgg :: (BucketAggregation a, FromJSON a, Show a) =>
248− Search -> Text -> (Text -> AggregationResults -> Maybe (Bucket a)) -> BH IO ()
249−searchValidBucketAgg search aggKey extractor = do
250− reply <- searchByIndex testIndex search
251− let bucketDocs = docCount . head . buckets
252− let result = decode (responseBody reply) :: Maybe (SearchResult Tweet)
253− let count = result >>= aggregations >>= extractor aggKey >>= \x -> return (bucketDocs x)
254− liftIO $
255− count `shouldBe` Just 1
256−
257−searchTermsAggHint :: [ExecutionHint] -> BH IO ()
258−searchTermsAggHint hints = do
259− let terms hint = TermsAgg $ (mkTermsAggregation "user") { termExecutionHint = Just hint }
260− let search hint = mkAggregateSearch Nothing $ mkAggregations "users" $ terms hint
261− forM_ hints $ searchExpectAggs . search
262− forM_ hints (\x -> searchValidBucketAgg (search x) "users" toTerms)
263−
264−searchTweetHighlight :: Search
265− -> BH IO (Either EsError (Maybe HitHighlight))
266−searchTweetHighlight search = do
267− result <- searchTweets search
268− let tweetHit :: Either EsError (Maybe (Hit Tweet))
269− tweetHit = fmap (headMay . hits . searchHits) result
270− myHighlight :: Either EsError (Maybe HitHighlight)
271− myHighlight = (join . fmap hitHighlight) <$> tweetHit
272− return myHighlight
273−
274−searchExpectSource :: Source -> Either EsError Value -> BH IO ()
275−searchExpectSource src expected = do
276− _ <- insertData
277− let query = QueryMatchQuery $ mkMatchQuery (FieldName "_all") (QueryString "haskell")
278− let search = (mkSearch (Just query) Nothing) { source = Just src }
279− reply <- searchByIndex testIndex search
280− result <- parseEsResponse reply
281− let value = grabFirst result
282− liftIO $
283− value `shouldBe` expected
284−
285−atleast :: SemVer.Version -> IO Bool
286−atleast v = getServerVersion >>= \x -> return $ x >= Just v
287−
288−atmost :: SemVer.Version -> IO Bool
289−atmost v = getServerVersion >>= \x -> return $ x <= Just v
290−
291−is :: SemVer.Version -> IO Bool
292−is v = getServerVersion >>= \x -> return $ x == Just v
tests/Test/Documents.hsdeleted−51
@@ -1,51 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Documents where
4−
5−import Test.Common
6−import Test.Import
7−
8−spec :: Spec
9−spec =
10− describe "document API" $ do
11− it "indexes, updates, gets, and then deletes the generated document" $ withTestEnv $ do
12− _ <- insertData
13− _ <- updateData
14− docInserted <- getDocument testIndex testMapping (DocId "1")
15− let newTweet = eitherDecode
16− (responseBody docInserted) :: Either String (EsResult Tweet)
17− liftIO $ fmap getSource newTweet `shouldBe` Right (Just patchedTweet)
18−
19− it "indexes, gets, and then deletes the generated document with a DocId containing a space" $ withTestEnv $ do
20− _ <- insertWithSpaceInId
21− docInserted <- getDocument testIndex testMapping (DocId "Hello World")
22− let newTweet = eitherDecode
23− (responseBody docInserted) :: Either String (EsResult Tweet)
24− liftIO $ fmap getSource newTweet `shouldBe` Right (Just exampleTweet)
25−
26− it "produces a parseable result when looking up a bogus document" $ withTestEnv $ do
27− doc <- getDocument testIndex testMapping (DocId "bogus")
28− let noTweet = eitherDecode
29− (responseBody doc) :: Either String (EsResult Tweet)
30− liftIO $ fmap foundResult noTweet `shouldBe` Right Nothing
31−
32− it "can use optimistic concurrency control" $ withTestEnv $ do
33− let ev = ExternalDocVersion minBound
34− let cfg = defaultIndexDocumentSettings { idsVersionControl = ExternalGT ev }
35− resetIndex
36− res <- insertData' cfg
37− liftIO $ isCreated res `shouldBe` True
38− res' <- insertData' cfg
39− liftIO $ isVersionConflict res' `shouldBe` True
40−
41− it "indexes two documents in a parent/child relationship and checks that the child exists" $ withTestEnv $ do
42− resetIndex
43− _ <- putMapping testIndex (MappingName "child") ChildMapping
44− _ <- putMapping testIndex (MappingName "parent") ParentMapping
45− _ <- indexDocument testIndex (MappingName "parent") defaultIndexDocumentSettings exampleTweet (DocId "1")
46− let parent = (Just . DocumentParent . DocId) "1"
47− ids = IndexDocumentSettings NoVersionControl parent
48− _ <- indexDocument testIndex (MappingName "child") ids otherTweet (DocId "2")
49− _ <- refreshIndex testIndex
50− exists <- documentExists testIndex (MappingName "child") parent (DocId "2")
51− liftIO $ exists `shouldBe` True
tests/Test/Generators.hsdeleted−563
@@ -1,563 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE TemplateHaskell #-}
5−
6−module Test.Generators where
7−
8−import Database.Bloodhound
9−
10−import Test.Import
11−
12−import qualified Data.HashMap.Strict as HM
13−import qualified Data.List as L
14−import qualified Data.List.NonEmpty as NE
15−import qualified Data.Map as M
16−import qualified Data.Text as T
17−import qualified Data.SemVer as SemVer
18−import Test.QuickCheck.TH.Generators
19−
20−import Test.ApproxEq
21−
22−instance Arbitrary NominalDiffTime where
23− arbitrary = fromInteger <$> arbitrary
24−
25−#if !MIN_VERSION_QuickCheck(2,8,0)
26−instance (Arbitrary k, Ord k, Arbitrary v) => Arbitrary (M.Map k v) where
27− arbitrary = M.fromList <$> arbitrary
28−#endif
29−
30−instance Arbitrary Text where
31− arbitrary = T.pack <$> arbitrary
32−
33−instance Arbitrary UTCTime where
34− arbitrary = UTCTime
35− <$> arbitrary
36− <*> (fromRational . toRational <$> choose (0::Double, 86400))
37−
38−instance Arbitrary Day where
39− arbitrary =
40− ModifiedJulianDay . (2000 +) <$> arbitrary
41− shrink =
42− (ModifiedJulianDay <$>) . shrink . toModifiedJulianDay
43−
44−#if !MIN_VERSION_QuickCheck(2,9,0)
45−instance Arbitrary a => Arbitrary (NonEmpty a) where
46− arbitrary = liftA2 (:|) arbitrary arbitrary
47−#endif
48−
49−arbitraryScore :: Gen Score
50−arbitraryScore = fmap getPositive <$> arbitrary
51−
52−instance (Arbitrary a, Typeable a) => Arbitrary (Hit a) where
53− arbitrary = Hit <$> arbitrary
54− <*> arbitrary
55− <*> arbitrary
56− <*> arbitraryScore
57− <*> arbitrary
58− <*> return Nothing
59− <*> arbitrary
60− <*> arbitrary
61−
62−instance Arbitrary HitFields where
63− arbitrary = pure (HitFields M.empty)
64− shrink = const []
65−
66−instance (Arbitrary a, Typeable a) => Arbitrary (SearchHits a) where
67− arbitrary = reduceSize $ do
68− tot <- getPositive <$> arbitrary
69− score <- arbitraryScore
70− hs <- arbitrary
71− return $ SearchHits tot score hs
72−
73−
74−reduceSize :: Gen a -> Gen a
75−reduceSize f = sized $ \n -> resize (n `div` 2) f
76−
77−arbitraryAlphaNum :: Gen Char
78−arbitraryAlphaNum = oneof [choose ('a', 'z')
79− ,choose ('A','Z')
80− , choose ('0', '9')]
81−
82−instance Arbitrary RoutingValue where
83− arbitrary = RoutingValue . T.pack <$> listOf1 arbitraryAlphaNum
84−
85−instance Arbitrary AliasRouting where
86− arbitrary = oneof [allAlias
87− ,one
88− ,theOther
89− ,both']
90− where one = GranularAliasRouting
91− <$> (Just <$> arbitrary)
92− <*> pure Nothing
93− theOther = GranularAliasRouting Nothing
94− <$> (Just <$> arbitrary)
95− both' = GranularAliasRouting
96− <$> (Just <$> arbitrary)
97− <*> (Just <$> arbitrary)
98− allAlias = AllAliasRouting <$> arbitrary
99−
100−
101−
102−instance Arbitrary FieldName where
103− arbitrary =
104− FieldName
105− . T.pack
106− <$> listOf1 arbitraryAlphaNum
107−
108−
109−#if MIN_VERSION_base(4,10,0)
110−-- Test.QuickCheck.Modifiers
111−
112−qcNonEmptyToNonEmpty :: NonEmptyList a -> NonEmpty a
113−qcNonEmptyToNonEmpty (NonEmpty (a : xs)) = (a :| xs)
114−qcNonEmptyToNonEmpty (NonEmpty []) = error "NonEmpty was empty!"
115−
116−instance Arbitrary a => Arbitrary (NonEmpty a) where
117− arbitrary =
118− qcNonEmptyToNonEmpty
119− <$> arbitrary
120−#endif
121−instance Arbitrary ScriptFields where
122− arbitrary =
123− pure $ ScriptFields $
124− HM.fromList []
125−
126− shrink = const []
127−
128−instance Arbitrary ScriptParams where
129− arbitrary =
130− pure $ ScriptParams $
131− HM.fromList [ ("a", Number 42)
132− , ("b", String "forty two")
133− ]
134−
135− shrink = const []
136−
137−instance Arbitrary RegexpFlags where
138− arbitrary = oneof [ pure AllRegexpFlags
139− , pure NoRegexpFlags
140− , SomeRegexpFlags <$> genUniqueFlags
141− ]
142− where genUniqueFlags =
143− NE.fromList . L.nub
144− <$> listOf1 arbitrary
145−
146−instance Arbitrary IndexAliasCreate where
147− arbitrary =
148− IndexAliasCreate
149− <$> arbitrary
150− <*> reduceSize arbitrary
151−
152−instance Arbitrary Query where
153− arbitrary =
154− reduceSize
155− $ oneof [ TermQuery <$> arbitrary <*> arbitrary
156− , TermsQuery <$> arbitrary <*> arbitrary
157− , QueryMatchQuery <$> arbitrary
158− , QueryMultiMatchQuery <$> arbitrary
159− , QueryBoolQuery <$> arbitrary
160− , QueryBoostingQuery <$> arbitrary
161− , QueryCommonTermsQuery <$> arbitrary
162− , ConstantScoreQuery <$> arbitrary <*> arbitrary
163− , QueryDisMaxQuery <$> arbitrary
164− , QueryFuzzyLikeThisQuery <$> arbitrary
165− , QueryFuzzyLikeFieldQuery <$> arbitrary
166− , QueryFuzzyQuery <$> arbitrary
167− , QueryHasChildQuery <$> arbitrary
168− , QueryHasParentQuery <$> arbitrary
169− , IdsQuery <$> arbitrary <*> arbitrary
170− , QueryIndicesQuery <$> arbitrary
171− , MatchAllQuery <$> arbitrary
172− , QueryMoreLikeThisQuery <$> arbitrary
173− , QueryMoreLikeThisFieldQuery <$> arbitrary
174− , QueryNestedQuery <$> arbitrary
175− , QueryPrefixQuery <$> arbitrary
176− , QueryQueryStringQuery <$> arbitrary
177− , QuerySimpleQueryStringQuery <$> arbitrary
178− , QueryRangeQuery <$> arbitrary
179− , QueryRegexpQuery <$> arbitrary
180− , QueryTemplateQueryInline <$> arbitrary
181− ]
182− -- TODO: Implement shrink
183− -- shrink = genericShrink
184−
185−instance Arbitrary Filter where
186− arbitrary =
187− Filter <$> arbitrary
188− shrink (Filter q) =
189− Filter <$> shrink q
190−
191−instance Arbitrary ReplicaBounds where
192− arbitrary = oneof [ replicasBounded
193− , replicasLowerBounded
194− , pure ReplicasUnbounded
195− ]
196− where replicasBounded = do
197− Positive a <- arbitrary
198− Positive b <- arbitrary
199− return (ReplicasBounded a b)
200− replicasLowerBounded = do
201− Positive a <- arbitrary
202− return (ReplicasLowerBounded a)
203−
204−instance Arbitrary NodeAttrName where
205− arbitrary =
206− NodeAttrName
207− . T.pack
208− <$> listOf1 arbitraryAlphaNum
209−
210−
211−instance Arbitrary NodeAttrFilter where
212− arbitrary = do
213− n <- arbitrary
214− xs <- listOf1 (listOf1 arbitraryAlphaNum)
215− let (s, ss) = unpackConsPartial xs
216− ts = T.pack <$> s :| ss
217− return (NodeAttrFilter n ts)
218− where -- listOf1 means this shouldn't blow up.
219− unpackConsPartial (x : xs) = (x, xs)
220− unpackConsPartial _ = error "unpackConsPartial failed but shouldn't have"
221−
222−instance Arbitrary VersionNumber where
223− arbitrary = do
224− major <- posInt
225− minor <- posInt
226− patch <- posInt
227− return $ VersionNumber $ SemVer.version major minor patch [] []
228− where
229− posInt = getPositive <$> arbitrary
230−
231−instance Arbitrary TemplateQueryKeyValuePairs where
232− arbitrary = TemplateQueryKeyValuePairs . HM.fromList <$> arbitrary
233− shrink (TemplateQueryKeyValuePairs x) = map (TemplateQueryKeyValuePairs . HM.fromList) . shrink $ HM.toList x
234−
235−makeArbitrary ''IndexName
236−instance Arbitrary IndexName where arbitrary = arbitraryIndexName
237−makeArbitrary ''MappingName
238−instance Arbitrary MappingName where arbitrary = arbitraryMappingName
239−makeArbitrary ''DocId
240−instance Arbitrary DocId where arbitrary = arbitraryDocId
241−makeArbitrary ''Version
242−instance Arbitrary Version where arbitrary = arbitraryVersion
243−makeArbitrary ''BuildHash
244−instance Arbitrary BuildHash where arbitrary = arbitraryBuildHash
245−makeArbitrary ''IndexAliasRouting
246−instance Arbitrary IndexAliasRouting where arbitrary = arbitraryIndexAliasRouting
247−makeArbitrary ''ShardCount
248−instance Arbitrary ShardCount where arbitrary = arbitraryShardCount
249−makeArbitrary ''ReplicaCount
250−instance Arbitrary ReplicaCount where arbitrary = arbitraryReplicaCount
251−makeArbitrary ''TemplateName
252−instance Arbitrary TemplateName where arbitrary = arbitraryTemplateName
253−makeArbitrary ''TemplatePattern
254−instance Arbitrary TemplatePattern where arbitrary = arbitraryTemplatePattern
255−makeArbitrary ''QueryString
256−instance Arbitrary QueryString where arbitrary = arbitraryQueryString
257−makeArbitrary ''CacheName
258−instance Arbitrary CacheName where arbitrary = arbitraryCacheName
259−makeArbitrary ''CacheKey
260−instance Arbitrary CacheKey where arbitrary = arbitraryCacheKey
261−makeArbitrary ''Existence
262−instance Arbitrary Existence where arbitrary = arbitraryExistence
263−makeArbitrary ''CutoffFrequency
264−instance Arbitrary CutoffFrequency where arbitrary = arbitraryCutoffFrequency
265−makeArbitrary ''Analyzer
266−instance Arbitrary Analyzer where arbitrary = arbitraryAnalyzer
267−makeArbitrary ''MaxExpansions
268−instance Arbitrary MaxExpansions where arbitrary = arbitraryMaxExpansions
269−makeArbitrary ''Lenient
270−instance Arbitrary Lenient where arbitrary = arbitraryLenient
271−makeArbitrary ''Tiebreaker
272−instance Arbitrary Tiebreaker where arbitrary = arbitraryTiebreaker
273−makeArbitrary ''Boost
274−instance Arbitrary Boost where arbitrary = arbitraryBoost
275−makeArbitrary ''BoostTerms
276−instance Arbitrary BoostTerms where arbitrary = arbitraryBoostTerms
277−makeArbitrary ''MinimumMatch
278−instance Arbitrary MinimumMatch where arbitrary = arbitraryMinimumMatch
279−makeArbitrary ''DisableCoord
280−instance Arbitrary DisableCoord where arbitrary = arbitraryDisableCoord
281−makeArbitrary ''IgnoreTermFrequency
282−instance Arbitrary IgnoreTermFrequency where arbitrary = arbitraryIgnoreTermFrequency
283−makeArbitrary ''MinimumTermFrequency
284−instance Arbitrary MinimumTermFrequency where arbitrary = arbitraryMinimumTermFrequency
285−makeArbitrary ''MaxQueryTerms
286−instance Arbitrary MaxQueryTerms where arbitrary = arbitraryMaxQueryTerms
287−makeArbitrary ''Fuzziness
288−instance Arbitrary Fuzziness where arbitrary = arbitraryFuzziness
289−makeArbitrary ''PrefixLength
290−instance Arbitrary PrefixLength where arbitrary = arbitraryPrefixLength
291−makeArbitrary ''TypeName
292−instance Arbitrary TypeName where arbitrary = arbitraryTypeName
293−makeArbitrary ''PercentMatch
294−instance Arbitrary PercentMatch where arbitrary = arbitraryPercentMatch
295−makeArbitrary ''StopWord
296−instance Arbitrary StopWord where arbitrary = arbitraryStopWord
297−makeArbitrary ''QueryPath
298−instance Arbitrary QueryPath where arbitrary = arbitraryQueryPath
299−makeArbitrary ''AllowLeadingWildcard
300−instance Arbitrary AllowLeadingWildcard where arbitrary = arbitraryAllowLeadingWildcard
301−makeArbitrary ''LowercaseExpanded
302−instance Arbitrary LowercaseExpanded where arbitrary = arbitraryLowercaseExpanded
303−makeArbitrary ''EnablePositionIncrements
304−instance Arbitrary EnablePositionIncrements where arbitrary = arbitraryEnablePositionIncrements
305−makeArbitrary ''AnalyzeWildcard
306−instance Arbitrary AnalyzeWildcard where arbitrary = arbitraryAnalyzeWildcard
307−makeArbitrary ''GeneratePhraseQueries
308−instance Arbitrary GeneratePhraseQueries where arbitrary = arbitraryGeneratePhraseQueries
309−makeArbitrary ''Locale
310−instance Arbitrary Locale where arbitrary = arbitraryLocale
311−makeArbitrary ''MaxWordLength
312−instance Arbitrary MaxWordLength where arbitrary = arbitraryMaxWordLength
313−makeArbitrary ''MinWordLength
314−instance Arbitrary MinWordLength where arbitrary = arbitraryMinWordLength
315−makeArbitrary ''PhraseSlop
316−instance Arbitrary PhraseSlop where arbitrary = arbitraryPhraseSlop
317−makeArbitrary ''MinDocFrequency
318−instance Arbitrary MinDocFrequency where arbitrary = arbitraryMinDocFrequency
319−makeArbitrary ''MaxDocFrequency
320−instance Arbitrary MaxDocFrequency where arbitrary = arbitraryMaxDocFrequency
321−makeArbitrary ''Regexp
322−instance Arbitrary Regexp where arbitrary = arbitraryRegexp
323−makeArbitrary ''SimpleQueryStringQuery
324−instance Arbitrary SimpleQueryStringQuery where arbitrary = arbitrarySimpleQueryStringQuery
325−makeArbitrary ''FieldOrFields
326−instance Arbitrary FieldOrFields where arbitrary = arbitraryFieldOrFields
327−makeArbitrary ''SimpleQueryFlag
328−instance Arbitrary SimpleQueryFlag where arbitrary = arbitrarySimpleQueryFlag
329−makeArbitrary ''RegexpQuery
330−instance Arbitrary RegexpQuery where arbitrary = arbitraryRegexpQuery
331−makeArbitrary ''QueryStringQuery
332−instance Arbitrary QueryStringQuery where arbitrary = arbitraryQueryStringQuery
333−makeArbitrary ''RangeQuery
334−instance Arbitrary RangeQuery where arbitrary = arbitraryRangeQuery
335−makeArbitrary ''RangeValue
336−instance Arbitrary RangeValue where arbitrary = arbitraryRangeValue
337−makeArbitrary ''PrefixQuery
338−instance Arbitrary PrefixQuery where arbitrary = arbitraryPrefixQuery
339−makeArbitrary ''NestedQuery
340−instance Arbitrary NestedQuery where arbitrary = arbitraryNestedQuery
341−makeArbitrary ''MoreLikeThisFieldQuery
342−instance Arbitrary MoreLikeThisFieldQuery where arbitrary = arbitraryMoreLikeThisFieldQuery
343−makeArbitrary ''MoreLikeThisQuery
344−instance Arbitrary MoreLikeThisQuery where arbitrary = arbitraryMoreLikeThisQuery
345−makeArbitrary ''IndicesQuery
346−instance Arbitrary IndicesQuery where arbitrary = arbitraryIndicesQuery
347−makeArbitrary ''HasParentQuery
348−instance Arbitrary HasParentQuery where arbitrary = arbitraryHasParentQuery
349−makeArbitrary ''HasChildQuery
350−instance Arbitrary HasChildQuery where arbitrary = arbitraryHasChildQuery
351−makeArbitrary ''FuzzyQuery
352−instance Arbitrary FuzzyQuery where arbitrary = arbitraryFuzzyQuery
353−makeArbitrary ''FuzzyLikeFieldQuery
354−instance Arbitrary FuzzyLikeFieldQuery where arbitrary = arbitraryFuzzyLikeFieldQuery
355−makeArbitrary ''FuzzyLikeThisQuery
356−instance Arbitrary FuzzyLikeThisQuery where arbitrary = arbitraryFuzzyLikeThisQuery
357−makeArbitrary ''DisMaxQuery
358−instance Arbitrary DisMaxQuery where arbitrary = arbitraryDisMaxQuery
359−makeArbitrary ''CommonTermsQuery
360−instance Arbitrary CommonTermsQuery where arbitrary = arbitraryCommonTermsQuery
361−makeArbitrary ''DistanceRange
362−instance Arbitrary DistanceRange where arbitrary = arbitraryDistanceRange
363−makeArbitrary ''MultiMatchQuery
364−instance Arbitrary MultiMatchQuery where arbitrary = arbitraryMultiMatchQuery
365−makeArbitrary ''LessThanD
366−instance Arbitrary LessThanD where arbitrary = arbitraryLessThanD
367−makeArbitrary ''LessThanEqD
368−instance Arbitrary LessThanEqD where arbitrary = arbitraryLessThanEqD
369−makeArbitrary ''GreaterThanD
370−instance Arbitrary GreaterThanD where arbitrary = arbitraryGreaterThanD
371−makeArbitrary ''GreaterThanEqD
372−instance Arbitrary GreaterThanEqD where arbitrary = arbitraryGreaterThanEqD
373−makeArbitrary ''LessThan
374−instance Arbitrary LessThan where arbitrary = arbitraryLessThan
375−makeArbitrary ''LessThanEq
376−instance Arbitrary LessThanEq where arbitrary = arbitraryLessThanEq
377−makeArbitrary ''GreaterThan
378−instance Arbitrary GreaterThan where arbitrary = arbitraryGreaterThan
379−makeArbitrary ''GreaterThanEq
380−instance Arbitrary GreaterThanEq where arbitrary = arbitraryGreaterThanEq
381−makeArbitrary ''GeoPoint
382−instance Arbitrary GeoPoint where arbitrary = arbitraryGeoPoint
383−makeArbitrary ''NullValue
384−instance Arbitrary NullValue where arbitrary = arbitraryNullValue
385−makeArbitrary ''MinimumMatchHighLow
386−instance Arbitrary MinimumMatchHighLow where arbitrary = arbitraryMinimumMatchHighLow
387−makeArbitrary ''CommonMinimumMatch
388−instance Arbitrary CommonMinimumMatch where arbitrary = arbitraryCommonMinimumMatch
389−makeArbitrary ''BoostingQuery
390−instance Arbitrary BoostingQuery where arbitrary = arbitraryBoostingQuery
391−makeArbitrary ''BoolQuery
392−instance Arbitrary BoolQuery where arbitrary = arbitraryBoolQuery
393−makeArbitrary ''MatchQuery
394−instance Arbitrary MatchQuery where arbitrary = arbitraryMatchQuery
395−makeArbitrary ''MultiMatchQueryType
396−instance Arbitrary MultiMatchQueryType where arbitrary = arbitraryMultiMatchQueryType
397−makeArbitrary ''BooleanOperator
398−instance Arbitrary BooleanOperator where arbitrary = arbitraryBooleanOperator
399−makeArbitrary ''ZeroTermsQuery
400−instance Arbitrary ZeroTermsQuery where arbitrary = arbitraryZeroTermsQuery
401−makeArbitrary ''MatchQueryType
402−instance Arbitrary MatchQueryType where arbitrary = arbitraryMatchQueryType
403−makeArbitrary ''SearchAliasRouting
404−instance Arbitrary SearchAliasRouting where arbitrary = arbitrarySearchAliasRouting
405−makeArbitrary ''ScoreType
406−instance Arbitrary ScoreType where arbitrary = arbitraryScoreType
407−makeArbitrary ''Distance
408−instance Arbitrary Distance where arbitrary = arbitraryDistance
409−makeArbitrary ''DistanceUnit
410−instance Arbitrary DistanceUnit where arbitrary = arbitraryDistanceUnit
411−makeArbitrary ''DistanceType
412−instance Arbitrary DistanceType where arbitrary = arbitraryDistanceType
413−makeArbitrary ''OptimizeBbox
414−instance Arbitrary OptimizeBbox where arbitrary = arbitraryOptimizeBbox
415−makeArbitrary ''GeoBoundingBoxConstraint
416−instance Arbitrary GeoBoundingBoxConstraint where arbitrary = arbitraryGeoBoundingBoxConstraint
417−makeArbitrary ''GeoFilterType
418−instance Arbitrary GeoFilterType where arbitrary = arbitraryGeoFilterType
419−makeArbitrary ''GeoBoundingBox
420−instance Arbitrary GeoBoundingBox where arbitrary = arbitraryGeoBoundingBox
421−makeArbitrary ''LatLon
422−instance Arbitrary LatLon where arbitrary = arbitraryLatLon
423−makeArbitrary ''RangeExecution
424−instance Arbitrary RangeExecution where arbitrary = arbitraryRangeExecution
425−makeArbitrary ''RegexpFlag
426−instance Arbitrary RegexpFlag where arbitrary = arbitraryRegexpFlag
427−makeArbitrary ''BoolMatch
428−instance Arbitrary BoolMatch where arbitrary = arbitraryBoolMatch
429−makeArbitrary ''Term
430−instance Arbitrary Term where arbitrary = arbitraryTerm
431−makeArbitrary ''IndexSettings
432−instance Arbitrary IndexSettings where arbitrary = arbitraryIndexSettings
433−makeArbitrary ''TokenChar
434−instance Arbitrary TokenChar where arbitrary = arbitraryTokenChar
435−makeArbitrary ''Ngram
436−instance Arbitrary Ngram where arbitrary = arbitraryNgram
437−makeArbitrary ''TokenizerDefinition
438−instance Arbitrary TokenizerDefinition where arbitrary = arbitraryTokenizerDefinition
439−makeArbitrary ''TokenFilter
440−instance Arbitrary TokenFilter where arbitrary = arbitraryTokenFilter
441−makeArbitrary ''TokenFilterDefinition
442−instance Arbitrary TokenFilterDefinition where arbitrary = arbitraryTokenFilterDefinition
443−makeArbitrary ''Language
444−instance Arbitrary Language where arbitrary = arbitraryLanguage
445−makeArbitrary ''Shingle
446−instance Arbitrary Shingle where arbitrary = arbitraryShingle
447−
448−makeArbitrary ''CharFilter
449−instance Arbitrary CharFilter where arbitrary = arbitraryCharFilter
450−makeArbitrary ''AnalyzerDefinition
451−instance Arbitrary AnalyzerDefinition where arbitrary = arbitraryAnalyzerDefinition
452−
453−-- TODO: This should have a proper generator that doesn't
454−-- create garbage that has to be filtered out.
455−instance Arbitrary CharFilterDefinition where
456− arbitrary =
457− oneof [ CharFilterDefinitionMapping
458− . chomp <$> arbitrary
459− , CharFilterDefinitionPatternReplace
460− <$> arbitrary <*> arbitrary <*> arbitrary
461− ]
462− where chomp =
463− M.map T.strip
464− . M.mapKeys (T.replace "=>" "" . T.strip)
465−
466−makeArbitrary ''Analysis
467−instance Arbitrary Analysis where arbitrary = arbitraryAnalysis
468−makeArbitrary ''Tokenizer
469−instance Arbitrary Tokenizer where arbitrary = arbitraryTokenizer
470−makeArbitrary ''Compression
471−instance Arbitrary Compression where arbitrary = arbitraryCompression
472−makeArbitrary ''Bytes
473−instance Arbitrary Bytes where arbitrary = arbitraryBytes
474−makeArbitrary ''AllocationPolicy
475−instance Arbitrary AllocationPolicy where arbitrary = arbitraryAllocationPolicy
476−makeArbitrary ''InitialShardCount
477−instance Arbitrary InitialShardCount where arbitrary = arbitraryInitialShardCount
478−makeArbitrary ''FSType
479−instance Arbitrary FSType where arbitrary = arbitraryFSType
480−makeArbitrary ''CompoundFormat
481−instance Arbitrary CompoundFormat where arbitrary = arbitraryCompoundFormat
482−makeArbitrary ''FsSnapshotRepo
483−instance Arbitrary FsSnapshotRepo where arbitrary = arbitraryFsSnapshotRepo
484−makeArbitrary ''SnapshotRepoName
485−instance Arbitrary SnapshotRepoName where arbitrary = arbitrarySnapshotRepoName
486−makeArbitrary ''TemplateQueryInline
487−instance Arbitrary TemplateQueryInline where arbitrary = arbitraryTemplateQueryInline
488−makeArbitrary ''DirectGeneratorSuggestModeTypes
489−instance Arbitrary DirectGeneratorSuggestModeTypes where arbitrary = arbitraryDirectGeneratorSuggestModeTypes
490−makeArbitrary ''DirectGenerators
491−instance Arbitrary DirectGenerators where arbitrary = arbitraryDirectGenerators
492−makeArbitrary ''PhraseSuggesterCollate
493−instance Arbitrary PhraseSuggesterCollate where arbitrary = arbitraryPhraseSuggesterCollate
494−makeArbitrary ''PhraseSuggesterHighlighter
495−instance Arbitrary PhraseSuggesterHighlighter where arbitrary = arbitraryPhraseSuggesterHighlighter
496−makeArbitrary ''Size
497−instance Arbitrary Size where arbitrary = arbitrarySize
498−makeArbitrary ''PhraseSuggester
499−instance Arbitrary PhraseSuggester where arbitrary = arbitraryPhraseSuggester
500−makeArbitrary ''SuggestType
501−instance Arbitrary SuggestType where arbitrary = arbitrarySuggestType
502−makeArbitrary ''Suggest
503−instance Arbitrary Suggest where arbitrary = arbitrarySuggest
504−
505−makeArbitrary ''FunctionScoreQuery
506−instance Arbitrary FunctionScoreQuery where arbitrary = arbitraryFunctionScoreQuery
507−
508−makeArbitrary ''FunctionScoreFunction
509−instance Arbitrary FunctionScoreFunction where arbitrary = arbitraryFunctionScoreFunction
510−makeArbitrary ''FunctionScoreFunctions
511−instance Arbitrary FunctionScoreFunctions where arbitrary = arbitraryFunctionScoreFunctions
512−makeArbitrary ''ComponentFunctionScoreFunction
513−instance Arbitrary ComponentFunctionScoreFunction where arbitrary = arbitraryComponentFunctionScoreFunction
514−makeArbitrary ''Script
515−instance Arbitrary Script where arbitrary = arbitraryScript
516−makeArbitrary ''ScriptLanguage
517−instance Arbitrary ScriptLanguage where arbitrary = arbitraryScriptLanguage
518−makeArbitrary ''ScriptInline
519−instance Arbitrary ScriptInline where arbitrary = arbitraryScriptInline
520−makeArbitrary ''ScriptId
521−instance Arbitrary ScriptId where arbitrary = arbitraryScriptId
522−makeArbitrary ''ScoreMode
523−instance Arbitrary ScoreMode where arbitrary = arbitraryScoreMode
524−makeArbitrary ''BoostMode
525−instance Arbitrary BoostMode where arbitrary = arbitraryBoostMode
526−makeArbitrary ''Seed
527−instance Arbitrary Seed where arbitrary = arbitrarySeed
528−makeArbitrary ''FieldValueFactor
529−instance Arbitrary FieldValueFactor where arbitrary = arbitraryFieldValueFactor
530−makeArbitrary ''Weight
531−instance Arbitrary Weight where arbitrary = arbitraryWeight
532−makeArbitrary ''Factor
533−instance Arbitrary Factor where arbitrary = arbitraryFactor
534−makeArbitrary ''FactorMissingFieldValue
535−instance Arbitrary FactorMissingFieldValue where arbitrary = arbitraryFactorMissingFieldValue
536−makeArbitrary ''FactorModifier
537−instance Arbitrary FactorModifier where arbitrary = arbitraryFactorModifier
538−
539−makeArbitrary ''UpdatableIndexSetting
540−instance Arbitrary UpdatableIndexSetting where
541− arbitrary = resize 10 arbitraryUpdatableIndexSetting
542−
543−newtype UpdatableIndexSetting' =
544− UpdatableIndexSetting' UpdatableIndexSetting
545− deriving (Show, Eq, ToJSON, FromJSON, ApproxEq, Typeable)
546−
547−instance Arbitrary UpdatableIndexSetting' where
548− arbitrary = do
549− settings <- arbitrary
550− return $ UpdatableIndexSetting' $ case settings of
551− RoutingAllocationInclude xs ->
552− RoutingAllocationInclude (dropDuplicateAttrNames xs)
553− RoutingAllocationExclude xs ->
554− RoutingAllocationExclude (dropDuplicateAttrNames xs)
555− RoutingAllocationRequire xs ->
556− RoutingAllocationRequire (dropDuplicateAttrNames xs)
557− x -> x
558− where
559− dropDuplicateAttrNames =
560− NE.fromList . L.nubBy sameAttrName . NE.toList
561− sameAttrName a b =
562− nodeAttrFilterName a == nodeAttrFilterName b
563− shrink (UpdatableIndexSetting' x) = map UpdatableIndexSetting' (shrink x)
tests/Test/Highlights.hsdeleted−32
@@ -1,32 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Highlights where
4−
5−import Test.Common
6−import Test.Import
7−
8−import qualified Data.Map as M
9−
10−initHighlights :: Text -> BH IO (Either EsError (Maybe HitHighlight))
11−initHighlights fieldName = do
12− _ <- insertData
13− _ <- insertOther
14− let query = QueryMatchQuery $ mkMatchQuery (FieldName fieldName) (QueryString "haskell")
15− let testHighlight = Highlights Nothing [FieldHighlight (FieldName fieldName) Nothing]
16− let search = mkHighlightSearch (Just query) testHighlight
17− searchTweetHighlight search
18−
19−spec :: Spec
20−spec =
21− describe "Highlights API" $ do
22− it "returns highlight from query when there should be one" $ withTestEnv $ do
23− myHighlight <- initHighlights "message"
24− liftIO $
25− myHighlight `shouldBe`
26− Right (Just (M.fromList [("message", ["Use <em>haskell</em>!"])]))
27−
28− it "doesn't return highlight from a query when it shouldn't" $ withTestEnv $ do
29− myHighlight <- initHighlights "user"
30− liftIO $
31− myHighlight `shouldBe`
32− Right Nothing
tests/Test/Import.hsdeleted−58
@@ -1,58 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Import
4− ( module X
5− , module Test.Import
6− ) where
7−
8−
9−import Control.Applicative as X
10−import Control.Exception as X (evaluate)
11−import Control.Monad as X
12−import Control.Monad.Catch as X
13−import Control.Monad.Reader as X
14−import Data.Aeson as X
15−import Data.Aeson.TH as X
16−import Data.Aeson.Types as X (parseEither)
17−import Data.Maybe as X
18−import Data.List.NonEmpty as X (NonEmpty(..))
19−import Data.Monoid as X
20−import Data.Ord as X (comparing)
21−import Data.Proxy as X
22−import Data.Text as X (Text)
23−import Data.Time.Calendar as X (Day(..), fromGregorian)
24−import Data.Time.Clock as X
25−import Data.Typeable as X
26−import Database.Bloodhound as X hiding (key)
27−import Lens.Micro as X
28−import Lens.Micro.Aeson as X
29−import Network.HTTP.Client as X hiding (Proxy, fileSize)
30−import System.IO.Temp as X
31−import System.PosixCompat.Files as X
32−import Test.Hspec as X
33−import Test.Hspec.QuickCheck as X (prop)
34−import Test.QuickCheck as X hiding (Result, Success, isSuccess)
35−import Test.QuickCheck.Property.Monoid as X (T (..), eq, prop_Monoid)
36−import Text.Pretty.Simple as X (pPrint)
37−
38−import qualified Data.List as L
39−
40−noDuplicates :: Eq a => [a] -> Bool
41−noDuplicates xs = L.nub xs == xs
42−
43−getSource :: EsResult a -> Maybe a
44−getSource = fmap _source . foundResult
45−
46−grabFirst :: Either EsError (SearchResult a) -> Either EsError a
47−grabFirst r =
48− case fmap (hitSource . head . hits . searchHits) r of
49− (Left e) -> Left e
50− (Right Nothing) -> Left (EsError 500 "Source was missing")
51− (Right (Just x)) -> Right x
52−
53−when' :: Monad m => m Bool -> m () -> m ()
54−when' b f = b >>= \x -> when x f
55−
56−headMay :: [a] -> Maybe a
57−headMay (x : _) = Just x
58−headMay _ = Nothing
tests/Test/Indices.hsdeleted−173
@@ -1,173 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Indices where
4−
5−import Test.Common
6−import Test.Import
7−
8−import qualified Data.List as L
9−import qualified Data.List.NonEmpty as NE
10−import qualified Data.Map as M
11−spec :: Spec
12−spec = do
13− describe "Index create/delete API" $ do
14− it "creates and then deletes the requested index" $ withTestEnv $ do
15− -- priming state.
16− _ <- deleteExampleIndex
17− resp <- createExampleIndex
18− deleteResp <- deleteExampleIndex
19− liftIO $ do
20− validateStatus resp 200
21− validateStatus deleteResp 200
22−
23− describe "Index aliases" $ do
24− let aname = IndexAliasName (IndexName "bloodhound-tests-twitter-1-alias")
25− let alias = IndexAlias (testIndex) aname
26− let create = IndexAliasCreate Nothing Nothing
27− let action = AddAlias alias create
28− it "handles the simple case of aliasing an existing index" $ do
29− withTestEnv $ do
30− resetIndex
31− resp <- updateIndexAliases (action :| [])
32− liftIO $ validateStatus resp 200
33− let cleanup = withTestEnv (updateIndexAliases (RemoveAlias alias :| []))
34− (do aliases <- withTestEnv getIndexAliases
35− let expected = IndexAliasSummary alias create
36− case aliases of
37− Right (IndexAliasesSummary summs) ->
38− L.find ((== alias) . indexAliasSummaryAlias) summs `shouldBe` Just expected
39− Left e -> expectationFailure ("Expected an IndexAliasesSummary but got " <> show e)) `finally` cleanup
40− it "allows alias deletion" $ do
41− aliases <- withTestEnv $ do
42− resetIndex
43− resp <- updateIndexAliases (action :| [])
44− liftIO $ validateStatus resp 200
45− _ <- deleteIndexAlias aname
46− getIndexAliases
47− -- let expected = IndexAliasSummary alias create
48− case aliases of
49− Right (IndexAliasesSummary summs) ->
50− L.find ( (== aname)
51− . indexAlias
52− . indexAliasSummaryAlias
53− ) summs
54− `shouldBe` Nothing
55− Left e -> expectationFailure ("Expected an IndexAliasesSummary but got " <> show e)
56−
57− describe "Index Listing" $ do
58− it "returns a list of index names" $ withTestEnv $ do
59− _ <- createExampleIndex
60− ixns <- listIndices
61− liftIO (ixns `shouldContain` [testIndex])
62−
63− describe "Index Settings" $ do
64− it "persists settings" $ withTestEnv $ do
65− _ <- deleteExampleIndex
66− _ <- createExampleIndex
67− let updates = BlocksWrite False :| []
68− updateResp <- updateIndexSettings updates testIndex
69− liftIO $ validateStatus updateResp 200
70− getResp <- getIndexSettings testIndex
71− liftIO $
72− getResp `shouldBe` Right (IndexSettingsSummary
73− testIndex
74− (IndexSettings (ShardCount 1) (ReplicaCount 0))
75− (NE.toList updates))
76−
77− it "allows total fields to be set" $ when' (atleast es50) $ withTestEnv $ do
78− _ <- deleteExampleIndex
79− _ <- createExampleIndex
80− let updates = MappingTotalFieldsLimit 2500 :| []
81− updateResp <- updateIndexSettings updates testIndex
82− liftIO $ validateStatus updateResp 200
83− getResp <- getIndexSettings testIndex
84− liftIO $
85− getResp `shouldBe` Right (IndexSettingsSummary
86− testIndex
87− (IndexSettings (ShardCount 1) (ReplicaCount 0))
88− (NE.toList updates))
89−
90− it "accepts customer analyzers" $ when' (atleast es50) $ withTestEnv $ do
91− _ <- deleteExampleIndex
92− let analysis = Analysis
93− (M.singleton "ex_analyzer"
94− ( AnalyzerDefinition
95− (Just (Tokenizer "ex_tokenizer"))
96− (map TokenFilter
97− [ "ex_filter_lowercase","ex_filter_uppercase","ex_filter_apostrophe"
98− , "ex_filter_reverse","ex_filter_snowball"
99− , "ex_filter_shingle"
100− ]
101− )
102− (map CharFilter
103− ["html_strip", "ex_mapping", "ex_pattern_replace"]
104− )
105− )
106− )
107− (M.singleton "ex_tokenizer"
108− ( TokenizerDefinitionNgram
109− ( Ngram 3 4 [TokenLetter,TokenDigit])
110− )
111− )
112− (M.fromList
113− [ ("ex_filter_lowercase",TokenFilterDefinitionLowercase (Just Greek))
114− , ("ex_filter_uppercase",TokenFilterDefinitionUppercase Nothing)
115− , ("ex_filter_apostrophe",TokenFilterDefinitionApostrophe)
116− , ("ex_filter_reverse",TokenFilterDefinitionReverse)
117− , ("ex_filter_snowball",TokenFilterDefinitionSnowball English)
118− , ("ex_filter_shingle",TokenFilterDefinitionShingle (Shingle 3 3 True False " " "_"))
119− , ("ex_filter_stemmer",TokenFilterDefinitionStemmer German)
120− , ("ex_filter_stop1", TokenFilterDefinitionStop (Left French))
121− , ("ex_filter_stop2",
122− TokenFilterDefinitionStop
123− (Right
124− $ map StopWord ["a", "is", "the"]))
125− ]
126− )
127− (M.fromList
128− [ ("ex_mapping", CharFilterDefinitionMapping (M.singleton "١" "1"))
129− , ("ex_pattern_replace", CharFilterDefinitionPatternReplace "(\\d+)-(?=\\d)" "$1_" Nothing)
130− ]
131− )
132− updates = [AnalysisSetting analysis]
133− createResp <- createIndexWith (updates ++ [NumberOfReplicas (ReplicaCount 0)]) 1 testIndex
134− liftIO $ validateStatus createResp 200
135− getResp <- getIndexSettings testIndex
136− liftIO $
137− getResp `shouldBe` Right (IndexSettingsSummary
138− testIndex
139− (IndexSettings (ShardCount 1) (ReplicaCount 0))
140− updates
141− )
142−
143− it "accepts default compression codec" $ when' (atleast es50) $ withTestEnv $ do
144− _ <- deleteExampleIndex
145− let updates = [CompressionSetting CompressionDefault]
146− createResp <- createIndexWith (updates ++ [NumberOfReplicas (ReplicaCount 0)]) 1 testIndex
147− liftIO $ validateStatus createResp 200
148− getResp <- getIndexSettings testIndex
149− liftIO $ getResp `shouldBe` Right
150− (IndexSettingsSummary testIndex (IndexSettings (ShardCount 1) (ReplicaCount 0)) updates)
151−
152− it "accepts best compression codec" $ when' (atleast es50) $ withTestEnv $ do
153− _ <- deleteExampleIndex
154− let updates = [CompressionSetting CompressionBest]
155− createResp <- createIndexWith (updates ++ [NumberOfReplicas (ReplicaCount 0)]) 1 testIndex
156− liftIO $ validateStatus createResp 200
157− getResp <- getIndexSettings testIndex
158− liftIO $ getResp `shouldBe` Right
159− (IndexSettingsSummary testIndex (IndexSettings (ShardCount 1) (ReplicaCount 0)) updates)
160−
161−
162− describe "Index Optimization" $ do
163− it "returns a successful response upon completion" $ withTestEnv $ do
164− _ <- createExampleIndex
165− resp <- forceMergeIndex (IndexList (testIndex :| [])) defaultForceMergeIndexSettings
166− liftIO $ validateStatus resp 200
167−
168−
169− describe "Index flushing" $ do
170− it "returns a successful response upon flushing" $ withTestEnv $ do
171− _ <- createExampleIndex
172− resp <- flushIndex testIndex
173− liftIO $ validateStatus resp 200
tests/Test/JSON.hsdeleted−213
@@ -1,213 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−
4−module Test.JSON (spec) where
5−
6−import Test.Import
7−
8−import qualified Data.ByteString.Lazy.Char8 as BL8
9−import qualified Data.List as L
10−import Data.List.NonEmpty (NonEmpty(..))
11−import qualified Data.List.NonEmpty as NE
12−import qualified Data.HashMap.Strict as HM
13−import qualified Data.Text as T
14−import qualified Data.Vector as V
15−
16−import Test.ApproxEq
17−import Test.Generators
18−
19−propJSON :: forall a
20− . ( Arbitrary a
21− , ToJSON a
22− , FromJSON a
23− , Show a
24− , Eq a
25− , Typeable a
26− )
27− => Proxy a -> Spec
28−propJSON _ = prop testName $ \(a :: a) ->
29− let jsonStr = "via " <> BL8.unpack (encode a)
30− in counterexample jsonStr (parseEither parseJSON (toJSON a)
31− === Right a)
32− where testName = show ty <> " FromJSON/ToJSON roundtrips"
33− ty = typeOf (undefined :: a)
34−
35−propApproxJSON :: forall a
36− . ( Arbitrary a
37− , ToJSON a
38− , FromJSON a
39− , Show a
40− , ApproxEq a
41− , Typeable a
42− )
43− => Proxy a -> Spec
44−propApproxJSON _ = prop testName $ \(a :: a) ->
45− let jsonStr = "via " <> BL8.unpack (encode a)
46− in counterexample jsonStr (parseEither parseJSON (toJSON a)
47− ==~ Right a)
48− where testName = show ty <> " FromJSON/ToJSON roundtrips"
49− ty = typeOf (undefined :: a)
50−
51−spec :: Spec
52−spec = do
53− describe "ToJSON RegexpFlags" $ do
54− it "generates the correct JSON for AllRegexpFlags" $
55− toJSON AllRegexpFlags `shouldBe` String "ALL"
56−
57− it "generates the correct JSON for NoRegexpFlags" $
58− toJSON NoRegexpFlags `shouldBe` String "NONE"
59−
60− it "generates the correct JSON for SomeRegexpFlags" $
61− let flags = AnyString :| [ Automaton
62− , Complement
63− , Empty
64− , Intersection
65− , Interval ]
66− in toJSON (SomeRegexpFlags flags) `shouldBe` String "ANYSTRING|AUTOMATON|COMPLEMENT|EMPTY|INTERSECTION|INTERVAL"
67−
68− prop "removes duplicates from flags" $ \(flags :: RegexpFlags) ->
69− let String str = toJSON flags
70− flagStrs = T.splitOn "|" str
71− in noDuplicates flagStrs
72−
73− describe "omitNulls" $ do
74− it "checks that omitNulls drops list elements when it should" $
75− let dropped = omitNulls $ [ "test1" .= (toJSON ([] :: [Int]))
76− , "test2" .= (toJSON ("some value" :: Text))]
77− in dropped `shouldBe` Object (HM.fromList [("test2", String "some value")])
78−
79− it "checks that omitNulls doesn't drop list elements when it shouldn't" $
80− let notDropped = omitNulls $ [ "test1" .= (toJSON ([1] :: [Int]))
81− , "test2" .= (toJSON ("some value" :: Text))]
82− in notDropped `shouldBe` Object (HM.fromList [ ("test1", Array (V.fromList [Number 1.0]))
83− , ("test2", String "some value")])
84− it "checks that omitNulls drops non list elements when it should" $
85− let dropped = omitNulls $ [ "test1" .= (toJSON Null)
86− , "test2" .= (toJSON ("some value" :: Text))]
87− in dropped `shouldBe` Object (HM.fromList [("test2", String "some value")])
88− it "checks that omitNulls doesn't drop non list elements when it shouldn't" $
89− let notDropped = omitNulls $ [ "test1" .= (toJSON (1 :: Int))
90− , "test2" .= (toJSON ("some value" :: Text))]
91− in notDropped `shouldBe` Object (HM.fromList [ ("test1", Number 1.0)
92− , ("test2", String "some value")])
93−
94− describe "Exact isomorphism JSON instances" $ do
95− propJSON (Proxy :: Proxy Version)
96− propJSON (Proxy :: Proxy IndexName)
97− propJSON (Proxy :: Proxy MappingName)
98− propJSON (Proxy :: Proxy DocId)
99− propJSON (Proxy :: Proxy IndexAliasRouting)
100− propJSON (Proxy :: Proxy RoutingValue)
101− propJSON (Proxy :: Proxy ShardCount)
102− propJSON (Proxy :: Proxy ReplicaCount)
103− propJSON (Proxy :: Proxy TemplateName)
104− propJSON (Proxy :: Proxy TemplatePattern)
105− propJSON (Proxy :: Proxy QueryString)
106− propJSON (Proxy :: Proxy FieldName)
107− propJSON (Proxy :: Proxy Script)
108− propJSON (Proxy :: Proxy ScriptLanguage)
109− propJSON (Proxy :: Proxy ScriptInline)
110− propJSON (Proxy :: Proxy ScriptId)
111− propJSON (Proxy :: Proxy ScriptParams)
112− propJSON (Proxy :: Proxy CacheName)
113− propJSON (Proxy :: Proxy CacheKey)
114− propJSON (Proxy :: Proxy Existence)
115− propJSON (Proxy :: Proxy CutoffFrequency)
116− propJSON (Proxy :: Proxy Analyzer)
117− propJSON (Proxy :: Proxy MaxExpansions)
118− propJSON (Proxy :: Proxy Lenient)
119− propJSON (Proxy :: Proxy Tiebreaker)
120− propJSON (Proxy :: Proxy Boost)
121− propJSON (Proxy :: Proxy BoostTerms)
122− propJSON (Proxy :: Proxy MinimumMatch)
123− propJSON (Proxy :: Proxy DisableCoord)
124− propJSON (Proxy :: Proxy IgnoreTermFrequency)
125− propJSON (Proxy :: Proxy MinimumTermFrequency)
126− propJSON (Proxy :: Proxy MaxQueryTerms)
127− propJSON (Proxy :: Proxy Fuzziness)
128− propJSON (Proxy :: Proxy PrefixLength)
129− propJSON (Proxy :: Proxy TypeName)
130− propJSON (Proxy :: Proxy PercentMatch)
131− propJSON (Proxy :: Proxy StopWord)
132− propJSON (Proxy :: Proxy QueryPath)
133− propJSON (Proxy :: Proxy AllowLeadingWildcard)
134− propJSON (Proxy :: Proxy LowercaseExpanded)
135− propJSON (Proxy :: Proxy EnablePositionIncrements)
136− propJSON (Proxy :: Proxy AnalyzeWildcard)
137− propJSON (Proxy :: Proxy GeneratePhraseQueries)
138− propJSON (Proxy :: Proxy Locale)
139− propJSON (Proxy :: Proxy MaxWordLength)
140− propJSON (Proxy :: Proxy MinWordLength)
141− propJSON (Proxy :: Proxy PhraseSlop)
142− propJSON (Proxy :: Proxy MinDocFrequency)
143− propJSON (Proxy :: Proxy MaxDocFrequency)
144− propJSON (Proxy :: Proxy Filter)
145− propJSON (Proxy :: Proxy Query)
146− propJSON (Proxy :: Proxy SimpleQueryStringQuery)
147− propJSON (Proxy :: Proxy FieldOrFields)
148− propJSON (Proxy :: Proxy SimpleQueryFlag)
149− propJSON (Proxy :: Proxy RegexpQuery)
150− propJSON (Proxy :: Proxy QueryStringQuery)
151− propJSON (Proxy :: Proxy RangeQuery)
152− propJSON (Proxy :: Proxy PrefixQuery)
153− propJSON (Proxy :: Proxy NestedQuery)
154− propJSON (Proxy :: Proxy MoreLikeThisFieldQuery)
155− propJSON (Proxy :: Proxy MoreLikeThisQuery)
156− propJSON (Proxy :: Proxy IndicesQuery)
157− propJSON (Proxy :: Proxy HasParentQuery)
158− propJSON (Proxy :: Proxy HasChildQuery)
159− propJSON (Proxy :: Proxy FuzzyQuery)
160− propJSON (Proxy :: Proxy FuzzyLikeFieldQuery)
161− propJSON (Proxy :: Proxy FuzzyLikeThisQuery)
162− propJSON (Proxy :: Proxy FunctionScoreQuery)
163− propJSON (Proxy :: Proxy BoostMode)
164− propJSON (Proxy :: Proxy ScoreMode)
165− propJSON (Proxy :: Proxy ComponentFunctionScoreFunction)
166− propJSON (Proxy :: Proxy FieldValueFactor)
167− propJSON (Proxy :: Proxy FactorModifier)
168− propJSON (Proxy :: Proxy DisMaxQuery)
169− propJSON (Proxy :: Proxy CommonTermsQuery)
170− propJSON (Proxy :: Proxy CommonMinimumMatch)
171− propJSON (Proxy :: Proxy BoostingQuery)
172− propJSON (Proxy :: Proxy BoolQuery)
173− propJSON (Proxy :: Proxy MatchQuery)
174− propJSON (Proxy :: Proxy MultiMatchQueryType)
175− propJSON (Proxy :: Proxy BooleanOperator)
176− propJSON (Proxy :: Proxy ZeroTermsQuery)
177− propJSON (Proxy :: Proxy MatchQueryType)
178− propJSON (Proxy :: Proxy AliasRouting)
179− propJSON (Proxy :: Proxy IndexAliasCreate)
180− propJSON (Proxy :: Proxy SearchAliasRouting)
181− propJSON (Proxy :: Proxy ScoreType)
182− propJSON (Proxy :: Proxy Distance)
183− propJSON (Proxy :: Proxy DistanceUnit)
184− propJSON (Proxy :: Proxy DistanceType)
185− propJSON (Proxy :: Proxy OptimizeBbox)
186− propJSON (Proxy :: Proxy GeoBoundingBoxConstraint)
187− propJSON (Proxy :: Proxy GeoFilterType)
188− propJSON (Proxy :: Proxy GeoBoundingBox)
189− propJSON (Proxy :: Proxy LatLon)
190− propJSON (Proxy :: Proxy RangeExecution)
191− prop "RegexpFlags FromJSON/ToJSON roundtrips, removing dups " $ \rfs ->
192− let expected = case rfs of
193− SomeRegexpFlags fs -> SomeRegexpFlags (NE.fromList (L.nub (NE.toList fs)))
194− x -> x
195− in parseEither parseJSON (toJSON rfs) === Right expected
196− propJSON (Proxy :: Proxy BoolMatch)
197− propJSON (Proxy :: Proxy Term)
198− propJSON (Proxy :: Proxy MultiMatchQuery)
199− propJSON (Proxy :: Proxy IndexSettings)
200− propJSON (Proxy :: Proxy CompoundFormat)
201− propJSON (Proxy :: Proxy TemplateQueryInline)
202− propJSON (Proxy :: Proxy Suggest)
203− propJSON (Proxy :: Proxy DirectGenerators)
204− propJSON (Proxy :: Proxy DirectGeneratorSuggestModeTypes)
205−
206− describe "Approximate isomorphism JSON instances" $ do
207− propApproxJSON (Proxy :: Proxy UpdatableIndexSetting')
208− propApproxJSON (Proxy :: Proxy ReplicaCount)
209− propApproxJSON (Proxy :: Proxy ReplicaBounds)
210− propApproxJSON (Proxy :: Proxy Bytes)
211− propApproxJSON (Proxy :: Proxy AllocationPolicy)
212− propApproxJSON (Proxy :: Proxy InitialShardCount)
213− propApproxJSON (Proxy :: Proxy FSType)
tests/Test/Query.hsdeleted−132
@@ -1,132 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Query where
4−
5−import Test.Common
6−import Test.Import
7−
8−import qualified Data.HashMap.Strict as HM
9−
10−spec :: Spec
11−spec =
12− describe "query API" $ do
13− it "returns document for term query and identity filter" $ withTestEnv $ do
14− _ <- insertData
15− let query = TermQuery (Term "user" "bitemyapp") Nothing
16− let filter' = Filter $ MatchAllQuery Nothing
17− let search = mkSearch (Just query) (Just filter')
18− myTweet <- searchTweet search
19− liftIO $
20− myTweet `shouldBe` Right exampleTweet
21−
22− it "handles constant score queries" $ withTestEnv $ do
23− _ <- insertData
24− let query = TermsQuery "user" ("bitemyapp" :| [])
25− let cfQuery = ConstantScoreQuery query (Boost 1.0)
26− let filter' = Filter $ MatchAllQuery Nothing
27− let search = mkSearch (Just cfQuery) (Just filter')
28− myTweet <- searchTweet search
29− liftIO $
30− myTweet `shouldBe` Right exampleTweet
31−
32− it "returns document for terms query and identity filter" $ withTestEnv $ do
33− _ <- insertData
34− let query = TermsQuery "user" ("bitemyapp" :| [])
35− let filter' = Filter $ MatchAllQuery Nothing
36− let search = mkSearch (Just query) (Just filter')
37− myTweet <- searchTweet search
38− liftIO $
39− myTweet `shouldBe` Right exampleTweet
40−
41− it "returns document for match query" $ withTestEnv $ do
42− _ <- insertData
43− let query = QueryMatchQuery $ mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
44− let search = mkSearch (Just query) Nothing
45− myTweet <- searchTweet search
46− liftIO $
47− myTweet `shouldBe` Right exampleTweet
48−
49− it "returns document for match query with fuzziness" $ withTestEnv $ do
50− _ <- insertData
51− let match = mkMatchQuery (FieldName "user") (QueryString "bidemyapp")
52− let query = QueryMatchQuery $ match { matchQueryFuzziness = Just FuzzinessAuto }
53− let search = mkSearch (Just query) Nothing
54− myTweet <- searchTweet search
55− liftIO $
56− myTweet `shouldBe` Right exampleTweet
57−
58− it "returns document for multi-match query" $ withTestEnv $ do
59− _ <- insertData
60− let flds = [FieldName "user", FieldName "message"]
61− let query = QueryMultiMatchQuery $ mkMultiMatchQuery flds (QueryString "bitemyapp")
62− let search = mkSearch (Just query) Nothing
63− myTweet <- searchTweet search
64− liftIO $
65− myTweet `shouldBe` Right exampleTweet
66−
67− it "returns document for multi-match query with a custom tiebreaker" $ withTestEnv $ do
68− _ <- insertData
69− let tiebreaker = Just $ Tiebreaker 0.3
70− flds = [FieldName "user", FieldName "message"]
71− multiQuery' = mkMultiMatchQuery flds (QueryString "bitemyapp")
72− query = QueryMultiMatchQuery $ multiQuery' { multiMatchQueryTiebreaker = tiebreaker }
73− search = mkSearch (Just query) Nothing
74− myTweet <- searchTweet search
75− liftIO $
76− myTweet `shouldBe` Right exampleTweet
77−
78− it "returns document for bool query" $ withTestEnv $ do
79− _ <- insertData
80− let innerQuery = QueryMatchQuery $
81− mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
82− let query = QueryBoolQuery $
83− mkBoolQuery [innerQuery] [] [] []
84− let search = mkSearch (Just query) Nothing
85− myTweet <- searchTweet search
86− liftIO $
87− myTweet `shouldBe` Right exampleTweet
88−
89− it "returns document for boosting query" $ withTestEnv $ do
90− _ <- insertData
91− let posQuery = QueryMatchQuery $ mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
92− let negQuery = QueryMatchQuery $ mkMatchQuery (FieldName "user") (QueryString "notmyapp")
93− let query = QueryBoostingQuery $ BoostingQuery posQuery negQuery (Boost 0.2)
94− let search = mkSearch (Just query) Nothing
95− myTweet <- searchTweet search
96− liftIO $
97− myTweet `shouldBe` Right exampleTweet
98−
99− it "returns document for common terms query" $ withTestEnv $ do
100− _ <- insertData
101− let query = QueryCommonTermsQuery $
102− CommonTermsQuery (FieldName "user")
103− (QueryString "bitemyapp")
104− (CutoffFrequency 0.0001)
105− Or Or Nothing Nothing Nothing Nothing
106− let search = mkSearch (Just query) Nothing
107− myTweet <- searchTweet search
108− liftIO $
109− myTweet `shouldBe` Right exampleTweet
110−
111− it "returns document for for inline template query" $ withTestEnv $ do
112− _ <- insertData
113− let innerQuery = QueryMatchQuery $
114− mkMatchQuery (FieldName "{{userKey}}")
115− (QueryString "{{bitemyappKey}}")
116− templateParams = TemplateQueryKeyValuePairs $ HM.fromList
117− [ ("userKey", "user")
118− , ("bitemyappKey", "bitemyapp")
119− ]
120− templateQuery = QueryTemplateQueryInline $
121− TemplateQueryInline innerQuery templateParams
122− search = mkSearch (Just templateQuery) Nothing
123− myTweet <- searchTweet search
124− liftIO $ myTweet `shouldBe` Right exampleTweet
125−
126− it "returns document for wildcard query" $ withTestEnv $ do
127− _ <- insertData
128− let query = QueryWildcardQuery $ WildcardQuery (FieldName "user") "bitemy*" (Nothing)
129− let search = mkSearch (Just query) Nothing
130− myTweet <- searchTweet search
131− liftIO $
132− myTweet `shouldBe` Right exampleTweet
tests/Test/Script.hsdeleted−36
@@ -1,36 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Script where
4−
5−import Test.Common
6−import Test.Import
7−
8−import qualified Data.HashMap.Strict as HM
9−import qualified Data.Map as M
10−
11−spec :: Spec
12−spec =
13− describe "Script" $
14− it "returns a transformed document based on the script field" $ withTestEnv $ do
15− _ <- insertData
16− let query = MatchAllQuery Nothing
17− sfv = toJSON $
18− Script
19− (Just (ScriptLanguage "painless"))
20− (Just (ScriptInline "doc['age'].value * 2"))
21− Nothing
22− Nothing
23− sf = ScriptFields $
24− HM.fromList [("test1", sfv)]
25− search' = mkSearch (Just query) Nothing
26− search = search' { scriptFields = Just sf }
27− resp <- searchByIndex testIndex search
28− parsed <- parseEsResponse resp :: BH IO (Either EsError (SearchResult Value))
29− case parsed of
30− Left e ->
31− liftIO $ expectationFailure ("Expected a script-transformed result but got: " <> show e)
32− Right sr -> do
33− let Just results =
34− hitFields (head (hits (searchHits sr)))
35− liftIO $
36− results `shouldBe` HitFields (M.fromList [("test1", [Number 20000.0])])
tests/Test/Snapshots.hsdeleted−201
@@ -1,201 +0,0 @@
1−{-# LANGUAGE RecordWildCards #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−
4−module Test.Snapshots (spec) where
5−
6−import Test.Common
7−import Test.Import
8−
9−import Data.Maybe (fromMaybe)
10−import qualified Data.List as L
11−import qualified Data.HashMap.Strict as HM
12−import qualified Data.Text as T
13−import qualified Data.Vector as V
14−import qualified Network.HTTP.Types.Method as NHTM
15−import qualified Network.URI as URI
16−
17−import Test.Generators ()
18−
19−spec :: Spec
20−spec = do
21− describe "FsSnapshotRepo" $
22− prop "SnapshotRepo laws" $ \fsr ->
23− fromGSnapshotRepo (toGSnapshotRepo fsr) === Right (fsr :: FsSnapshotRepo)
24−
25− describe "Snapshot repos" $ do
26− it "always parses all snapshot repos API" $ when' canSnapshot $ withTestEnv $ do
27− res <- getSnapshotRepos AllSnapshotRepos
28− liftIO $ case res of
29− Left e -> expectationFailure ("Expected a right but got Left " <> show e)
30− Right _ -> return ()
31−
32− it "finds an existing list of repos" $ when' canSnapshot $ withTestEnv $ do
33− let r1n = SnapshotRepoName "bloodhound-repo1"
34− let r2n = SnapshotRepoName "bloodhound-repo2"
35− withSnapshotRepo r1n $ \r1 ->
36− withSnapshotRepo r2n $ \r2 -> do
37− repos <- getSnapshotRepos (SnapshotRepoList (ExactRepo r1n :| [ExactRepo r2n]))
38− liftIO $ case repos of
39− Right xs -> do
40− let srt = L.sortBy (comparing gSnapshotRepoName)
41− srt xs `shouldBe` srt [r1, r2]
42− Left e -> expectationFailure (show e)
43−
44− it "creates and updates with updateSnapshotRepo" $ when' canSnapshot $ withTestEnv $ do
45− let r1n = SnapshotRepoName "bloodhound-repo1"
46− withSnapshotRepo r1n $ \r1 -> do
47− let Just (String dir) = HM.lookup "location" (gSnapshotRepoSettingsObject (gSnapshotRepoSettings r1))
48− let noCompression = FsSnapshotRepo r1n (T.unpack dir) False Nothing Nothing Nothing
49− resp <- updateSnapshotRepo defaultSnapshotRepoUpdateSettings noCompression
50− liftIO (validateStatus resp 200)
51− Right [roundtrippedNoCompression] <- getSnapshotRepos (SnapshotRepoList (ExactRepo r1n :| []))
52− liftIO (roundtrippedNoCompression `shouldBe` toGSnapshotRepo noCompression)
53−
54− -- verify came around in 1.4 it seems
55− it "can verify existing repos" $ when' canSnapshot $ when' (atleast es14) $ withTestEnv $ do
56− let r1n = SnapshotRepoName "bloodhound-repo1"
57− withSnapshotRepo r1n $ \_ -> do
58− res <- verifySnapshotRepo r1n
59− liftIO $ case res of
60− Right (SnapshotVerification vs)
61− | null vs -> expectationFailure "Expected nonempty set of verifying nodes"
62− | otherwise -> return ()
63− Left e -> expectationFailure (show e)
64−
65− describe "Snapshots" $ do
66− it "always parses all snapshots API" $ when' canSnapshot $ withTestEnv $ do
67− let r1n = SnapshotRepoName "bloodhound-repo1"
68− withSnapshotRepo r1n $ \_ -> do
69− res <- getSnapshots r1n AllSnapshots
70− liftIO $ case res of
71− Left e -> expectationFailure ("Expected a right but got Left " <> show e)
72− Right _ -> return ()
73−
74− it "can parse a snapshot that it created" $ when' canSnapshot $ withTestEnv $ do
75− let r1n = SnapshotRepoName "bloodhound-repo1"
76− withSnapshotRepo r1n $ \_ -> do
77− let s1n = SnapshotName "example-snapshot"
78− withSnapshot r1n s1n $ do
79− res <- getSnapshots r1n (SnapshotList (ExactSnap s1n :| []))
80− liftIO $ case res of
81− Right [snap]
82− | snapInfoState snap == SnapshotSuccess &&
83− snapInfoName snap == s1n -> return ()
84− | otherwise -> expectationFailure (show snap)
85− Right [] -> expectationFailure "There were no snapshots"
86− Right snaps -> expectationFailure ("Expected 1 snapshot but got" <> show (length snaps))
87− Left e -> expectationFailure (show e)
88−
89− describe "Snapshot restore" $ do
90− it "can restore a snapshot that we create" $ when' canSnapshot $ withTestEnv $ do
91− let r1n = SnapshotRepoName "bloodhound-repo1"
92− withSnapshotRepo r1n $ \_ -> do
93− let s1n = SnapshotName "example-snapshot"
94− withSnapshot r1n s1n $ do
95− let settings = defaultSnapshotRestoreSettings { snapRestoreWaitForCompletion = True }
96− -- have to close an index to restore it
97− resp1 <- closeIndex testIndex
98− liftIO (validateStatus resp1 200)
99− resp2 <- restoreSnapshot r1n s1n settings
100− liftIO (validateStatus resp2 200)
101−
102− it "can restore and rename" $ when' canSnapshot $ withTestEnv $ do
103− let r1n = SnapshotRepoName "bloodhound-repo1"
104− withSnapshotRepo r1n $ \_ -> do
105− let s1n = SnapshotName "example-snapshot"
106− withSnapshot r1n s1n $ do
107− let pat = RestoreRenamePattern "bloodhound-tests-twitter-(\\d+)"
108− let replace = RRTLit "restored-" :| [RRSubWholeMatch]
109− let expectedIndex = IndexName "restored-bloodhound-tests-twitter-1"
110− oldEnoughForOverrides <- liftIO (atleast es15)
111− let overrides = RestoreIndexSettings { restoreOverrideReplicas = Just (ReplicaCount 0) }
112− let settings = defaultSnapshotRestoreSettings { snapRestoreWaitForCompletion = True
113− , snapRestoreRenamePattern = Just pat
114− , snapRestoreRenameReplacement = Just replace
115− , snapRestoreIndexSettingsOverrides = if oldEnoughForOverrides
116− then Just overrides
117− else Nothing
118− }
119− -- have to close an index to restore it
120− let go = do
121− resp <- restoreSnapshot r1n s1n settings
122− liftIO (validateStatus resp 200)
123− exists <- indexExists expectedIndex
124− liftIO (exists `shouldBe` True)
125− go `finally` deleteIndex expectedIndex
126−
127−-- | Get configured repo paths for snapshotting. Note that by default
128−-- this is not enabled and if we are over es 1.5, we won't be able to
129−-- test snapshotting. Note that this can and should be part of the
130−-- client functionality in a much less ad-hoc incarnation.
131−getRepoPaths :: IO [FilePath]
132−getRepoPaths = withTestEnv $ do
133− bhe <- getBHEnv
134− let Server s = bhServer bhe
135− let tUrl = s <> "/" <> "_nodes"
136− initReq <- parseRequest (URI.escapeURIString URI.isAllowedInURI (T.unpack tUrl))
137− let req = setRequestIgnoreStatus $ initReq { method = NHTM.methodGet }
138− Right (Object o) <- parseEsResponse =<< liftIO (httpLbs req (bhManager bhe))
139− return $ fromMaybe mempty $ do
140− Object nodes <- HM.lookup "nodes" o
141− Object firstNode <- snd <$> headMay (HM.toList nodes)
142− Object settings <- HM.lookup "settings" firstNode
143− Object path <- HM.lookup "path" settings
144− Array repo <- HM.lookup "repo" path
145− return [ T.unpack t | String t <- V.toList repo]
146−
147−-- | 1.5 and earlier don't care about repo paths
148−canSnapshot :: IO Bool
149−canSnapshot = do
150− caresAboutRepos <- atleast es16
151− repoPaths <- getRepoPaths
152− return (not caresAboutRepos || not (null repoPaths))
153−
154−withSnapshotRepo
155− :: ( MonadMask m
156− , MonadBH m
157− )
158− => SnapshotRepoName
159− -> (GenericSnapshotRepo -> m a)
160− -> m a
161−withSnapshotRepo srn@(SnapshotRepoName n) f = do
162− repoPaths <- liftIO getRepoPaths
163− -- we'll use the first repo path if available, otherwise system temp
164− -- dir. Note that this will fail on ES > 1.6, so be sure you use
165− -- @when' canSnapshot@.
166− case repoPaths of
167− (firstRepoPath:_) -> withTempDirectory firstRepoPath (T.unpack n) $ \dir -> bracket (alloc dir) free f
168− [] -> withSystemTempDirectory (T.unpack n) $ \dir -> bracket (alloc dir) free f
169− where
170− alloc dir = do
171− liftIO (setFileMode dir mode)
172− let repo = FsSnapshotRepo srn "bloodhound-tests-backups" True Nothing Nothing Nothing
173− resp <- updateSnapshotRepo defaultSnapshotRepoUpdateSettings repo
174− liftIO (validateStatus resp 200)
175− return (toGSnapshotRepo repo)
176− mode = ownerModes `unionFileModes` groupModes `unionFileModes` otherModes
177− free GenericSnapshotRepo {..} = do
178− resp <- deleteSnapshotRepo gSnapshotRepoName
179− liftIO (validateStatus resp 200)
180−
181−
182−withSnapshot
183− :: ( MonadMask m
184− , MonadBH m
185− )
186− => SnapshotRepoName
187− -> SnapshotName
188− -> m a
189− -> m a
190−withSnapshot srn sn = bracket_ alloc free
191− where
192− alloc = do
193− resp <- createSnapshot srn sn createSettings
194− liftIO (validateStatus resp 200)
195− -- We'll make this synchronous for testing purposes
196− createSettings = defaultSnapshotCreateSettings { snapWaitForCompletion = True
197− , snapIndices = Just (IndexList (testIndex :| []))
198− -- We don't actually need to back up any data
199− }
200− free =
201− deleteSnapshot srn sn
tests/Test/Sorting.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Sorting where
4−
5−import Test.Common
6−import Test.Import
7−
8−spec :: Spec
9−spec =
10− describe "sorting" $
11− it "returns documents in the right order" $ withTestEnv $ do
12− _ <- insertData
13− _ <- insertOther
14− let sortSpec = DefaultSortSpec $ mkSort (FieldName "age") Ascending
15− let search = Search Nothing
16− Nothing (Just [sortSpec]) Nothing Nothing
17− False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing Nothing
18− Nothing Nothing
19− result <- searchTweets search
20− let myTweet = grabFirst result
21− liftIO $
22− myTweet `shouldBe` Right otherTweet
tests/Test/SourceFiltering.hsdeleted−38
@@ -1,38 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.SourceFiltering where
4−
5−import Test.Common
6−import Test.Import
7−
8−import qualified Data.HashMap.Strict as HM
9−
10−spec :: Spec
11−spec =
12− describe "Source filtering" $ do
13−
14− it "doesn't include source when sources are disabled" $ withTestEnv $
15− searchExpectSource
16− NoSource
17− (Left (EsError 500 "Source was missing"))
18−
19− it "includes a source" $ withTestEnv $
20− searchExpectSource
21− (SourcePatterns (PopPattern (Pattern "message")))
22− (Right (Object (HM.fromList [("message", String "Use haskell!")])))
23−
24− it "includes sources" $ withTestEnv $
25− searchExpectSource
26− (SourcePatterns (PopPatterns [Pattern "user", Pattern "message"]))
27− (Right (Object (HM.fromList [("user",String "bitemyapp"),("message", String "Use haskell!")])))
28−
29− it "includes source patterns" $ withTestEnv $
30− searchExpectSource
31− (SourcePatterns (PopPattern (Pattern "*ge")))
32− (Right (Object (HM.fromList [("age", Number 10000),("message", String "Use haskell!")])))
33−
34− it "excludes source patterns" $ withTestEnv $
35− searchExpectSource
36− (SourceIncludeExclude (Include [])
37− (Exclude [Pattern "l*", Pattern "*ge", Pattern "postDate", Pattern "extra"]))
38− (Right (Object (HM.fromList [("user",String "bitemyapp")])))
tests/Test/Suggest.hsdeleted−23
@@ -1,23 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Suggest where
4−
5−import Test.Common
6−import Test.Import
7−
8−spec :: Spec
9−spec =
10− describe "Suggest" $
11− it "returns a search suggestion using the phrase suggester" $ withTestEnv $ do
12− _ <- insertData
13− let query = QueryMatchNoneQuery
14− phraseSuggester = mkPhraseSuggester (FieldName "message")
15− namedSuggester = Suggest "Use haskel" "suggest_name" (SuggestTypePhraseSuggester phraseSuggester)
16− search' = mkSearch (Just query) Nothing
17− search = search' { suggestBody = Just namedSuggester }
18− expectedText = Just "use haskell"
19− resp <- searchByIndex testIndex search
20− parsed <- parseEsResponse resp :: BH IO (Either EsError (SearchResult Tweet))
21− case parsed of
22− Left e -> liftIO $ expectationFailure ("Expected an search suggestion but got " <> show e)
23− Right sr -> liftIO $ (suggestOptionsText . head . suggestResponseOptions . head . nsrResponses <$> suggest sr) `shouldBe` expectedText
tests/Test/Templates.hsdeleted−26
@@ -1,26 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Test.Templates where
4−
5−import Test.Common
6−import Test.Import
7−
8−spec :: Spec
9−spec =
10− describe "template API" $ do
11− it "can create a template" $ withTestEnv $ do
12− let idxTpl = IndexTemplate (TemplatePattern "tweet-*") (Just (IndexSettings (ShardCount 1) (ReplicaCount 1))) [toJSON TweetMapping]
13− resp <- putTemplate idxTpl (TemplateName "tweet-tpl")
14− liftIO $ validateStatus resp 200
15−
16− it "can detect if a template exists" $ withTestEnv $ do
17− exists <- templateExists (TemplateName "tweet-tpl")
18− liftIO $ exists `shouldBe` True
19−
20− it "can delete a template" $ withTestEnv $ do
21− resp <- deleteTemplate (TemplateName "tweet-tpl")
22− liftIO $ validateStatus resp 200
23−
24− it "can detect if a template doesn't exist" $ withTestEnv $ do
25− exists <- templateExists (TemplateName "tweet-tpl")
26− liftIO $ exists `shouldBe` False
tests/doctests.hsnew file+4
@@ -0,0 +1,4 @@
1+import Test.DocTest
2+
3+main :: IO ()
4+main = doctest ["-i src", "Database.Bloodhound"]
tests/tests.hs+1510−89
@@ -1,70 +1,1361 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE DefaultSignatures #-}
2+{-# LANGUAGE DeriveGeneric #-}
23{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
35{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE RecordWildCards #-}
56{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE TemplateHaskell #-}
68{-# LANGUAGE TypeOperators #-}
79{-# OPTIONS_GHC -fno-warn-orphans #-}
8−#if __GLASGOW_HASKELL__ < 800
9−{-# OPTIONS_GHC -fcontext-stack=100 #-}
10−#endif
11−#if __GLASGOW_HASKELL__ >= 802
12−{-# LANGUAGE MonoLocalBinds #-}
13−#endif
1410module Main where
1511
16−import Test.Common
17−import Test.Import
18−
19−import Prelude
20−
21−import qualified Data.Aeson as Aeson
22−import qualified Test.Aggregation as Aggregation
23−import qualified Test.BulkAPI as Bulk
24−import qualified Test.Documents as Documents
25−import qualified Test.Highlights as Highlights
26−import qualified Test.Indices as Indices
27−import qualified Test.JSON as JSON
28−import qualified Test.Query as Query
29−import qualified Test.Script as Script
30−import qualified Test.Snapshots as Snapshots
31−import qualified Test.Sorting as Sorting
32−import qualified Test.SourceFiltering as SourceFiltering
33−import qualified Test.Suggest as Suggest
34−import qualified Test.Templates as Templates
12+import Control.Applicative
13+import Control.Error
14+import Control.Exception
15+import Control.Monad
16+import Control.Monad.Reader
17+import Data.Aeson
18+import Data.Aeson.Types (parseEither)
19+import qualified Data.ByteString.Lazy.Char8 as BL8
20+import Data.DeriveTH
21+import qualified Data.HashMap.Strict as HM
22+import Data.List (nub)
23+import qualified Data.List as L
24+import Data.List.NonEmpty (NonEmpty (..))
25+import qualified Data.List.NonEmpty as NE
26+import qualified Data.Map.Strict as M
27+import Data.Monoid
28+import Data.Proxy
29+import Data.Text (Text)
30+import qualified Data.Text as T
31+import Data.Time.Calendar (Day (..), fromGregorian)
32+import Data.Time.Clock (NominalDiffTime, UTCTime (..),
33+ secondsToDiffTime)
34+import Data.Typeable
35+import qualified Data.Vector as V
36+import Database.Bloodhound
37+import GHC.Generics as G
38+import Network.HTTP.Client hiding (Proxy)
39+import qualified Network.HTTP.Types.Status as NHTS
40+import Prelude hiding (filter)
41+import Test.Hspec
42+import Test.QuickCheck.Property.Monoid (T (..), eq, prop_Monoid)
43+
44+import Test.Hspec.QuickCheck (prop)
45+import Test.QuickCheck
46+
47+testServer :: Server
48+testServer = Server "http://localhost:9200"
49+testIndex :: IndexName
50+testIndex = IndexName "bloodhound-tests-twitter-1"
51+testMapping :: MappingName
52+testMapping = MappingName "tweet"
53+
54+withTestEnv :: BH IO a -> IO a
55+withTestEnv = withBH defaultManagerSettings testServer
56+
57+validateStatus :: Response body -> Int -> Expectation
58+validateStatus resp expected =
59+ (NHTS.statusCode $ responseStatus resp)
60+ `shouldBe` (expected :: Int)
61+
62+createExampleIndex :: BH IO Reply
63+createExampleIndex = createIndex (IndexSettings (ShardCount 1) (ReplicaCount 0)) testIndex
64+deleteExampleIndex :: BH IO Reply
65+deleteExampleIndex = deleteIndex testIndex
66+
67+data ServerVersion = ServerVersion Int Int Int deriving (Show, Eq, Ord)
68+
69+es13 :: ServerVersion
70+es13 = ServerVersion 1 3 0
71+
72+es12 :: ServerVersion
73+es12 = ServerVersion 1 2 0
74+
75+es11 :: ServerVersion
76+es11 = ServerVersion 1 1 0
77+
78+serverBranch :: ServerVersion -> ServerVersion
79+serverBranch (ServerVersion majorVer minorVer patchVer) =
80+ ServerVersion majorVer minorVer patchVer
81+
82+mkServerVersion :: [Int] -> Maybe ServerVersion
83+mkServerVersion [majorVer, minorVer, patchVer] =
84+ Just (ServerVersion majorVer minorVer patchVer)
85+mkServerVersion _ = Nothing
86+
87+getServerVersion :: IO (Maybe ServerVersion)
88+getServerVersion = liftM extractVersion (withTestEnv getStatus)
89+ where
90+ version' = T.splitOn "." . number . version
91+ toInt = read . T.unpack
92+ parseVersion v = map toInt (version' v)
93+ extractVersion = join . liftM (mkServerVersion . parseVersion)
94+
95+testServerBranch :: IO (Maybe ServerVersion)
96+testServerBranch = getServerVersion >>= \v -> return $ liftM serverBranch v
97+
98+atleast :: ServerVersion -> IO Bool
99+atleast v = testServerBranch >>= \x -> return $ x >= Just (serverBranch v)
100+
101+atmost :: ServerVersion -> IO Bool
102+atmost v = testServerBranch >>= \x -> return $ x <= Just (serverBranch v)
103+
104+is :: ServerVersion -> IO Bool
105+is v = testServerBranch >>= \x -> return $ x == Just (serverBranch v)
106+
107+when' :: Monad m => m Bool -> m () -> m ()
108+when' b f = b >>= \x -> when x f
109+
110+(==~) :: (ApproxEq a, Show a) => a -> a -> Property
111+a ==~ b = counterexample (show a ++ " !=~ " ++ show b) (a =~ b)
112+
113+propJSON :: forall a. (Arbitrary a, ToJSON a, FromJSON a, Show a, ApproxEq a, Typeable a) => Proxy a -> Spec
114+propJSON _ = prop testName $ \(a :: a) ->
115+ let jsonStr = "via " <> BL8.unpack (encode a)
116+ in counterexample jsonStr (parseEither parseJSON (toJSON a) ==~ Right a)
117+ where testName = show ty <> " FromJSON/ToJSON roundtrips"
118+ ty = typeOf (undefined :: a)
119+
120+data Location = Location { lat :: Double
121+ , lon :: Double } deriving (Eq, Generic, Show)
122+
123+data Tweet = Tweet { user :: Text
124+ , postDate :: UTCTime
125+ , message :: Text
126+ , age :: Int
127+ , location :: Location
128+ , extra :: Maybe Text }
129+ deriving (Eq, Generic, Show)
130+
131+instance ToJSON Tweet where
132+ toJSON = genericToJSON defaultOptions
133+instance FromJSON Tweet where
134+ parseJSON = genericParseJSON defaultOptions
135+instance ToJSON Location where
136+ toJSON = genericToJSON defaultOptions
137+instance FromJSON Location where
138+ parseJSON = genericParseJSON defaultOptions
139+
140+data ParentMapping = ParentMapping deriving (Eq, Show)
141+
142+instance ToJSON ParentMapping where
143+ toJSON ParentMapping =
144+ object ["parent" .= Null ]
145+
146+data ChildMapping = ChildMapping deriving (Eq, Show)
147+
148+instance ToJSON ChildMapping where
149+ toJSON ChildMapping =
150+ object ["child" .=
151+ object ["_parent" .= object ["type" .= ("parent" :: Text)]]
152+ ]
153+
154+data TweetMapping = TweetMapping deriving (Eq, Show)
155+
156+instance ToJSON TweetMapping where
157+ toJSON TweetMapping =
158+ object ["tweet" .=
159+ object ["properties" .=
160+ object [ "user" .= object ["type" .= ("string" :: Text)]
161+ -- Serializing the date as a date is breaking other tests, mysteriously.
162+ -- , "postDate" .= object [ "type" .= ("date" :: Text)
163+ -- , "format" .= ("YYYY-MM-dd`T`HH:mm:ss.SSSZZ" :: Text)]
164+ , "message" .= object ["type" .= ("string" :: Text)]
165+ , "age" .= object ["type" .= ("integer" :: Text)]
166+ , "location" .= object ["type" .= ("geo_point" :: Text)]
167+ ]]]
168+
169+exampleTweet :: Tweet
170+exampleTweet = Tweet { user = "bitemyapp"
171+ , postDate = UTCTime
172+ (ModifiedJulianDay 55000)
173+ (secondsToDiffTime 10)
174+ , message = "Use haskell!"
175+ , age = 10000
176+ , location = Location 40.12 (-71.34)
177+ , extra = Nothing }
178+
179+tweetWithExtra :: Tweet
180+tweetWithExtra = Tweet { user = "bitemyapp"
181+ , postDate = UTCTime
182+ (ModifiedJulianDay 55000)
183+ (secondsToDiffTime 10)
184+ , message = "Use haskell!"
185+ , age = 10000
186+ , location = Location 40.12 (-71.34)
187+ , extra = Just "blah blah" }
188+
189+newAge :: Int
190+newAge = 31337
191+
192+newUser :: Text
193+newUser = "someotherapp"
194+
195+tweetPatch :: Value
196+tweetPatch =
197+ object [ "age" .= newAge
198+ , "user" .= newUser
199+ ]
200+
201+patchedTweet :: Tweet
202+patchedTweet = exampleTweet{age = newAge, user = newUser}
203+
204+otherTweet :: Tweet
205+otherTweet = Tweet { user = "notmyapp"
206+ , postDate = UTCTime
207+ (ModifiedJulianDay 55000)
208+ (secondsToDiffTime 11)
209+ , message = "Use haskell!"
210+ , age = 1000
211+ , location = Location 40.12 (-71.34)
212+ , extra = Nothing }
213+
214+resetIndex :: BH IO ()
215+resetIndex = do
216+ _ <- deleteExampleIndex
217+ _ <- createExampleIndex
218+ _ <- putMapping testIndex testMapping TweetMapping
219+ return ()
220+
221+insertData :: BH IO Reply
222+insertData = do
223+ resetIndex
224+ insertData' defaultIndexDocumentSettings
225+
226+insertData' :: IndexDocumentSettings -> BH IO Reply
227+insertData' ids = do
228+ r <- indexDocument testIndex testMapping ids exampleTweet (DocId "1")
229+ _ <- refreshIndex testIndex
230+ return r
231+
232+updateData :: BH IO Reply
233+updateData = do
234+ r <- updateDocument testIndex testMapping defaultIndexDocumentSettings tweetPatch (DocId "1")
235+ _ <- refreshIndex testIndex
236+ return r
237+
238+insertOther :: BH IO ()
239+insertOther = do
240+ _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings otherTweet (DocId "2")
241+ _ <- refreshIndex testIndex
242+ return ()
243+
244+insertExtra :: BH IO ()
245+insertExtra = do
246+ _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings tweetWithExtra (DocId "4")
247+ _ <- refreshIndex testIndex
248+ return ()
249+
250+insertWithSpaceInId :: BH IO ()
251+insertWithSpaceInId = do
252+ _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings exampleTweet (DocId "Hello World")
253+ _ <- refreshIndex testIndex
254+ return ()
255+
256+searchTweet :: Search -> BH IO (Either EsError Tweet)
257+searchTweet search = do
258+ result <- searchTweets search
259+ let myTweet :: Either EsError Tweet
260+ myTweet = grabFirst result
261+ return myTweet
262+
263+searchTweets :: Search -> BH IO (Either EsError (SearchResult Tweet))
264+searchTweets search = parseEsResponse =<< searchByIndex testIndex search
265+
266+searchExpectNoResults :: Search -> BH IO ()
267+searchExpectNoResults search = do
268+ result <- searchTweets search
269+ let emptyHits = fmap (hits . searchHits) result
270+ liftIO $
271+ emptyHits `shouldBe` Right []
272+
273+searchExpectAggs :: Search -> BH IO ()
274+searchExpectAggs search = do
275+ reply <- searchByIndex testIndex search
276+ let isEmpty x = return (M.null x)
277+ let result = decode (responseBody reply) :: Maybe (SearchResult Tweet)
278+ liftIO $
279+ (result >>= aggregations >>= isEmpty) `shouldBe` Just False
280+
281+searchValidBucketAgg :: (BucketAggregation a, FromJSON a, Show a) =>
282+ Search -> Text -> (Text -> AggregationResults -> Maybe (Bucket a)) -> BH IO ()
283+searchValidBucketAgg search aggKey extractor = do
284+ reply <- searchByIndex testIndex search
285+ let bucketDocs = docCount . head . buckets
286+ let result = decode (responseBody reply) :: Maybe (SearchResult Tweet)
287+ let count = result >>= aggregations >>= extractor aggKey >>= \x -> return (bucketDocs x)
288+ liftIO $
289+ count `shouldBe` Just 1
290+
291+searchTermsAggHint :: [ExecutionHint] -> BH IO ()
292+searchTermsAggHint hints = do
293+ let terms hint = TermsAgg $ (mkTermsAggregation "user") { termExecutionHint = Just hint }
294+ let search hint = mkAggregateSearch Nothing $ mkAggregations "users" $ terms hint
295+ forM_ hints $ searchExpectAggs . search
296+ forM_ hints (\x -> searchValidBucketAgg (search x) "users" toTerms)
297+
298+searchTweetHighlight :: Search -> BH IO (Either EsError (Maybe HitHighlight))
299+searchTweetHighlight search = do
300+ result <- searchTweets search
301+ let myHighlight = fmap (hitHighlight . head . hits . searchHits) result
302+ return myHighlight
303+
304+searchExpectSource :: Source -> Either EsError Value -> BH IO ()
305+searchExpectSource src expected = do
306+ _ <- insertData
307+ let query = QueryMatchQuery $ mkMatchQuery (FieldName "_all") (QueryString "haskell")
308+ let search = (mkSearch (Just query) Nothing) { source = Just src }
309+ reply <- searchByIndex testIndex search
310+ result <- parseEsResponse reply
311+ let value = grabFirst result
312+ liftIO $
313+ value `shouldBe` expected
314+
315+data BulkTest = BulkTest { name :: Text } deriving (Eq, Generic, Show)
316+instance FromJSON BulkTest where
317+ parseJSON = genericParseJSON defaultOptions
318+instance ToJSON BulkTest where
319+ toJSON = genericToJSON defaultOptions
320+
321+class GApproxEq f where
322+ gApproxEq :: f a -> f a -> Bool
323+
324+-- | Unit type
325+instance GApproxEq U1 where
326+ gApproxEq U1 U1 = True
327+
328+-- | Sum type, ensure same constructors, recurse
329+instance (GApproxEq a, GApproxEq b) => GApproxEq (a :+: b) where
330+ gApproxEq (L1 a) (L1 b) = gApproxEq a b
331+ gApproxEq (R1 a) (R1 b) = gApproxEq a b
332+ gApproxEq _ _ = False
333+
334+-- | Product type, ensure each field is approx eq
335+instance (GApproxEq a, GApproxEq b) => GApproxEq (a :*: b) where
336+ gApproxEq (a1 :*: b1) (a2 :*: b2) = gApproxEq a1 a2 && gApproxEq b1 b2
337+
338+-- | Value type, actually check the values for approx equality
339+instance (ApproxEq a) => GApproxEq (K1 i a) where
340+ gApproxEq (K1 a) (K1 b) = a =~ b
341+
342+instance (GApproxEq f) => GApproxEq (M1 i t f) where
343+ gApproxEq (M1 a) (M1 b) = gApproxEq a b
344+
345+-- | Typeclass for "equal where it matters". Use this to specify
346+-- less-strict equivalence for things such as lists that can wind up
347+-- in an unpredictable order
348+class ApproxEq a where
349+ (=~) :: a -> a -> Bool
350+ default (=~) :: (Generic a, GApproxEq (Rep a)) => a -> a -> Bool
351+ a =~ b = gApproxEq (G.from a) (G.from b)
352+
353+instance ApproxEq NominalDiffTime where (=~) = (==)
354+instance ApproxEq UTCTime where (=~) = (==)
355+instance ApproxEq Text where (=~) = (==)
356+instance ApproxEq Bool where (=~) = (==)
357+instance ApproxEq Int where (=~) = (==)
358+instance ApproxEq Double where (=~) = (==)
359+instance ApproxEq a => ApproxEq (NonEmpty a)
360+instance ApproxEq a => ApproxEq (Maybe a)
361+instance ApproxEq GeoPoint
362+instance ApproxEq Regexp
363+instance ApproxEq RangeValue
364+instance ApproxEq LessThan
365+instance ApproxEq LessThanEq
366+instance ApproxEq LessThanD
367+instance ApproxEq LessThanEqD
368+instance ApproxEq GreaterThan
369+instance ApproxEq GreaterThanEq
370+instance ApproxEq GreaterThanD
371+instance ApproxEq GreaterThanEqD
372+instance ApproxEq MinimumMatchHighLow
373+instance ApproxEq RegexpFlag
374+instance ApproxEq RegexpFlags
375+instance ApproxEq NullValue
376+instance ApproxEq Version
377+instance ApproxEq DistanceRange
378+instance ApproxEq IndexName
379+instance ApproxEq MappingName
380+instance ApproxEq DocId
381+instance ApproxEq IndexAliasRouting
382+instance ApproxEq RoutingValue
383+instance ApproxEq ShardCount
384+instance ApproxEq ReplicaCount
385+instance ApproxEq TemplateName
386+instance ApproxEq TemplatePattern
387+instance ApproxEq QueryString
388+instance ApproxEq FieldName
389+instance ApproxEq CacheName
390+instance ApproxEq CacheKey
391+instance ApproxEq Existence
392+instance ApproxEq CutoffFrequency
393+instance ApproxEq Analyzer
394+instance ApproxEq Lenient
395+instance ApproxEq Tiebreaker
396+instance ApproxEq Boost
397+instance ApproxEq BoostTerms
398+instance ApproxEq MaxExpansions
399+instance ApproxEq MinimumMatch
400+instance ApproxEq DisableCoord
401+instance ApproxEq IgnoreTermFrequency
402+instance ApproxEq MinimumTermFrequency
403+instance ApproxEq MaxQueryTerms
404+instance ApproxEq Fuzziness
405+instance ApproxEq PrefixLength
406+instance ApproxEq TypeName
407+instance ApproxEq PercentMatch
408+instance ApproxEq StopWord
409+instance ApproxEq QueryPath
410+instance ApproxEq AllowLeadingWildcard
411+instance ApproxEq LowercaseExpanded
412+instance ApproxEq EnablePositionIncrements
413+instance ApproxEq AnalyzeWildcard
414+instance ApproxEq GeneratePhraseQueries
415+instance ApproxEq Locale
416+instance ApproxEq MaxWordLength
417+instance ApproxEq MinWordLength
418+instance ApproxEq PhraseSlop
419+instance ApproxEq MinDocFrequency
420+instance ApproxEq MaxDocFrequency
421+instance ApproxEq Filter
422+instance ApproxEq Query
423+instance ApproxEq SimpleQueryStringQuery
424+instance ApproxEq FieldOrFields
425+instance ApproxEq SimpleQueryFlag
426+instance ApproxEq RegexpQuery
427+instance ApproxEq QueryStringQuery
428+instance ApproxEq RangeQuery
429+instance ApproxEq PrefixQuery
430+instance ApproxEq NestedQuery
431+instance ApproxEq MoreLikeThisFieldQuery
432+instance ApproxEq MoreLikeThisQuery
433+instance ApproxEq IndicesQuery
434+instance ApproxEq HasParentQuery
435+instance ApproxEq HasChildQuery
436+instance ApproxEq FuzzyQuery
437+instance ApproxEq FuzzyLikeFieldQuery
438+instance ApproxEq FuzzyLikeThisQuery
439+instance ApproxEq FilteredQuery
440+instance ApproxEq DisMaxQuery
441+instance ApproxEq CommonTermsQuery
442+instance ApproxEq CommonMinimumMatch
443+instance ApproxEq BoostingQuery
444+instance ApproxEq BoolQuery
445+instance ApproxEq MatchQuery
446+instance ApproxEq MultiMatchQueryType
447+instance ApproxEq BooleanOperator
448+instance ApproxEq ZeroTermsQuery
449+instance ApproxEq MatchQueryType
450+instance ApproxEq AliasRouting
451+instance ApproxEq IndexAliasCreate
452+instance ApproxEq SearchAliasRouting
453+instance ApproxEq ScoreType
454+instance ApproxEq Distance
455+instance ApproxEq DistanceUnit
456+instance ApproxEq DistanceType
457+instance ApproxEq OptimizeBbox
458+instance ApproxEq GeoBoundingBoxConstraint
459+instance ApproxEq GeoFilterType
460+instance ApproxEq GeoBoundingBox
461+instance ApproxEq LatLon
462+instance ApproxEq RangeExecution
463+instance ApproxEq FSType
464+instance ApproxEq CompoundFormat
465+instance ApproxEq InitialShardCount
466+instance ApproxEq Bytes
467+instance ApproxEq ReplicaBounds
468+instance ApproxEq Term
469+instance ApproxEq BoolMatch
470+instance ApproxEq MultiMatchQuery
471+instance ApproxEq IndexSettings
472+instance ApproxEq AllocationPolicy
473+instance ApproxEq Char
474+instance ApproxEq a => ApproxEq [a] where
475+ as =~ bs = and (zipWith (=~) as bs)
476+instance (ApproxEq l, ApproxEq r) => ApproxEq (Either l r) where
477+ Left a =~ Left b = a =~ b
478+ Right a =~ Right b = a =~ b
479+ _ =~ _ = False
480+instance ApproxEq NodeAttrFilter
481+instance ApproxEq NodeAttrName
482+
483+-- | Due to the way nodeattrfilters get serialized here, they may come
484+-- out in a different order, but they are morally equivalent
485+instance ApproxEq UpdatableIndexSetting where
486+ RoutingAllocationInclude a =~ RoutingAllocationInclude b =
487+ NE.sort a =~ NE.sort b
488+ RoutingAllocationExclude a =~ RoutingAllocationExclude b =
489+ NE.sort a =~ NE.sort b
490+ RoutingAllocationRequire a =~ RoutingAllocationRequire b =
491+ NE.sort a =~ NE.sort b
492+ a =~ b = a == b
493+
494+
495+noDuplicates :: Eq a => [a] -> Bool
496+noDuplicates xs = nub xs == xs
497+
498+instance Arbitrary NominalDiffTime where
499+ arbitrary = fromInteger <$> arbitrary
500+
501+instance (Arbitrary k, Ord k, Arbitrary v) => Arbitrary (M.Map k v) where
502+ arbitrary = M.fromList <$> arbitrary
503+
504+instance Arbitrary Text where
505+ arbitrary = T.pack <$> arbitrary
506+
507+instance Arbitrary UTCTime where
508+ arbitrary = UTCTime
509+ <$> arbitrary
510+ <*> (fromRational . toRational <$> choose (0::Double, 86400))
511+
512+instance Arbitrary Day where
513+ arbitrary = ModifiedJulianDay <$> (2000 +) <$> arbitrary
514+ shrink = (ModifiedJulianDay <$>) . shrink . toModifiedJulianDay
515+
516+instance Arbitrary a => Arbitrary (NonEmpty a) where
517+ arbitrary = liftA2 (:|) arbitrary arbitrary
518+
519+arbitraryScore :: Gen Score
520+arbitraryScore = fmap getPositive <$> arbitrary
521+
522+instance (Arbitrary a, Typeable a) => Arbitrary (Hit a) where
523+ arbitrary = Hit <$> arbitrary
524+ <*> arbitrary
525+ <*> arbitrary
526+ <*> arbitraryScore
527+ <*> arbitrary
528+ <*> arbitrary
529+ shrink = genericShrink
530+
531+
532+instance (Arbitrary a, Typeable a) => Arbitrary (SearchHits a) where
533+ arbitrary = reduceSize $ do
534+ tot <- getPositive <$> arbitrary
535+ score <- arbitraryScore
536+ hs <- arbitrary
537+ return $ SearchHits tot score hs
538+ shrink = genericShrink
539+
540+reduceSize :: Gen a -> Gen a
541+reduceSize f = sized $ \n -> resize (n `div` 2) f
542+
543+getSource :: EsResult a -> Maybe a
544+getSource = fmap _source . foundResult
545+
546+grabFirst :: Either EsError (SearchResult a) -> Either EsError a
547+grabFirst r =
548+ case fmap (hitSource . head . hits . searchHits) r of
549+ (Left e) -> Left e
550+ (Right Nothing) -> Left (EsError 500 "Source was missing")
551+ (Right (Just x)) -> Right x
552+
553+-------------------------------------------------------------------------------
554+arbitraryAlphaNum :: Gen Char
555+arbitraryAlphaNum = oneof [choose ('a', 'z')
556+ ,choose ('A','Z')
557+ , choose ('0', '9')]
558+
559+instance Arbitrary RoutingValue where
560+ arbitrary = RoutingValue . T.pack <$> listOf1 arbitraryAlphaNum
561+
562+instance Arbitrary AliasRouting where
563+ arbitrary = oneof [allAlias
564+ ,one
565+ ,theOther
566+ ,both]
567+ where one = GranularAliasRouting
568+ <$> (Just <$> arbitrary)
569+ <*> pure Nothing
570+ theOther = GranularAliasRouting Nothing
571+ <$> (Just <$> arbitrary)
572+ both = GranularAliasRouting
573+ <$> (Just <$> arbitrary)
574+ <*> (Just <$> arbitrary)
575+ allAlias = AllAliasRouting <$> arbitrary
576+ shrink = genericShrink
577+
578+
579+instance Arbitrary FieldName where
580+ arbitrary = FieldName . T.pack <$> listOf1 arbitraryAlphaNum
581+ shrink = genericShrink
582+
583+
584+instance Arbitrary RegexpFlags where
585+ arbitrary = oneof [ pure AllRegexpFlags
586+ , pure NoRegexpFlags
587+ , SomeRegexpFlags <$> genUniqueFlags
588+ ]
589+ where genUniqueFlags = NE.fromList . nub <$> listOf1 arbitrary
590+ shrink = genericShrink
591+
592+
593+instance Arbitrary IndexAliasCreate where
594+ arbitrary = IndexAliasCreate <$> arbitrary <*> reduceSize arbitrary
595+ shrink = genericShrink
596+
597+instance Arbitrary Query where
598+ arbitrary = reduceSize $ oneof [ TermQuery <$> arbitrary <*> arbitrary
599+ , TermsQuery <$> arbitrary <*> arbitrary
600+ , QueryMatchQuery <$> arbitrary
601+ , QueryMultiMatchQuery <$> arbitrary
602+ , QueryBoolQuery <$> arbitrary
603+ , QueryBoostingQuery <$> arbitrary
604+ , QueryCommonTermsQuery <$> arbitrary
605+ , ConstantScoreFilter <$> arbitrary <*> arbitrary
606+ , ConstantScoreQuery <$> arbitrary <*> arbitrary
607+ , QueryDisMaxQuery <$> arbitrary
608+ , QueryFilteredQuery <$> arbitrary
609+ , QueryFuzzyLikeThisQuery <$> arbitrary
610+ , QueryFuzzyLikeFieldQuery <$> arbitrary
611+ , QueryFuzzyQuery <$> arbitrary
612+ , QueryHasChildQuery <$> arbitrary
613+ , QueryHasParentQuery <$> arbitrary
614+ , IdsQuery <$> arbitrary <*> arbitrary
615+ , QueryIndicesQuery <$> arbitrary
616+ , MatchAllQuery <$> arbitrary
617+ , QueryMoreLikeThisQuery <$> arbitrary
618+ , QueryMoreLikeThisFieldQuery <$> arbitrary
619+ , QueryNestedQuery <$> arbitrary
620+ , QueryPrefixQuery <$> arbitrary
621+ , QueryQueryStringQuery <$> arbitrary
622+ , QuerySimpleQueryStringQuery <$> arbitrary
623+ , QueryRangeQuery <$> arbitrary
624+ , QueryRegexpQuery <$> arbitrary
625+ ]
626+ shrink = genericShrink
627+
628+instance Arbitrary Filter where
629+ arbitrary = reduceSize $ oneof [ AndFilter <$> arbitrary <*> arbitrary
630+ , OrFilter <$> arbitrary <*> arbitrary
631+ , NotFilter <$> arbitrary <*> arbitrary
632+ , pure IdentityFilter
633+ , BoolFilter <$> arbitrary
634+ , ExistsFilter <$> arbitrary
635+ , GeoBoundingBoxFilter <$> arbitrary
636+ , GeoDistanceFilter <$> arbitrary <*> arbitrary <*> arbitrary <*> arbitrary <*> arbitrary
637+ , GeoDistanceRangeFilter <$> arbitrary <*> arbitrary
638+ , GeoPolygonFilter <$> arbitrary <*> arbitrary
639+ , IdsFilter <$> arbitrary <*> arbitrary
640+ , LimitFilter <$> arbitrary
641+ , MissingFilter <$> arbitrary <*> arbitrary <*> arbitrary
642+ , PrefixFilter <$> arbitrary <*> arbitrary <*> arbitrary
643+ , QueryFilter <$> arbitrary <*> arbitrary
644+ , RangeFilter <$> arbitrary <*> arbitrary <*> arbitrary <*> arbitrary
645+ , RegexpFilter <$> arbitrary <*> arbitrary <*> arbitrary <*> arbitrary <*> arbitrary <*> arbitrary
646+ , TermFilter <$> arbitrary <*> arbitrary]
647+ shrink = genericShrink
648+
649+instance Arbitrary ReplicaBounds where
650+ arbitrary = oneof [ replicasBounded
651+ , replicasLowerBounded
652+ , pure ReplicasUnbounded
653+ ]
654+ where replicasBounded = do Positive a <- arbitrary
655+ Positive b <- arbitrary
656+ return (ReplicasBounded a b)
657+ replicasLowerBounded = do Positive a <- arbitrary
658+ return (ReplicasLowerBounded a)
659+
660+instance Arbitrary NodeAttrName where
661+ arbitrary = NodeAttrName . T.pack . getNonEmpty <$> arbitrary
662+
663+
664+instance Arbitrary NodeAttrFilter where
665+ arbitrary = do
666+ n <- arbitrary
667+ s:ss <- listOf1 (listOf1 arbitraryAlphaNum)
668+ let ts = T.pack <$> s :| ss
669+ return (NodeAttrFilter n ts)
670+
671+$(derive makeArbitrary ''IndexName)
672+$(derive makeArbitrary ''MappingName)
673+$(derive makeArbitrary ''DocId)
674+$(derive makeArbitrary ''Version)
675+$(derive makeArbitrary ''IndexAliasRouting)
676+$(derive makeArbitrary ''ShardCount)
677+$(derive makeArbitrary ''ReplicaCount)
678+$(derive makeArbitrary ''TemplateName)
679+$(derive makeArbitrary ''TemplatePattern)
680+$(derive makeArbitrary ''QueryString)
681+$(derive makeArbitrary ''CacheName)
682+$(derive makeArbitrary ''CacheKey)
683+$(derive makeArbitrary ''Existence)
684+$(derive makeArbitrary ''CutoffFrequency)
685+$(derive makeArbitrary ''Analyzer)
686+$(derive makeArbitrary ''MaxExpansions)
687+$(derive makeArbitrary ''Lenient)
688+$(derive makeArbitrary ''Tiebreaker)
689+$(derive makeArbitrary ''Boost)
690+$(derive makeArbitrary ''BoostTerms)
691+$(derive makeArbitrary ''MinimumMatch)
692+$(derive makeArbitrary ''DisableCoord)
693+$(derive makeArbitrary ''IgnoreTermFrequency)
694+$(derive makeArbitrary ''MinimumTermFrequency)
695+$(derive makeArbitrary ''MaxQueryTerms)
696+$(derive makeArbitrary ''Fuzziness)
697+$(derive makeArbitrary ''PrefixLength)
698+$(derive makeArbitrary ''TypeName)
699+$(derive makeArbitrary ''PercentMatch)
700+$(derive makeArbitrary ''StopWord)
701+$(derive makeArbitrary ''QueryPath)
702+$(derive makeArbitrary ''AllowLeadingWildcard)
703+$(derive makeArbitrary ''LowercaseExpanded)
704+$(derive makeArbitrary ''EnablePositionIncrements)
705+$(derive makeArbitrary ''AnalyzeWildcard)
706+$(derive makeArbitrary ''GeneratePhraseQueries)
707+$(derive makeArbitrary ''Locale)
708+$(derive makeArbitrary ''MaxWordLength)
709+$(derive makeArbitrary ''MinWordLength)
710+$(derive makeArbitrary ''PhraseSlop)
711+$(derive makeArbitrary ''MinDocFrequency)
712+$(derive makeArbitrary ''MaxDocFrequency)
713+$(derive makeArbitrary ''Regexp)
714+$(derive makeArbitrary ''SimpleQueryStringQuery)
715+$(derive makeArbitrary ''FieldOrFields)
716+$(derive makeArbitrary ''SimpleQueryFlag)
717+$(derive makeArbitrary ''RegexpQuery)
718+$(derive makeArbitrary ''QueryStringQuery)
719+$(derive makeArbitrary ''RangeQuery)
720+$(derive makeArbitrary ''RangeValue)
721+$(derive makeArbitrary ''PrefixQuery)
722+$(derive makeArbitrary ''NestedQuery)
723+$(derive makeArbitrary ''MoreLikeThisFieldQuery)
724+$(derive makeArbitrary ''MoreLikeThisQuery)
725+$(derive makeArbitrary ''IndicesQuery)
726+$(derive makeArbitrary ''HasParentQuery)
727+$(derive makeArbitrary ''HasChildQuery)
728+$(derive makeArbitrary ''FuzzyQuery)
729+$(derive makeArbitrary ''FuzzyLikeFieldQuery)
730+$(derive makeArbitrary ''FuzzyLikeThisQuery)
731+$(derive makeArbitrary ''FilteredQuery)
732+$(derive makeArbitrary ''DisMaxQuery)
733+$(derive makeArbitrary ''CommonTermsQuery)
734+$(derive makeArbitrary ''DistanceRange)
735+$(derive makeArbitrary ''MultiMatchQuery)
736+$(derive makeArbitrary ''LessThanD)
737+$(derive makeArbitrary ''LessThanEqD)
738+$(derive makeArbitrary ''GreaterThanD)
739+$(derive makeArbitrary ''GreaterThanEqD)
740+$(derive makeArbitrary ''LessThan)
741+$(derive makeArbitrary ''LessThanEq)
742+$(derive makeArbitrary ''GreaterThan)
743+$(derive makeArbitrary ''GreaterThanEq)
744+$(derive makeArbitrary ''GeoPoint)
745+$(derive makeArbitrary ''NullValue)
746+$(derive makeArbitrary ''MinimumMatchHighLow)
747+$(derive makeArbitrary ''CommonMinimumMatch)
748+$(derive makeArbitrary ''BoostingQuery)
749+$(derive makeArbitrary ''BoolQuery)
750+$(derive makeArbitrary ''MatchQuery)
751+$(derive makeArbitrary ''MultiMatchQueryType)
752+$(derive makeArbitrary ''BooleanOperator)
753+$(derive makeArbitrary ''ZeroTermsQuery)
754+$(derive makeArbitrary ''MatchQueryType)
755+$(derive makeArbitrary ''SearchAliasRouting)
756+$(derive makeArbitrary ''ScoreType)
757+$(derive makeArbitrary ''Distance)
758+$(derive makeArbitrary ''DistanceUnit)
759+$(derive makeArbitrary ''DistanceType)
760+$(derive makeArbitrary ''OptimizeBbox)
761+$(derive makeArbitrary ''GeoBoundingBoxConstraint)
762+$(derive makeArbitrary ''GeoFilterType)
763+$(derive makeArbitrary ''GeoBoundingBox)
764+$(derive makeArbitrary ''LatLon)
765+$(derive makeArbitrary ''RangeExecution)
766+$(derive makeArbitrary ''RegexpFlag)
767+$(derive makeArbitrary ''BoolMatch)
768+$(derive makeArbitrary ''Term)
769+$(derive makeArbitrary ''IndexSettings)
770+$(derive makeArbitrary ''UpdatableIndexSetting)
771+$(derive makeArbitrary ''Bytes)
772+$(derive makeArbitrary ''AllocationPolicy)
773+$(derive makeArbitrary ''InitialShardCount)
774+$(derive makeArbitrary ''FSType)
775+$(derive makeArbitrary ''CompoundFormat)
776+
35777
36778main :: IO ()
37779main = hspec $ do
38− Aggregation.spec
39− Bulk.spec
40− Documents.spec
41− Highlights.spec
42− Indices.spec
43− JSON.spec
44− Query.spec
45− Script.spec
46− Snapshots.spec
47− Sorting.spec
48− SourceFiltering.spec
49− Suggest.spec
50− Templates.spec
51−
52− describe "error parsing" $ do
53− it "can parse EsErrors for < 2.0" $ when' (atmost es16) $ withTestEnv $ do
780+
781+ describe "index create/delete API" $ do
782+ it "creates and then deletes the requested index" $ withTestEnv $ do
783+ -- priming state.
784+ _ <- deleteExampleIndex
785+ resp <- createExampleIndex
786+ deleteResp <- deleteExampleIndex
787+ liftIO $ do
788+ validateStatus resp 200
789+ validateStatus deleteResp 200
790+
791+ describe "error parsing" $ do
792+ it "can parse EsErrors" $ withTestEnv $ do
54793 res <- getDocument (IndexName "bogus") (MappingName "also_bogus") (DocId "bogus_as_well")
55794 let errorResp = eitherDecode (responseBody res)
56795 liftIO (errorResp `shouldBe` Right (EsError 404 "IndexMissingException[[bogus] missing]"))
57796
58− it "can parse EsErrors for >= 2.0" $ when' (atleast es20) $ withTestEnv $ do
59− res <- getDocument (IndexName "bogus") (MappingName "also_bogus") (DocId "bogus_as_well")
60− let errorResp = eitherDecode (responseBody res)
61− liftIO (errorResp `shouldBe` Right (EsError 404 "no such index"))
797+ describe "document API" $ do
798+ it "indexes, updates, gets, and then deletes the generated document" $ withTestEnv $ do
799+ _ <- insertData
800+ _ <- updateData
801+ docInserted <- getDocument testIndex testMapping (DocId "1")
802+ let newTweet = eitherDecode
803+ (responseBody docInserted) :: Either String (EsResult Tweet)
804+ liftIO $ (fmap getSource newTweet `shouldBe` Right (Just patchedTweet))
805+
806+ it "indexes, gets, and then deletes the generated document with a DocId containing a space" $ withTestEnv $ do
807+ _ <- insertWithSpaceInId
808+ docInserted <- getDocument testIndex testMapping (DocId "Hello World")
809+ let newTweet = eitherDecode
810+ (responseBody docInserted) :: Either String (EsResult Tweet)
811+ liftIO $ (fmap getSource newTweet `shouldBe` Right (Just exampleTweet))
812+
813+ it "produces a parseable result when looking up a bogus document" $ withTestEnv $ do
814+ doc <- getDocument testIndex testMapping (DocId "bogus")
815+ let noTweet = eitherDecode
816+ (responseBody doc) :: Either String (EsResult Tweet)
817+ liftIO $ fmap foundResult noTweet `shouldBe` Right Nothing
818+
819+ it "can use optimistic concurrency control" $ withTestEnv $ do
820+ let ev = ExternalDocVersion minBound
821+ let cfg = defaultIndexDocumentSettings { idsVersionControl = ExternalGT ev }
822+ resetIndex
823+ res <- insertData' cfg
824+ liftIO $ isCreated res `shouldBe` True
825+ res' <- insertData' cfg
826+ liftIO $ isVersionConflict res' `shouldBe` True
827+
828+ it "indexes two documents in a parent/child relationship and checks that the child exists" $ withTestEnv $ do
829+ resetIndex
830+ _ <- putMapping testIndex (MappingName "parent") ParentMapping
831+ _ <- putMapping testIndex (MappingName "child") ChildMapping
832+ _ <- indexDocument testIndex (MappingName "parent") defaultIndexDocumentSettings exampleTweet (DocId "1")
833+ let parent = (Just . DocumentParent . DocId) "1"
834+ ids = IndexDocumentSettings NoVersionControl parent
835+ _ <- indexDocument testIndex (MappingName "child") ids otherTweet (DocId "2")
836+ _ <- refreshIndex testIndex
837+ exists <- documentExists testIndex (MappingName "child") parent (DocId "2")
838+ liftIO $ exists `shouldBe` True
839+
840+ describe "template API" $ do
841+ it "can create a template" $ withTestEnv $ do
842+ let idxTpl = IndexTemplate (TemplatePattern "tweet-*") (Just (IndexSettings (ShardCount 1) (ReplicaCount 1))) [toJSON TweetMapping]
843+ resp <- putTemplate idxTpl (TemplateName "tweet-tpl")
844+ liftIO $ validateStatus resp 200
62845
63− describe "Monoid (SearchHits a)" $
846+ it "can detect if a template exists" $ withTestEnv $ do
847+ exists <- templateExists (TemplateName "tweet-tpl")
848+ liftIO $ exists `shouldBe` True
849+
850+ it "can delete a template" $ withTestEnv $ do
851+ resp <- deleteTemplate (TemplateName "tweet-tpl")
852+ liftIO $ validateStatus resp 200
853+
854+ it "can detect if a template doesn't exist" $ withTestEnv $ do
855+ exists <- templateExists (TemplateName "tweet-tpl")
856+ liftIO $ exists `shouldBe` False
857+
858+ describe "bulk API" $ do
859+ it "inserts all documents we request" $ withTestEnv $ do
860+ _ <- insertData
861+ let firstTest = BulkTest "blah"
862+ let secondTest = BulkTest "bloo"
863+ let firstDoc = BulkIndex testIndex
864+ testMapping (DocId "2") (toJSON firstTest)
865+ let secondDoc = BulkCreate testIndex
866+ testMapping (DocId "3") (toJSON secondTest)
867+ let stream = V.fromList [firstDoc, secondDoc]
868+ _ <- bulk stream
869+ _ <- refreshIndex testIndex
870+ fDoc <- getDocument testIndex testMapping (DocId "2")
871+ sDoc <- getDocument testIndex testMapping (DocId "3")
872+ let maybeFirst = eitherDecode $ responseBody fDoc :: Either String (EsResult BulkTest)
873+ let maybeSecond = eitherDecode $ responseBody sDoc :: Either String (EsResult BulkTest)
874+ liftIO $ do
875+ fmap getSource maybeFirst `shouldBe` Right (Just firstTest)
876+ fmap getSource maybeSecond `shouldBe` Right (Just secondTest)
877+
878+
879+ describe "query API" $ do
880+ it "returns document for term query and identity filter" $ withTestEnv $ do
881+ _ <- insertData
882+ let query = TermQuery (Term "user" "bitemyapp") Nothing
883+ let filter = IdentityFilter <&&> IdentityFilter
884+ let search = mkSearch (Just query) (Just filter)
885+ myTweet <- searchTweet search
886+ liftIO $
887+ myTweet `shouldBe` Right exampleTweet
888+
889+ it "handles constant score queries" $ withTestEnv $ do
890+ _ <- insertData
891+ let query = TermsQuery "user" ("bitemyapp" :| [])
892+ let cfQuery = ConstantScoreQuery query (Boost 1.0)
893+ let filter = IdentityFilter
894+ let search = mkSearch (Just cfQuery) (Just filter)
895+ myTweet <- searchTweet search
896+ liftIO $
897+ myTweet `shouldBe` Right exampleTweet
898+ it "handles constant score filters" $ withTestEnv $ do
899+ _ <- insertData
900+ let query = TermsQuery "user" ("bitemyapp" :| [])
901+ let cfFilter = ConstantScoreFilter IdentityFilter (Boost 1.0)
902+ let boolQuery = mkBoolQuery [query, cfFilter] [] []
903+ let search = mkSearch (Just (QueryBoolQuery boolQuery)) Nothing
904+ myTweet <- searchTweet search
905+ liftIO $
906+ myTweet `shouldBe` Right exampleTweet
907+
908+
909+ it "returns document for terms query and identity filter" $ withTestEnv $ do
910+ _ <- insertData
911+ let query = TermsQuery "user" ("bitemyapp" :| [])
912+ let filter = IdentityFilter <&&> IdentityFilter
913+ let search = mkSearch (Just query) (Just filter)
914+ myTweet <- searchTweet search
915+ liftIO $
916+ myTweet `shouldBe` Right exampleTweet
917+
918+ it "returns document for match query" $ withTestEnv $ do
919+ _ <- insertData
920+ let query = QueryMatchQuery $ mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
921+ let search = mkSearch (Just query) Nothing
922+ myTweet <- searchTweet search
923+ liftIO $
924+ myTweet `shouldBe` Right exampleTweet
925+
926+ it "returns document for multi-match query" $ withTestEnv $ do
927+ _ <- insertData
928+ let flds = [FieldName "user", FieldName "message"]
929+ let query = QueryMultiMatchQuery $ mkMultiMatchQuery flds (QueryString "bitemyapp")
930+ let search = mkSearch (Just query) Nothing
931+ myTweet <- searchTweet search
932+ liftIO $
933+ myTweet `shouldBe` Right exampleTweet
934+
935+ it "returns document for bool query" $ withTestEnv $ do
936+ _ <- insertData
937+ let innerQuery = QueryMatchQuery $
938+ mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
939+ let query = QueryBoolQuery $
940+ mkBoolQuery [innerQuery] [] []
941+ let search = mkSearch (Just query) Nothing
942+ myTweet <- searchTweet search
943+ liftIO $
944+ myTweet `shouldBe` Right exampleTweet
945+
946+ it "returns document for boosting query" $ withTestEnv $ do
947+ _ <- insertData
948+ let posQuery = QueryMatchQuery $ mkMatchQuery (FieldName "user") (QueryString "bitemyapp")
949+ let negQuery = QueryMatchQuery $ mkMatchQuery (FieldName "user") (QueryString "notmyapp")
950+ let query = QueryBoostingQuery $ BoostingQuery posQuery negQuery (Boost 0.2)
951+ let search = mkSearch (Just query) Nothing
952+ myTweet <- searchTweet search
953+ liftIO $
954+ myTweet `shouldBe` Right exampleTweet
955+
956+ it "returns document for common terms query" $ withTestEnv $ do
957+ _ <- insertData
958+ let query = QueryCommonTermsQuery $
959+ CommonTermsQuery (FieldName "user")
960+ (QueryString "bitemyapp")
961+ (CutoffFrequency 0.0001)
962+ Or Or Nothing Nothing Nothing Nothing
963+ let search = mkSearch (Just query) Nothing
964+ myTweet <- searchTweet search
965+ liftIO $
966+ myTweet `shouldBe` Right exampleTweet
967+
968+
969+ describe "sorting" $ do
970+ it "returns documents in the right order" $ withTestEnv $ do
971+ _ <- insertData
972+ _ <- insertOther
973+ let sortSpec = DefaultSortSpec $ mkSort (FieldName "age") Ascending
974+ let search = Search Nothing
975+ (Just IdentityFilter) (Just [sortSpec]) Nothing Nothing
976+ False (From 0) (Size 10) SearchTypeQueryThenFetch Nothing Nothing
977+ result <- searchTweets search
978+ let myTweet = grabFirst result
979+ liftIO $
980+ myTweet `shouldBe` Right otherTweet
981+
982+
983+ describe "filtering API" $ do
984+ it "returns document for composed boolmatch and identity" $ withTestEnv $ do
985+ _ <- insertData
986+ let queryFilter = BoolFilter (MustMatch (Term "user" "bitemyapp") False)
987+ <&&> IdentityFilter
988+ let search = mkSearch Nothing (Just queryFilter)
989+ myTweet <- searchTweet search
990+ liftIO $
991+ myTweet `shouldBe` Right exampleTweet
992+
993+ it "returns document for term filter" $ withTestEnv $ do
994+ _ <- insertData
995+ let termFilter = TermFilter (Term "user" "bitemyapp") False
996+ let search = mkSearch Nothing (Just termFilter)
997+ myTweet <- searchTweet search
998+ liftIO $
999+ myTweet `shouldBe` Right exampleTweet
1000+
1001+ it "returns document for existential filter" $ withTestEnv $ do
1002+ _ <- insertData
1003+ let search = mkSearch Nothing (Just (ExistsFilter (FieldName "user")))
1004+ myTweet <- searchTweet search
1005+ liftIO $
1006+ myTweet `shouldBe` Right exampleTweet
1007+
1008+ it "returns document for geo boundingbox filter" $ withTestEnv $ do
1009+ _ <- insertData
1010+ let box = GeoBoundingBox (LatLon 40.73 (-74.1)) (LatLon 40.10 (-71.12))
1011+ let bbConstraint = GeoBoundingBoxConstraint (FieldName "tweet.location") box False GeoFilterMemory
1012+ let geoFilter = GeoBoundingBoxFilter bbConstraint
1013+ let search = mkSearch Nothing (Just geoFilter)
1014+ myTweet <- searchTweet search
1015+ liftIO $
1016+ myTweet `shouldBe` Right exampleTweet
1017+
1018+ it "doesn't return document for nonsensical boundingbox filter" $ withTestEnv $ do
1019+ _ <- insertData
1020+ let box = GeoBoundingBox (LatLon 0.73 (-4.1)) (LatLon 0.10 (-1.12))
1021+ let bbConstraint = GeoBoundingBoxConstraint (FieldName "tweet.location") box False GeoFilterMemory
1022+ let geoFilter = GeoBoundingBoxFilter bbConstraint
1023+ let search = mkSearch Nothing (Just geoFilter)
1024+ searchExpectNoResults search
1025+
1026+ it "returns document for geo distance filter" $ withTestEnv $ do
1027+ _ <- insertData
1028+ let geoPoint = GeoPoint (FieldName "tweet.location") (LatLon 40.12 (-71.34))
1029+ let distance = Distance 10.0 Miles
1030+ let optimizeBbox = OptimizeGeoFilterType GeoFilterMemory
1031+ let geoFilter = GeoDistanceFilter geoPoint distance SloppyArc optimizeBbox False
1032+ let search = mkSearch Nothing (Just geoFilter)
1033+ myTweet <- searchTweet search
1034+ liftIO $
1035+ myTweet `shouldBe` Right exampleTweet
1036+
1037+ it "returns document for geo distance range filter" $ withTestEnv $ do
1038+ _ <- insertData
1039+ let geoPoint = GeoPoint (FieldName "tweet.location") (LatLon 40.12 (-71.34))
1040+ let distanceRange = DistanceRange (Distance 0.0 Miles) (Distance 10.0 Miles)
1041+ let geoFilter = GeoDistanceRangeFilter geoPoint distanceRange
1042+ let search = mkSearch Nothing (Just geoFilter)
1043+ myTweet <- searchTweet search
1044+ liftIO $
1045+ myTweet `shouldBe` Right exampleTweet
1046+
1047+ it "doesn't return document for wild geo distance range filter" $ withTestEnv $ do
1048+ _ <- insertData
1049+ let geoPoint = GeoPoint (FieldName "tweet.location") (LatLon 40.12 (-71.34))
1050+ let distanceRange = DistanceRange (Distance 100.0 Miles) (Distance 1000.0 Miles)
1051+ let geoFilter = GeoDistanceRangeFilter geoPoint distanceRange
1052+ let search = mkSearch Nothing (Just geoFilter)
1053+ searchExpectNoResults search
1054+
1055+ it "returns document for geo polygon filter" $ withTestEnv $ do
1056+ _ <- insertData
1057+ let points = [LatLon 40.0 (-70.00),
1058+ LatLon 40.0 (-72.00),
1059+ LatLon 41.0 (-70.00),
1060+ LatLon 41.0 (-72.00)]
1061+ let geoFilter = GeoPolygonFilter (FieldName "tweet.location") points
1062+ let search = mkSearch Nothing (Just geoFilter)
1063+ myTweet <- searchTweet search
1064+ liftIO $
1065+ myTweet `shouldBe` Right exampleTweet
1066+
1067+ it "doesn't return document for bad geo polygon filter" $ withTestEnv $ do
1068+ _ <- insertData
1069+ let points = [LatLon 40.0 (-70.00),
1070+ LatLon 40.0 (-71.00),
1071+ LatLon 41.0 (-70.00),
1072+ LatLon 41.0 (-71.00)]
1073+ let geoFilter = GeoPolygonFilter (FieldName "tweet.location") points
1074+ let search = mkSearch Nothing (Just geoFilter)
1075+ searchExpectNoResults search
1076+
1077+ it "returns document for ids filter" $ withTestEnv $ do
1078+ _ <- insertData
1079+ let filter = IdsFilter (MappingName "tweet") [DocId "1"]
1080+ let search = mkSearch Nothing (Just filter)
1081+ myTweet <- searchTweet search
1082+ liftIO $
1083+ myTweet `shouldBe` Right exampleTweet
1084+
1085+ it "returns document for Double range filter" $ withTestEnv $ do
1086+ _ <- insertData
1087+ let filter = RangeFilter (FieldName "age")
1088+ (RangeDoubleGtLt (GreaterThan 1000.0) (LessThan 100000.0))
1089+ RangeExecutionIndex False
1090+ let search = mkSearch Nothing (Just filter)
1091+ myTweet <- searchTweet search
1092+ liftIO $
1093+ myTweet `shouldBe` Right exampleTweet
1094+
1095+ it "returns document for UTCTime date filter" $ withTestEnv $ do
1096+ _ <- insertData
1097+ let filter = RangeFilter (FieldName "postDate")
1098+ (RangeDateGtLt
1099+ (GreaterThanD (UTCTime
1100+ (ModifiedJulianDay 54000)
1101+ (secondsToDiffTime 0)))
1102+ (LessThanD (UTCTime
1103+ (ModifiedJulianDay 55000)
1104+ (secondsToDiffTime 11))))
1105+ RangeExecutionIndex False
1106+ let search = mkSearch Nothing (Just filter)
1107+ myTweet <- searchTweet search
1108+ liftIO $
1109+ myTweet `shouldBe` Right exampleTweet
1110+
1111+ it "returns document for regexp filter" $ withTestEnv $ do
1112+ _ <- insertData
1113+ let filter = RegexpFilter (FieldName "user") (Regexp "bite.*app")
1114+ AllRegexpFlags (CacheName "test") False (CacheKey "key")
1115+ let search = mkSearch Nothing (Just filter)
1116+ myTweet <- searchTweet search
1117+ liftIO $
1118+ myTweet `shouldBe` Right exampleTweet
1119+
1120+ it "doesn't return document for non-matching regexp filter" $ withTestEnv $ do
1121+ _ <- insertData
1122+ let filter = RegexpFilter (FieldName "user")
1123+ (Regexp "boy") AllRegexpFlags
1124+ (CacheName "test") False (CacheKey "key")
1125+ let search = mkSearch Nothing (Just filter)
1126+ searchExpectNoResults search
1127+
1128+ it "returns document for query filter, uncached" $ withTestEnv $ do
1129+ _ <- insertData
1130+ let filter = QueryFilter (TermQuery (Term "user" "bitemyapp") Nothing) True
1131+ search = mkSearch Nothing (Just filter)
1132+ myTweet <- searchTweet search
1133+ liftIO $ myTweet `shouldBe` Right exampleTweet
1134+
1135+ it "returns document for query filter, cached" $ withTestEnv $ do
1136+ _ <- insertData
1137+ let filter = QueryFilter (TermQuery (Term "user" "bitemyapp") Nothing) False
1138+ search = mkSearch Nothing (Just filter)
1139+ myTweet <- searchTweet search
1140+ liftIO $ myTweet `shouldBe` Right exampleTweet
1141+
1142+ describe "Aggregation API" $ do
1143+ it "returns term aggregation results" $ withTestEnv $ do
1144+ _ <- insertData
1145+ let terms = TermsAgg $ mkTermsAggregation "user"
1146+ let search = mkAggregateSearch Nothing $ mkAggregations "users" terms
1147+ searchExpectAggs search
1148+ searchValidBucketAgg search "users" toTerms
1149+
1150+ it "can give collection hint parameters to term aggregations" $ when' (atleast es13) $ withTestEnv $ do
1151+ _ <- insertData
1152+ let terms = TermsAgg $ (mkTermsAggregation "user") { termCollectMode = Just BreadthFirst }
1153+ let search = mkAggregateSearch Nothing $ mkAggregations "users" terms
1154+ searchExpectAggs search
1155+ searchValidBucketAgg search "users" toTerms
1156+
1157+ it "can give execution hint parameters to term aggregations" $ when' (atmost es11) $ withTestEnv $ do
1158+ _ <- insertData
1159+ searchTermsAggHint [Map, Ordinals]
1160+
1161+ it "can give execution hint parameters to term aggregations" $ when' (is es12) $ withTestEnv $ do
1162+ _ <- insertData
1163+ searchTermsAggHint [GlobalOrdinals, GlobalOrdinalsHash, GlobalOrdinalsLowCardinality, Map, Ordinals]
1164+
1165+ it "can give execution hint parameters to term aggregations" $ when' (atleast es12) $ withTestEnv $ do
1166+ _ <- insertData
1167+ searchTermsAggHint [GlobalOrdinals, GlobalOrdinalsHash, GlobalOrdinalsLowCardinality, Map]
1168+
1169+
1170+ it "can execute value_count aggregations" $ withTestEnv $ do
1171+ _ <- insertData
1172+ _ <- insertOther
1173+ let ags = mkAggregations "user_count" (ValueCountAgg (FieldValueCount (FieldName "user"))) <>
1174+ mkAggregations "bogus_count" (ValueCountAgg (FieldValueCount (FieldName "bogus")))
1175+ let search = mkAggregateSearch Nothing ags
1176+ let docCountPair k n = (k, object ["value" .= Number n])
1177+ res <- searchTweets search
1178+ liftIO $
1179+ fmap aggregations res `shouldBe` Right (Just (M.fromList [ docCountPair "user_count" 2
1180+ , docCountPair "bogus_count" 0
1181+ ]))
1182+
1183+ it "can execute filter aggregations" $ withTestEnv $ do
1184+ _ <- insertData
1185+ _ <- insertOther
1186+ let ags = mkAggregations "bitemyapps" (FilterAgg (FilterAggregation (TermFilter (Term "user" "bitemyapp") defaultCache) Nothing)) <>
1187+ mkAggregations "notmyapps" (FilterAgg (FilterAggregation (TermFilter (Term "user" "notmyapp") defaultCache) Nothing))
1188+ let search = mkAggregateSearch Nothing ags
1189+ let docCountPair k n = (k, object ["doc_count" .= Number n])
1190+ res <- searchTweets search
1191+ liftIO $
1192+ fmap aggregations res `shouldBe` Right (Just (M.fromList [ docCountPair "bitemyapps" 1
1193+ , docCountPair "notmyapps" 1
1194+ ]))
1195+ it "can execute date_range aggregations" $ withTestEnv $ do
1196+ let now = fromGregorian 2015 3 14
1197+ let ltAMonthAgo = UTCTime (fromGregorian 2015 3 1) 0
1198+ let ltAWeekAgo = UTCTime (fromGregorian 2015 3 10) 0
1199+ let oldDoc = exampleTweet { postDate = ltAMonthAgo }
1200+ let newDoc = exampleTweet { postDate = ltAWeekAgo }
1201+ _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings oldDoc (DocId "1")
1202+ _ <- indexDocument testIndex testMapping defaultIndexDocumentSettings newDoc (DocId "2")
1203+ _ <- refreshIndex testIndex
1204+ let thisMonth = DateRangeFrom (DateMathExpr (DMDate now) [SubtractTime 1 DMMonth])
1205+ let thisWeek = DateRangeFrom (DateMathExpr (DMDate now) [SubtractTime 1 DMWeek])
1206+ let agg = DateRangeAggregation (FieldName "postDate") Nothing (thisMonth :| [thisWeek])
1207+ let ags = mkAggregations "date_ranges" (DateRangeAgg agg)
1208+ let search = mkAggregateSearch Nothing ags
1209+ res <- searchTweets search
1210+ liftIO $ hitsTotal . searchHits <$> res `shouldBe` Right 2
1211+ let bucks = do magrs <- fmapL show (aggregations <$> res)
1212+ agrs <- note "no aggregations returned" magrs
1213+ rawBucks <- note "no date_ranges aggregation" $ M.lookup "date_ranges" agrs
1214+ parseEither parseJSON rawBucks
1215+ let fromMonthT = UTCTime (fromGregorian 2015 2 14) 0
1216+ let fromWeekT = UTCTime (fromGregorian 2015 3 7) 0
1217+ liftIO $ buckets <$> bucks `shouldBe` Right [ DateRangeResult "2015-02-14T00:00:00.000Z-*"
1218+ (Just fromMonthT)
1219+ (Just "2015-02-14T00:00:00.000Z")
1220+ Nothing
1221+ Nothing
1222+ 2
1223+ Nothing
1224+ , DateRangeResult "2015-03-07T00:00:00.000Z-*"
1225+ (Just fromWeekT)
1226+ (Just "2015-03-07T00:00:00.000Z")
1227+ Nothing
1228+ Nothing
1229+ 1
1230+ Nothing
1231+ ]
1232+
1233+ it "returns date histogram aggregation results" $ withTestEnv $ do
1234+ _ <- insertData
1235+ let histogram = DateHistogramAgg $ mkDateHistogram (FieldName "postDate") Minute
1236+ let search = mkAggregateSearch Nothing (mkAggregations "byDate" histogram)
1237+ searchExpectAggs search
1238+ searchValidBucketAgg search "byDate" toDateHistogram
1239+
1240+ it "returns date histogram using fractional date" $ withTestEnv $ do
1241+ _ <- insertData
1242+ let periods = [Year, Quarter, Month, Week, Day, Hour, Minute, Second]
1243+ let fractionals = map (FractionalInterval 1.5) [Weeks, Days, Hours, Minutes, Seconds]
1244+ let intervals = periods ++ fractionals
1245+ let histogram = mkDateHistogram (FieldName "postDate")
1246+ let search interval = mkAggregateSearch Nothing $ mkAggregations "byDate" $ DateHistogramAgg (histogram interval)
1247+ let expect interval = searchExpectAggs (search interval)
1248+ let valid interval = searchValidBucketAgg (search interval) "byDate" toDateHistogram
1249+ forM_ intervals expect
1250+ forM_ intervals valid
1251+
1252+ it "can execute missing aggregations" $ withTestEnv $ do
1253+ _ <- insertData
1254+ _ <- insertExtra
1255+ let ags = mkAggregations "missing_agg" (MissingAgg (MissingAggregation "extra"))
1256+ let search = mkAggregateSearch Nothing ags
1257+ let docCountPair k n = (k, object ["doc_count" .= Number n])
1258+ res <- searchTweets search
1259+ liftIO $
1260+ fmap aggregations res `shouldBe` Right (Just (M.fromList [docCountPair "missing_agg" 1]))
1261+
1262+ describe "Highlights API" $ do
1263+
1264+ it "returns highlight from query when there should be one" $ withTestEnv $ do
1265+ _ <- insertData
1266+ _ <- insertOther
1267+ let query = QueryMatchQuery $ mkMatchQuery (FieldName "_all") (QueryString "haskell")
1268+ let testHighlight = Highlights Nothing [FieldHighlight (FieldName "message") Nothing]
1269+
1270+ let search = mkHighlightSearch (Just query) testHighlight
1271+ myHighlight <- searchTweetHighlight search
1272+ liftIO $
1273+ myHighlight `shouldBe` Right (Just (M.fromList [("message",["Use <em>haskell</em>!"])]))
1274+
1275+ it "doesn't return highlight from a query when it shouldn't" $ withTestEnv $ do
1276+ _ <- insertData
1277+ _ <- insertOther
1278+ let query = QueryMatchQuery $ mkMatchQuery (FieldName "_all") (QueryString "haskell")
1279+ let testHighlight = Highlights Nothing [FieldHighlight (FieldName "user") Nothing]
1280+
1281+ let search = mkHighlightSearch (Just query) testHighlight
1282+ myHighlight <- searchTweetHighlight search
1283+ liftIO $
1284+ myHighlight `shouldBe` Right Nothing
1285+
1286+ describe "Source filtering" $ do
1287+
1288+ it "doesn't include source when sources are disabled" $ withTestEnv $ do
1289+ searchExpectSource
1290+ NoSource
1291+ (Left (EsError 500 "Source was missing"))
1292+
1293+ it "includes a source" $ withTestEnv $ do
1294+ searchExpectSource
1295+ (SourcePatterns (PopPattern (Pattern "message")))
1296+ (Right (Object (HM.fromList [("message", String "Use haskell!")])))
1297+
1298+ it "includes sources" $ withTestEnv $ do
1299+ searchExpectSource
1300+ (SourcePatterns (PopPatterns [Pattern "user", Pattern "message"]))
1301+ (Right (Object (HM.fromList [("user",String "bitemyapp"),("message", String "Use haskell!")])))
1302+
1303+ it "includes source patterns" $ withTestEnv $ do
1304+ searchExpectSource
1305+ (SourcePatterns (PopPattern (Pattern "*ge")))
1306+ (Right (Object (HM.fromList [("age", Number 10000),("message", String "Use haskell!")])))
1307+
1308+ it "excludes source patterns" $ withTestEnv $ do
1309+ searchExpectSource
1310+ (SourceIncludeExclude (Include [])
1311+ (Exclude [Pattern "l*", Pattern "*ge", Pattern "postDate", Pattern "extra"]))
1312+ (Right (Object (HM.fromList [("user",String "bitemyapp")])))
1313+
1314+ describe "ToJSON RegexpFlags" $ do
1315+ it "generates the correct JSON for AllRegexpFlags" $
1316+ toJSON AllRegexpFlags `shouldBe` String "ALL"
1317+
1318+ it "generates the correct JSON for NoRegexpFlags" $
1319+ toJSON NoRegexpFlags `shouldBe` String "NONE"
1320+
1321+ it "generates the correct JSON for SomeRegexpFlags" $
1322+ let flags = AnyString :| [ Automaton
1323+ , Complement
1324+ , Empty
1325+ , Intersection
1326+ , Interval ]
1327+ in toJSON (SomeRegexpFlags flags) `shouldBe` String "ANYSTRING|AUTOMATON|COMPLEMENT|EMPTY|INTERSECTION|INTERVAL"
1328+
1329+ prop "removes duplicates from flags" $ \(flags :: RegexpFlags) ->
1330+ let String str = toJSON flags
1331+ flagStrs = T.splitOn "|" str
1332+ in noDuplicates flagStrs
1333+
1334+ describe "omitNulls" $ do
1335+ it "checks that omitNulls drops list elements when it should" $
1336+ let dropped = omitNulls $ [ "test1" .= (toJSON ([] :: [Int]))
1337+ , "test2" .= (toJSON ("some value" :: Text))]
1338+ in dropped `shouldBe` Object (HM.fromList [("test2", String "some value")])
1339+
1340+ it "checks that omitNulls doesn't drop list elements when it shouldn't" $
1341+ let notDropped = omitNulls $ [ "test1" .= (toJSON ([1] :: [Int]))
1342+ , "test2" .= (toJSON ("some value" :: Text))]
1343+ in notDropped `shouldBe` Object (HM.fromList [ ("test1", Array (V.fromList [Number 1.0]))
1344+ , ("test2", String "some value")])
1345+ it "checks that omitNulls drops non list elements when it should" $
1346+ let dropped = omitNulls $ [ "test1" .= (toJSON Null)
1347+ , "test2" .= (toJSON ("some value" :: Text))]
1348+ in dropped `shouldBe` Object (HM.fromList [("test2", String "some value")])
1349+ it "checks that omitNulls doesn't drop non list elements when it shouldn't" $
1350+ let notDropped = omitNulls $ [ "test1" .= (toJSON (1 :: Int))
1351+ , "test2" .= (toJSON ("some value" :: Text))]
1352+ in notDropped `shouldBe` Object (HM.fromList [ ("test1", Number 1.0)
1353+ , ("test2", String "some value")])
1354+ describe "Monoid (SearchHits a)" $ do
641355 prop "abides the monoid laws" $ eq $
651356 prop_Monoid (T :: T (SearchHits ()))
661357
67− describe "mkDocVersion" $
1358+ describe "mkDocVersion" $ do
681359 prop "can never construct an out of range docVersion" $ \i ->
691360 let res = mkDocVersion i
701361 in case res of
@@ -73,27 +1364,7 @@ main = hspec $ do
731364 (dv <= maxBound) .&&.
741365 docVersionNumber dv === i
751366
76− describe "getNodesInfo" $
77− it "fetches the responding node when LocalNode is used" $ withTestEnv $ do
78− res <- getNodesInfo LocalNode
79− liftIO $ case res of
80− -- This is really just a smoke test for response
81− -- parsing. Node info is so variable, there's not much I can
82− -- assert here.
83− Right NodesInfo {..} -> length nodesInfo `shouldBe` 1
84− Left e -> expectationFailure ("Expected NodesInfo but got " <> show e)
85−
86− describe "getNodesStats" $
87− it "fetches the responding node when LocalNode is used" $ withTestEnv $ do
88− res <- getNodesStats LocalNode
89− liftIO $ case res of
90− -- This is really just a smoke test for response
91− -- parsing. Node stats is so variable, there's not much I can
92− -- assert here.
93− Right NodesStats {..} -> length nodesStats `shouldBe` 1
94− Left e -> expectationFailure ("Expected NodesStats but got " <> show e)
95−
96− describe "Enum DocVersion" $
1367+ describe "Enum DocVersion" $ do
971368 it "follows the laws of Enum, Bounded" $ do
981369 evaluate (succ maxBound :: DocVersion) `shouldThrow` anyErrorCall
991370 evaluate (pred minBound :: DocVersion) `shouldThrow` anyErrorCall
@@ -103,14 +1374,11 @@ main = hspec $ do
1031374 enumFrom (pred maxBound :: DocVersion) `shouldBe` [pred maxBound, maxBound]
1041375 enumFromThen minBound (pred maxBound :: DocVersion) `shouldBe` [minBound, pred maxBound]
1051376
106− describe "Scan & Scroll API" $
1377+ describe "scan&scroll API" $ do
1071378 it "returns documents using the scan&scroll API" $ withTestEnv $ do
1081379 _ <- insertData
1091380 _ <- insertOther
110− let search =
111− (mkSearch
112− (Just $ MatchAllQuery Nothing) Nothing)
113− { size = Size 1 }
1381+ let search = (mkSearch (Just $ MatchAllQuery Nothing) Nothing) { size = (Size 1) }
1141382 regular_search <- searchTweet search
1151383 scan_search' <- scanSearch testIndex testMapping search :: BH IO [Hit Tweet]
1161384 let scan_search = map hitSource scan_search'
@@ -119,18 +1387,171 @@ main = hspec $ do
1191387 liftIO $
1201388 scan_search `shouldMatchList` [Just exampleTweet, Just otherTweet]
1211389
122− describe "Search After API" $
123− it "returns document for search after query" $ withTestEnv $ do
124− _ <- insertData
125− _ <- insertOther
126− let
127− sortSpec = DefaultSortSpec $ mkSort (FieldName "user") Ascending
128− searchAfterKey = [Aeson.toJSON ("bitemyapp" :: String)]
129− search = Search Nothing
130− Nothing (Just [sortSpec]) Nothing Nothing
131− False (From 0) (Size 10) SearchTypeQueryThenFetch (Just searchAfterKey)
132− Nothing Nothing Nothing Nothing
133− result <- searchTweets search
134− let myTweet = grabFirst result
1390+ describe "index aliases" $ do
1391+ it "handles the simple case of aliasing an existing index" $ do
1392+ let alias = IndexAlias (testIndex) (IndexAliasName (IndexName "bloodhound-tests-twitter-1-alias"))
1393+ let create = IndexAliasCreate Nothing Nothing
1394+ let action = AddAlias alias create
1395+
1396+ withTestEnv $ do
1397+ resetIndex
1398+ resp <- updateIndexAliases (action :| [])
1399+ liftIO $ validateStatus resp 200
1400+ let cleanup = withTestEnv (updateIndexAliases (RemoveAlias alias :| []))
1401+ (do aliases <- withTestEnv getIndexAliases
1402+ let expected = IndexAliasSummary alias create
1403+ case aliases of
1404+ Right (IndexAliasesSummary summs) ->
1405+ L.find ((== alias) . indexAliasSummaryAlias) summs `shouldBe` Just expected
1406+ Left e -> expectationFailure ("Expected an IndexAliasesSummary but got " <> show e)) `finally` cleanup
1407+
1408+ it "handles an alias with routing and a filter" $ do
1409+ let alias = IndexAlias (testIndex) (IndexAliasName (IndexName "bloodhound-tests-twitter-1-alias"))
1410+ let sar = SearchAliasRouting (RoutingValue "search val" :| [])
1411+ let iar = IndexAliasRouting (RoutingValue "index val")
1412+ let routing = GranularAliasRouting (Just sar) (Just iar)
1413+ let filter = LimitFilter 42
1414+ let create = IndexAliasCreate (Just routing) (Just filter)
1415+ let action = AddAlias alias create
1416+
1417+ withTestEnv $ do
1418+ resetIndex
1419+ resp <- updateIndexAliases (action :| [])
1420+ liftIO $ validateStatus resp 200
1421+ let cleanup = withTestEnv (updateIndexAliases (RemoveAlias alias :| []))
1422+ (do aliases <- withTestEnv getIndexAliases
1423+ let expected = IndexAliasSummary alias create
1424+ case aliases of
1425+ Right (IndexAliasesSummary summs) ->
1426+ L.find ((== alias) . indexAliasSummaryAlias) summs `shouldBe` Just expected
1427+ Left e -> expectationFailure ("Expected an IndexAliasesSummary but got " <> show e)) `finally` cleanup
1428+
1429+ describe "Index Listing" $ do
1430+ it "returns a list of index names" $ withTestEnv $ do
1431+ _ <- createExampleIndex
1432+ ixns <- listIndices
1433+ liftIO (ixns `shouldContain` [testIndex])
1434+
1435+ describe "Index Settings" $ do
1436+ it "persists settings" $ withTestEnv $ do
1437+ _ <- deleteExampleIndex
1438+ _ <- createExampleIndex
1439+ let updates = BlocksWrite False :| []
1440+ updateResp <- updateIndexSettings updates testIndex
1441+ liftIO $ validateStatus updateResp 200
1442+ getResp <- getIndexSettings testIndex
1351443 liftIO $
136− myTweet `shouldBe` Right otherTweet
1444+ getResp `shouldBe` Right (IndexSettingsSummary
1445+ testIndex
1446+ (IndexSettings (ShardCount 1) (ReplicaCount 0))
1447+ (NE.toList updates))
1448+
1449+ describe "Index Optimization" $ do
1450+ it "returns a successful response upon completion" $ withTestEnv $ do
1451+ _ <- createExampleIndex
1452+ resp <- optimizeIndex (IndexList (testIndex :| [])) defaultIndexOptimizationSettings
1453+ liftIO $ validateStatus resp 200
1454+
1455+ describe "JSON instances" $ do
1456+ propJSON (Proxy :: Proxy Version)
1457+ propJSON (Proxy :: Proxy IndexName)
1458+ propJSON (Proxy :: Proxy MappingName)
1459+ propJSON (Proxy :: Proxy DocId)
1460+ propJSON (Proxy :: Proxy IndexAliasRouting)
1461+ propJSON (Proxy :: Proxy RoutingValue)
1462+ propJSON (Proxy :: Proxy ShardCount)
1463+ propJSON (Proxy :: Proxy ReplicaCount)
1464+ propJSON (Proxy :: Proxy TemplateName)
1465+ propJSON (Proxy :: Proxy TemplatePattern)
1466+ propJSON (Proxy :: Proxy QueryString)
1467+ propJSON (Proxy :: Proxy FieldName)
1468+ propJSON (Proxy :: Proxy CacheName)
1469+ propJSON (Proxy :: Proxy CacheKey)
1470+ propJSON (Proxy :: Proxy Existence)
1471+ propJSON (Proxy :: Proxy CutoffFrequency)
1472+ propJSON (Proxy :: Proxy Analyzer)
1473+ propJSON (Proxy :: Proxy MaxExpansions)
1474+ propJSON (Proxy :: Proxy Lenient)
1475+ propJSON (Proxy :: Proxy Tiebreaker)
1476+ propJSON (Proxy :: Proxy Boost)
1477+ propJSON (Proxy :: Proxy BoostTerms)
1478+ propJSON (Proxy :: Proxy MinimumMatch)
1479+ propJSON (Proxy :: Proxy DisableCoord)
1480+ propJSON (Proxy :: Proxy IgnoreTermFrequency)
1481+ propJSON (Proxy :: Proxy MinimumTermFrequency)
1482+ propJSON (Proxy :: Proxy MaxQueryTerms)
1483+ propJSON (Proxy :: Proxy Fuzziness)
1484+ propJSON (Proxy :: Proxy PrefixLength)
1485+ propJSON (Proxy :: Proxy TypeName)
1486+ propJSON (Proxy :: Proxy PercentMatch)
1487+ propJSON (Proxy :: Proxy StopWord)
1488+ propJSON (Proxy :: Proxy QueryPath)
1489+ propJSON (Proxy :: Proxy AllowLeadingWildcard)
1490+ propJSON (Proxy :: Proxy LowercaseExpanded)
1491+ propJSON (Proxy :: Proxy EnablePositionIncrements)
1492+ propJSON (Proxy :: Proxy AnalyzeWildcard)
1493+ propJSON (Proxy :: Proxy GeneratePhraseQueries)
1494+ propJSON (Proxy :: Proxy Locale)
1495+ propJSON (Proxy :: Proxy MaxWordLength)
1496+ propJSON (Proxy :: Proxy MinWordLength)
1497+ propJSON (Proxy :: Proxy PhraseSlop)
1498+ propJSON (Proxy :: Proxy MinDocFrequency)
1499+ propJSON (Proxy :: Proxy MaxDocFrequency)
1500+ propJSON (Proxy :: Proxy Filter)
1501+ propJSON (Proxy :: Proxy Query)
1502+ propJSON (Proxy :: Proxy SimpleQueryStringQuery)
1503+ propJSON (Proxy :: Proxy FieldOrFields)
1504+ propJSON (Proxy :: Proxy SimpleQueryFlag)
1505+ propJSON (Proxy :: Proxy RegexpQuery)
1506+ propJSON (Proxy :: Proxy QueryStringQuery)
1507+ propJSON (Proxy :: Proxy RangeQuery)
1508+ propJSON (Proxy :: Proxy PrefixQuery)
1509+ propJSON (Proxy :: Proxy NestedQuery)
1510+ propJSON (Proxy :: Proxy MoreLikeThisFieldQuery)
1511+ propJSON (Proxy :: Proxy MoreLikeThisQuery)
1512+ propJSON (Proxy :: Proxy IndicesQuery)
1513+ propJSON (Proxy :: Proxy HasParentQuery)
1514+ propJSON (Proxy :: Proxy HasChildQuery)
1515+ propJSON (Proxy :: Proxy FuzzyQuery)
1516+ propJSON (Proxy :: Proxy FuzzyLikeFieldQuery)
1517+ propJSON (Proxy :: Proxy FuzzyLikeThisQuery)
1518+ propJSON (Proxy :: Proxy FilteredQuery)
1519+ propJSON (Proxy :: Proxy DisMaxQuery)
1520+ propJSON (Proxy :: Proxy CommonTermsQuery)
1521+ propJSON (Proxy :: Proxy CommonMinimumMatch)
1522+ propJSON (Proxy :: Proxy BoostingQuery)
1523+ propJSON (Proxy :: Proxy BoolQuery)
1524+ propJSON (Proxy :: Proxy MatchQuery)
1525+ propJSON (Proxy :: Proxy MultiMatchQueryType)
1526+ propJSON (Proxy :: Proxy BooleanOperator)
1527+ propJSON (Proxy :: Proxy ZeroTermsQuery)
1528+ propJSON (Proxy :: Proxy MatchQueryType)
1529+ propJSON (Proxy :: Proxy AliasRouting)
1530+ propJSON (Proxy :: Proxy IndexAliasCreate)
1531+ propJSON (Proxy :: Proxy SearchAliasRouting)
1532+ propJSON (Proxy :: Proxy ScoreType)
1533+ propJSON (Proxy :: Proxy Distance)
1534+ propJSON (Proxy :: Proxy DistanceUnit)
1535+ propJSON (Proxy :: Proxy DistanceType)
1536+ propJSON (Proxy :: Proxy OptimizeBbox)
1537+ propJSON (Proxy :: Proxy GeoBoundingBoxConstraint)
1538+ propJSON (Proxy :: Proxy GeoFilterType)
1539+ propJSON (Proxy :: Proxy GeoBoundingBox)
1540+ propJSON (Proxy :: Proxy LatLon)
1541+ propJSON (Proxy :: Proxy RangeExecution)
1542+ prop "RegexpFlags FromJSON/ToJSON roundtrips, removing dups " $ \rfs ->
1543+ let expected = case rfs of
1544+ SomeRegexpFlags fs -> SomeRegexpFlags (NE.fromList (nub (NE.toList fs)))
1545+ x -> x
1546+ in parseEither parseJSON (toJSON rfs) === Right expected
1547+ propJSON (Proxy :: Proxy BoolMatch)
1548+ propJSON (Proxy :: Proxy Term)
1549+ propJSON (Proxy :: Proxy MultiMatchQuery)
1550+ propJSON (Proxy :: Proxy IndexSettings)
1551+ propJSON (Proxy :: Proxy UpdatableIndexSetting)
1552+ propJSON (Proxy :: Proxy ReplicaBounds)
1553+ propJSON (Proxy :: Proxy Bytes)
1554+ propJSON (Proxy :: Proxy AllocationPolicy)
1555+ propJSON (Proxy :: Proxy InitialShardCount)
1556+ propJSON (Proxy :: Proxy FSType)
1557+ propJSON (Proxy :: Proxy CompoundFormat)