80984f2 · typeable/bloodhound

git.iko.soy/typeable/bloodhound

Merge pull request #231 from ymyzk/fix-typo

Fix typo: ElasticSearch -> Elasticsearch

commit80984f212561db4c3fc0d44270b7ad5d48429707 authorChris Allen <cma@bitemyapp.com> dateSat 31 Mar 2018, 22:40 (9 years ago) parent7e178ae ee1b51e

8 files changed+34−34

compare with master

unifiedsplit

DSL.org+1−1 README.md+7−7 bloodhound.cabal+2−2 examples/README.md+1−1 src/Database/V1/Bloodhound/Client.hs+3−3 src/Database/V1/Bloodhound/Types.hs+7−7 src/Database/V5/Bloodhound/Client.hs+3−3 src/Database/V5/Bloodhound/Types.hs+10−10

DSL.org+1−1

@@ -1,4 +1,4 @@

1−* ElasticSearch DSL

1+* Elasticsearch DSL

33** Grouping

README.md+7−7

@@ -22,17 +22,17 @@ Version compatibility

2222---------------------

2323

2424As 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

25+Elasticsearch versions 1 and 5. Import the module that is appropriate

2626for your use case. If you would like to add support for another major

2727version, open a ticket expressing your intend and follow the pattern

2828used for other versions. We weighed the idea of sharing code between

2929versions but it just got too messy, especially considering the

30−instability of the ElasticSearch API. We switched to a model which

30+instability of the Elasticsearch API. We switched to a model which

3131would allow the persons responsible for a particular protocol version

3232to maintain that version while avoiding conflict with other versions.

3333

