diff --git a/DSL.org b/DSL.org index 427b172..2e2cb1b 100644 --- a/DSL.org +++ b/DSL.org @@ -1,4 +1,4 @@ -* ElasticSearch DSL +* Elasticsearch DSL ** Grouping diff --git a/README.md b/README.md index 9fc01db..b9099b8 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,17 @@ Version compatibility --------------------- As of version 0.13.0.0, Bloodhound has 2 separate module trees for -ElasticSearch versions 1 and 5. Import the module that is appropriate +Elasticsearch versions 1 and 5. Import the module that is appropriate for your use case. If you would like to add support for another major version, open a ticket expressing your intend and follow the pattern used for other versions. We weighed the idea of sharing code between versions but it just got too messy, especially considering the -instability of the ElasticSearch API. We switched to a model which +instability of the Elasticsearch API. We switched to a model which would allow the persons responsible for a particular protocol version to maintain that version while avoiding conflict with other versions. See our [TravisCI](https://travis-ci.org/bitemyapp/bloodhound) for a -listing of ElasticSearch version we test against. +listing of Elasticsearch version we test against. Stability @@ -43,15 +43,15 @@ Bloodhound is stable for production use. I will strive to avoid breaking API com Testing --------- -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. +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. Steps to run the tests locally: - 1. Dig through the [past releases] (https://www.elastic.co/downloads/past-releases) section of the ElasticSearch download page and install the desired ElasticSearch versions. + 1. Dig through the [past releases] (https://www.elastic.co/downloads/past-releases) section of the Elasticsearch download page and install the desired Elasticsearch versions. 2. Install [Stack] (http://docs.haskellstack.org/en/stable/README.html#how-to-install) 3. In your local Bloodhound directory, run `stack setup && stack build` - 4. Start the desired version of ElasticSearch at `localhost:9200`, which should be the default. + 4. Start the desired version of Elasticsearch at `localhost:9200`, which should be the default. 5. Run `stack test` in your local Bloodhound directory. - 6. The unit tests will pass if you re-execute `stack test`. If you want to start with a clean slate, stop your ElasticSearch instance, delete the `data/` folder in the ElasticSearch installation, restart ElasticSearch, and re-run `stack test`. + 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`. Hackage page and Haddock documentation diff --git a/bloodhound.cabal b/bloodhound.cabal index 9919a34..803bf44 100644 --- a/bloodhound.cabal +++ b/bloodhound.cabal @@ -1,7 +1,7 @@ name: bloodhound version: 0.16.0.0 -synopsis: ElasticSearch client library for Haskell -description: ElasticSearch made awesome for Haskell hackers +synopsis: Elasticsearch client library for Haskell +description: Elasticsearch made awesome for Haskell hackers homepage: https://github.com/bitemyapp/bloodhound license: BSD3 license-file: LICENSE diff --git a/examples/README.md b/examples/README.md index df2edd2..f8e6eee 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,6 @@ # Bloodhound Examples These examples can be built via `stack build`. -To run them start an ElasticSearch 5.x server at `localhost:9200` +To run them start an Elasticsearch 5.x server at `localhost:9200` Run with `stack exec tweet-example` diff --git a/src/Database/V1/Bloodhound/Client.hs b/src/Database/V1/Bloodhound/Client.hs index 0059026..56e05af 100644 --- a/src/Database/V1/Bloodhound/Client.hs +++ b/src/Database/V1/Bloodhound/Client.hs @@ -281,7 +281,7 @@ updateSnapshotRepo SnapshotRepoUpdateSettings {..} repo = -- | Verify if a snapshot repo is working. __NOTE:__ this API did not --- make it into ElasticSearch until 1.4. If you use an older version, +-- make it into Elasticsearch until 1.4. If you use an older version, -- you will get an error here. verifySnapshotRepo :: ( MonadBH m @@ -479,7 +479,7 @@ getIndexSettings (IndexName indexName) = do -- to True is the main way to release disk space back to the OS being -- held by deleted documents. -- --- Note that this API was deprecated in ElasticSearch 2.1 for the +-- Note that this API was deprecated in Elasticsearch 2.1 for the -- almost completely identical forcemerge API. Adding support to that -- API would be trivial but due to the significant breaking changes, -- this library cannot currently be used with >= 2.0, so that feature was omitted. @@ -520,7 +520,7 @@ existentialQuery url = do -- responses from elasticsearch should fall into these two -- categories. If they don't, a 'EsProtocolException' will be -- thrown. If you encounter this, please report the full body it --- reports along with your ElasticSearch verison. +-- reports along with your Elasticsearch verison. parseEsResponse :: (MonadThrow m, FromJSON a) => Reply -> m (Either EsError a) parseEsResponse reply diff --git a/src/Database/V1/Bloodhound/Types.hs b/src/Database/V1/Bloodhound/Types.hs index 10f19e5..81583aa 100644 --- a/src/Database/V1/Bloodhound/Types.hs +++ b/src/Database/V1/Bloodhound/Types.hs @@ -525,7 +525,7 @@ data IndexOptimizationSettings = {-| 'defaultIndexOptimizationSettings' implements the default settings that - ElasticSearch uses for index optimization. 'maxNumSegments' is Nothing, + Elasticsearch uses for index optimization. 'maxNumSegments' is Nothing, 'onlyExpungeDeletes' is False, and flushAfterOptimize is True. -} defaultIndexOptimizationSettings :: IndexOptimizationSettings @@ -736,11 +736,11 @@ data EsError = EsError { errorStatus :: Int , errorMessage :: Text } deriving (Eq, Read, Show, Generic, Typeable) {-| 'EsProtocolException' will be thrown if Bloodhound cannot parse a response -returned by the ElasticSearch server. If you encounter this error, please +returned by the Elasticsearch server. If you encounter this error, please verify that your domain data types and FromJSON instances are working properly (for example, the 'a' of '[Hit a]' in 'SearchResult.searchHits.hits'). If you're sure that your mappings are correct, then this error may be an indication of an -incompatibility between Bloodhound and ElasticSearch. Please open a bug report +incompatibility between Bloodhound and Elasticsearch. Please open a bug report and be sure to include the exception body. -} data EsProtocolException = EsProtocolException { esProtoExBody :: L.ByteString } @@ -3980,7 +3980,7 @@ newtype FullNodeId = FullNodeId { fullNodeId :: Text } -- | A human-readable node name that is supplied by the user in the --- node config or automatically generated by ElasticSearch. +-- node config or automatically generated by Elasticsearch. newtype NodeName = NodeName { nodeName :: Text } deriving (Eq, Ord, Generic, Show, Typeable, FromJSON) @@ -4266,7 +4266,7 @@ data NodeIndicesStats = NodeIndicesStats { , nodeIndicesStatsDocsCount :: Int } deriving (Eq, Show, Generic, Typeable) --- | A quirky address format used throughout ElasticSearch. An example +-- | A quirky address format used throughout Elasticsearch. An example -- would be inet[/1.1.1.1:9200]. inet may be a placeholder for a -- . newtype EsAddress = EsAddress { esAddress :: Text } @@ -4459,7 +4459,7 @@ defaultSnapshotRepoUpdateSettings = SnapshotRepoUpdateSettings True -- | A filesystem-based snapshot repo that ships with --- ElasticSearch. This is an instance of 'SnapshotRepo' so it can be +-- Elasticsearch. This is an instance of 'SnapshotRepo' so it can be -- used with 'updateSnapshotRepo' data FsSnapshotRepo = FsSnapshotRepo { fsrName :: SnapshotRepoName @@ -4704,7 +4704,7 @@ newtype RestoreRenamePattern = RestoreRenamePattern { rrPattern :: Text } -- | A single token in a index renaming scheme for a restore. These -- are concatenated into a string before being sent to --- ElasticSearch. Check out these Java +-- Elasticsearch. Check out these Java -- to find out more if you're into that sort of thing. data RestoreRenameToken = RRTLit Text -- ^ Just a literal string of characters diff --git a/src/Database/V5/Bloodhound/Client.hs b/src/Database/V5/Bloodhound/Client.hs index 1c9ebfb..6b2bd0e 100644 --- a/src/Database/V5/Bloodhound/Client.hs +++ b/src/Database/V5/Bloodhound/Client.hs @@ -345,7 +345,7 @@ updateSnapshotRepo SnapshotRepoUpdateSettings {..} repo = -- | Verify if a snapshot repo is working. __NOTE:__ this API did not --- make it into ElasticSearch until 1.4. If you use an older version, +-- make it into Elasticsearch until 1.4. If you use an older version, -- you will get an error here. verifySnapshotRepo :: ( MonadBH m @@ -628,7 +628,7 @@ existentialQuery url = do -- responses from elasticsearch should fall into these two -- categories. If they don't, a 'EsProtocolException' will be -- thrown. If you encounter this, please report the full body it --- reports along with your ElasticSearch verison. +-- reports along with your Elasticsearch verison. parseEsResponse :: (MonadThrow m, FromJSON a) => Reply -> m (Either EsError a) parseEsResponse reply @@ -810,7 +810,7 @@ versionCtlParams cfg = -- Elasticsearch. The document itself is simply something we can -- convert into a JSON 'Value'. The 'DocId' will function as the -- primary key for the document. You are encouraged to generate --- your own id's and not rely on ElasticSearch's automatic id +-- your own id's and not rely on Elasticsearch's automatic id -- generation. Read more about it here: -- https://github.com/bitemyapp/bloodhound/issues/107 -- diff --git a/src/Database/V5/Bloodhound/Types.hs b/src/Database/V5/Bloodhound/Types.hs index cf36892..e91ac7d 100644 --- a/src/Database/V5/Bloodhound/Types.hs +++ b/src/Database/V5/Bloodhound/Types.hs @@ -539,7 +539,7 @@ data ForceMergeIndexSettings = {-| 'defaultForceMergeIndexSettings' implements the default settings that - ElasticSearch uses for index optimization. 'maxNumSegments' is Nothing, + Elasticsearch uses for index optimization. 'maxNumSegments' is Nothing, 'onlyExpungeDeletes' is False, and flushAfterOptimize is True. -} defaultForceMergeIndexSettings :: ForceMergeIndexSettings @@ -700,10 +700,10 @@ instance FromJSON TokenFilterDefinition where _ -> fail ("unrecognized token filter type: " ++ T.unpack t) -- | The set of languages that can be passed to various analyzers, --- filters, etc. in ElasticSearch. Most data types in this module +-- filters, etc. in Elasticsearch. Most data types in this module -- that have a 'Language' field are actually only actually to -- handle a subset of these languages. Consult the official --- ElasticSearch documentation to see what is actually supported. +-- Elasticsearch documentation to see what is actually supported. data Language = Arabic | Armenian @@ -750,7 +750,7 @@ instance ToJSON Language where instance FromJSON Language where parseJSON = withText "Language" $ \t -> case languageFromText t of - Nothing -> fail "not a supported ElasticSearch language" + Nothing -> fail "not a supported Elasticsearch language" Just lang -> return lang languageToText :: Language -> Text @@ -1066,11 +1066,11 @@ data EsError = EsError { errorStatus :: Int , errorMessage :: Text } deriving (Eq, Read, Show, Generic, Typeable) {-| 'EsProtocolException' will be thrown if Bloodhound cannot parse a response -returned by the ElasticSearch server. If you encounter this error, please +returned by the Elasticsearch server. If you encounter this error, please verify that your domain data types and FromJSON instances are working properly (for example, the 'a' of '[Hit a]' in 'SearchResult.searchHits.hits'). If you're sure that your mappings are correct, then this error may be an indication of an -incompatibility between Bloodhound and ElasticSearch. Please open a bug report +incompatibility between Bloodhound and Elasticsearch. Please open a bug report and be sure to include the exception body. -} data EsProtocolException = EsProtocolException { esProtoExBody :: L.ByteString } @@ -4131,7 +4131,7 @@ newtype FullNodeId = FullNodeId { fullNodeId :: Text } -- | A human-readable node name that is supplied by the user in the --- node config or automatically generated by ElasticSearch. +-- node config or automatically generated by Elasticsearch. newtype NodeName = NodeName { nodeName :: Text } deriving (Eq, Ord, Generic, Show, Typeable, FromJSON) @@ -4406,7 +4406,7 @@ data NodeIndicesStats = NodeIndicesStats { , nodeIndicesStatsDocsCount :: Int } deriving (Eq, Show, Generic, Typeable) --- | A quirky address format used throughout ElasticSearch. An example +-- | A quirky address format used throughout Elasticsearch. An example -- would be inet[/1.1.1.1:9200]. inet may be a placeholder for a -- . newtype EsAddress = EsAddress { esAddress :: Text } @@ -4600,7 +4600,7 @@ defaultSnapshotRepoUpdateSettings = SnapshotRepoUpdateSettings True -- | A filesystem-based snapshot repo that ships with --- ElasticSearch. This is an instance of 'SnapshotRepo' so it can be +-- Elasticsearch. This is an instance of 'SnapshotRepo' so it can be -- used with 'updateSnapshotRepo' data FsSnapshotRepo = FsSnapshotRepo { fsrName :: SnapshotRepoName @@ -4845,7 +4845,7 @@ newtype RestoreRenamePattern = RestoreRenamePattern { rrPattern :: Text } -- | A single token in a index renaming scheme for a restore. These -- are concatenated into a string before being sent to --- ElasticSearch. Check out these Java +-- Elasticsearch. Check out these Java -- to find out more if you're into that sort of thing. data RestoreRenameToken = RRTLit Text -- ^ Just a literal string of characters