3434See our [TravisCI](https://travis-ci.org/bitemyapp/bloodhound) for a

35−listing of ElasticSearch version we test against.

35+listing of Elasticsearch version we test against.

3636

3737

3838Stability

@@ -43,15 +43,15 @@ Bloodhound is stable for production use. I will strive to avoid breaking API com

4343Testing

4444---------

4545

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.

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.

4747

4848Steps 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.

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.

5050 2. Install [Stack] (http://docs.haskellstack.org/en/stable/README.html#how-to-install)

5151 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.

52+ 4. Start the desired version of Elasticsearch at `localhost:9200`, which should be the default.

5353 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`.

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`.

5555

5656

5757Hackage page and Haddock documentation

bloodhound.cabal+2−2

@@ -1,7 +1,7 @@

11name: bloodhound

22version: 0.16.0.0

3−synopsis: ElasticSearch client library for Haskell

4−description: ElasticSearch made awesome for Haskell hackers

3+synopsis: Elasticsearch client library for Haskell

4+description: Elasticsearch made awesome for Haskell hackers

55homepage: https://github.com/bitemyapp/bloodhound

66license: BSD3

77license-file: LICENSE

examples/README.md+1−1

@@ -1,6 +1,6 @@

11# Bloodhound Examples

33These examples can be built via `stack build`.

4−To run them start an ElasticSearch 5.x server at `localhost:9200`

4+To run them start an Elasticsearch 5.x server at `localhost:9200`

66Run with `stack exec tweet-example`

src/Database/V1/Bloodhound/Client.hs+3−3

@@ -281,7 +281,7 @@ updateSnapshotRepo SnapshotRepoUpdateSettings {..} repo =

281281

282282

283283-- | Verify if a snapshot repo is working. __NOTE:__ this API did not

284−-- make it into ElasticSearch until 1.4. If you use an older version,

284+-- make it into Elasticsearch until 1.4. If you use an older version,

285285-- you will get an error here.

286286verifySnapshotRepo

287287 :: ( MonadBH m

@@ -479,7 +479,7 @@ getIndexSettings (IndexName indexName) = do

479479-- to True is the main way to release disk space back to the OS being

480480-- held by deleted documents.

481481--

482−-- Note that this API was deprecated in ElasticSearch 2.1 for the

482+-- Note that this API was deprecated in Elasticsearch 2.1 for the

483483-- almost completely identical forcemerge API. Adding support to that

484484-- API would be trivial but due to the significant breaking changes,

485485-- this library cannot currently be used with >= 2.0, so that feature was omitted.

@@ -520,7 +520,7 @@ existentialQuery url = do

520520-- responses from elasticsearch should fall into these two

521521-- categories. If they don't, a 'EsProtocolException' will be

522522-- thrown. If you encounter this, please report the full body it

523−-- reports along with your ElasticSearch verison.

523+-- reports along with your Elasticsearch verison.

524524parseEsResponse :: (MonadThrow m, FromJSON a) => Reply

525525 -> m (Either EsError a)

526526parseEsResponse reply

src/Database/V1/Bloodhound/Types.hs+7−7

@@ -525,7 +525,7 @@ data IndexOptimizationSettings =

525525

526526

527527{-| 'defaultIndexOptimizationSettings' implements the default settings that

528− ElasticSearch uses for index optimization. 'maxNumSegments' is Nothing,

528+ Elasticsearch uses for index optimization. 'maxNumSegments' is Nothing,

529529 'onlyExpungeDeletes' is False, and flushAfterOptimize is True.

530530-}

531531defaultIndexOptimizationSettings :: IndexOptimizationSettings

@@ -736,11 +736,11 @@ data EsError = EsError { errorStatus :: Int

736736 , errorMessage :: Text } deriving (Eq, Read, Show, Generic, Typeable)

737737

738738{-| 'EsProtocolException' will be thrown if Bloodhound cannot parse a response

739−returned by the ElasticSearch server. If you encounter this error, please

739+returned by the Elasticsearch server. If you encounter this error, please

740740verify that your domain data types and FromJSON instances are working properly

741741(for example, the 'a' of '[Hit a]' in 'SearchResult.searchHits.hits'). If you're

742742sure that your mappings are correct, then this error may be an indication of an

743−incompatibility between Bloodhound and ElasticSearch. Please open a bug report

743+incompatibility between Bloodhound and Elasticsearch. Please open a bug report

744744and be sure to include the exception body.

745745-}

746746data EsProtocolException = EsProtocolException { esProtoExBody :: L.ByteString }

@@ -3980,7 +3980,7 @@ newtype FullNodeId = FullNodeId { fullNodeId :: Text }

39803980

39813981

39823982-- | A human-readable node name that is supplied by the user in the

3983−-- node config or automatically generated by ElasticSearch.

3983+-- node config or automatically generated by Elasticsearch.

39843984newtype NodeName = NodeName { nodeName :: Text }

39853985 deriving (Eq, Ord, Generic, Show, Typeable, FromJSON)

39863986

@@ -4266,7 +4266,7 @@ data NodeIndicesStats = NodeIndicesStats {

42664266 , nodeIndicesStatsDocsCount :: Int

42674267 } deriving (Eq, Show, Generic, Typeable)

42684268

4269−-- | A quirky address format used throughout ElasticSearch. An example

4269+-- | A quirky address format used throughout Elasticsearch. An example

42704270-- would be inet[/1.1.1.1:9200]. inet may be a placeholder for a

42714271-- <https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN>.

42724272newtype EsAddress = EsAddress { esAddress :: Text }

@@ -4459,7 +4459,7 @@ defaultSnapshotRepoUpdateSettings = SnapshotRepoUpdateSettings True

44594459

44604460

44614461-- | A filesystem-based snapshot repo that ships with

4462−-- ElasticSearch. This is an instance of 'SnapshotRepo' so it can be

4462+-- Elasticsearch. This is an instance of 'SnapshotRepo' so it can be

44634463-- used with 'updateSnapshotRepo'

44644464data FsSnapshotRepo = FsSnapshotRepo {

44654465 fsrName :: SnapshotRepoName

@@ -4704,7 +4704,7 @@ newtype RestoreRenamePattern = RestoreRenamePattern { rrPattern :: Text }

47044704

47054705-- | A single token in a index renaming scheme for a restore. These

47064706-- are concatenated into a string before being sent to

4707−-- ElasticSearch. Check out these Java

4707+-- Elasticsearch. Check out these Java

47084708-- <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.

47094709data RestoreRenameToken = RRTLit Text

47104710 -- ^ Just a literal string of characters

src/Database/V5/Bloodhound/Client.hs+3−3

@@ -345,7 +345,7 @@ updateSnapshotRepo SnapshotRepoUpdateSettings {..} repo =

345345

346346

347347-- | Verify if a snapshot repo is working. __NOTE:__ this API did not

348−-- make it into ElasticSearch until 1.4. If you use an older version,

348+-- make it into Elasticsearch until 1.4. If you use an older version,

349349-- you will get an error here.

350350verifySnapshotRepo

351351 :: ( MonadBH m

@@ -628,7 +628,7 @@ existentialQuery url = do

628628-- responses from elasticsearch should fall into these two

629629-- categories. If they don't, a 'EsProtocolException' will be

630630-- thrown. If you encounter this, please report the full body it

631−-- reports along with your ElasticSearch verison.

631+-- reports along with your Elasticsearch verison.

632632parseEsResponse :: (MonadThrow m, FromJSON a) => Reply

633633 -> m (Either EsError a)

634634parseEsResponse reply

@@ -810,7 +810,7 @@ versionCtlParams cfg =

810810-- Elasticsearch. The document itself is simply something we can

811811-- convert into a JSON 'Value'. The 'DocId' will function as the

812812-- primary key for the document. You are encouraged to generate

813−-- your own id's and not rely on ElasticSearch's automatic id

813+-- your own id's and not rely on Elasticsearch's automatic id

814814-- generation. Read more about it here:

815815-- https://github.com/bitemyapp/bloodhound/issues/107

816816--

src/Database/V5/Bloodhound/Types.hs+10−10

@@ -539,7 +539,7 @@ data ForceMergeIndexSettings =

539539

540540

541541{-| 'defaultForceMergeIndexSettings' implements the default settings that

542− ElasticSearch uses for index optimization. 'maxNumSegments' is Nothing,

542+ Elasticsearch uses for index optimization. 'maxNumSegments' is Nothing,

543543 'onlyExpungeDeletes' is False, and flushAfterOptimize is True.

544544-}

545545defaultForceMergeIndexSettings :: ForceMergeIndexSettings

@@ -700,10 +700,10 @@ instance FromJSON TokenFilterDefinition where

700700 _ -> fail ("unrecognized token filter type: " ++ T.unpack t)

701701

702702-- | The set of languages that can be passed to various analyzers,

703−-- filters, etc. in ElasticSearch. Most data types in this module

703+-- filters, etc. in Elasticsearch. Most data types in this module

704704-- that have a 'Language' field are actually only actually to

705705-- handle a subset of these languages. Consult the official

706−-- ElasticSearch documentation to see what is actually supported.

706+-- Elasticsearch documentation to see what is actually supported.

707707data Language

708708 = Arabic

709709 | Armenian

@@ -750,7 +750,7 @@ instance ToJSON Language where

750750

751751instance FromJSON Language where

752752 parseJSON = withText "Language" $ \t -> case languageFromText t of

753− Nothing -> fail "not a supported ElasticSearch language"

753+ Nothing -> fail "not a supported Elasticsearch language"

754754 Just lang -> return lang

755755

756756languageToText :: Language -> Text

@@ -1066,11 +1066,11 @@ data EsError = EsError { errorStatus :: Int

10661066 , errorMessage :: Text } deriving (Eq, Read, Show, Generic, Typeable)

10671067

10681068{-| 'EsProtocolException' will be thrown if Bloodhound cannot parse a response

1069−returned by the ElasticSearch server. If you encounter this error, please

1069+returned by the Elasticsearch server. If you encounter this error, please

10701070verify that your domain data types and FromJSON instances are working properly

10711071(for example, the 'a' of '[Hit a]' in 'SearchResult.searchHits.hits'). If you're

10721072sure that your mappings are correct, then this error may be an indication of an

1073−incompatibility between Bloodhound and ElasticSearch. Please open a bug report

1073+incompatibility between Bloodhound and Elasticsearch. Please open a bug report

10741074and be sure to include the exception body.

10751075-}

10761076data EsProtocolException = EsProtocolException { esProtoExBody :: L.ByteString }

@@ -4131,7 +4131,7 @@ newtype FullNodeId = FullNodeId { fullNodeId :: Text }

41314131

41324132

41334133-- | A human-readable node name that is supplied by the user in the

4134−-- node config or automatically generated by ElasticSearch.

4134+-- node config or automatically generated by Elasticsearch.

41354135newtype NodeName = NodeName { nodeName :: Text }

41364136 deriving (Eq, Ord, Generic, Show, Typeable, FromJSON)

41374137

@@ -4406,7 +4406,7 @@ data NodeIndicesStats = NodeIndicesStats {

44064406 , nodeIndicesStatsDocsCount :: Int

44074407 } deriving (Eq, Show, Generic, Typeable)

44084408

4409−-- | A quirky address format used throughout ElasticSearch. An example

4409+-- | A quirky address format used throughout Elasticsearch. An example

44104410-- would be inet[/1.1.1.1:9200]. inet may be a placeholder for a

44114411-- <https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN>.

44124412newtype EsAddress = EsAddress { esAddress :: Text }

@@ -4600,7 +4600,7 @@ defaultSnapshotRepoUpdateSettings = SnapshotRepoUpdateSettings True

46004600

46014601

46024602-- | A filesystem-based snapshot repo that ships with

4603−-- ElasticSearch. This is an instance of 'SnapshotRepo' so it can be

4603+-- Elasticsearch. This is an instance of 'SnapshotRepo' so it can be

46044604-- used with 'updateSnapshotRepo'

46054605data FsSnapshotRepo = FsSnapshotRepo {

46064606 fsrName :: SnapshotRepoName

@@ -4845,7 +4845,7 @@ newtype RestoreRenamePattern = RestoreRenamePattern { rrPattern :: Text }

48454845

48464846-- | A single token in a index renaming scheme for a restore. These

48474847-- are concatenated into a string before being sent to

4848−-- ElasticSearch. Check out these Java

4848+-- Elasticsearch. Check out these Java

48494849-- <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.

48504850data RestoreRenameToken = RRTLit Text

48514851 -- ^ Just a literal string of characters