Skip to content

Commit 287d297

Browse files
committed
Docs tweak: stop camelcasing “Elasticsearch”.
This change aligns the Elastisch codebase with the official material of Elasticsearch. (For example, see [the official Elasticsearch product page](https://www.elastic.co/products/elasticsearch).)
1 parent c985dff commit 287d297

11 files changed

+82
-82
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Pre-requisites
22

3-
The project uses [Leiningen 2](https://leiningen.org) and requires ElasticSearch `1.4.x` or more recent to be running
3+
The project uses [Leiningen 2](https://leiningen.org) and requires Elasticsearch `1.4.x` or more recent to be running
44
locally.
55

66
`script.disable_dynamic` must be `false` for scripting tests to pass. To set this, add the following to your `elasticsearch.yml` file:

ChangeLog.md

+52-52
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### ElasticSeach 2.3.x Compatibility
44

5-
This involves removing some features as [ElasticSearch 2.0 has breaking public API changes](https://www.elastic.co/guide/en/elasticsearch/reference/current/breaking-changes-2.0.html).
5+
This involves removing some features as [Elasticsearch 2.0 has breaking public API changes](https://www.elastic.co/guide/en/elasticsearch/reference/current/breaking-changes-2.0.html).
66

77
Contributed by Timo Sulg and Josh Tilles.
88

@@ -87,7 +87,7 @@ Contributed by Michael Nussbaum.
8787

8888
### Index Stats Update
8989

90-
`clojurewerkz.elastisch.rest.index/stats` has been updated for ElasticSearch `1.3.x`
90+
`clojurewerkz.elastisch.rest.index/stats` has been updated for Elasticsearch `1.3.x`
9191
and later versions.
9292

9393
Contributed by Roman Pearah.
@@ -144,9 +144,9 @@ special-case first request.
144144

145145
Contributed by @loganmhb
146146

147-
### ElasticSearch Java Client Upgrade
147+
### Elasticsearch Java Client Upgrade
148148

149-
Elastisch now depends on ElasticSearch Java client version `1.7.x`.
149+
Elastisch now depends on Elasticsearch Java client version `1.7.x`.
150150

151151
### clj-http Update
152152

@@ -207,9 +207,9 @@ Native client now supports nesting in the following aggregations
207207

208208
Contributed by Mitchel Kuijpers (Avisi).
209209

210-
### ElasticSearch Java Client Upgrade
210+
### Elasticsearch Java Client Upgrade
211211

212-
Elastisch now depends on ElasticSearch Java client version `1.4.x`.
212+
Elastisch now depends on Elasticsearch Java client version `1.4.x`.
213213

214214
### clj-http Update
215215

@@ -308,7 +308,7 @@ Contributed by Michael Nussbaum (Braintree).
308308

309309
### New Line in Multi-Search REST API
310310

311-
ElasticSearch Multi Search REST API endpoint is sensitive to the trailing new line.
311+
Elasticsearch Multi Search REST API endpoint is sensitive to the trailing new line.
312312
When it is missing, the response contains one result too few.
313313

314314
Elastisch now makes sure to append a new line to Multi Search request
@@ -327,9 +327,9 @@ Contributed by Nikita Burtsev.
327327

328328
## Changes between Elastisch 2.1.0-beta4 and 2.1.0-beta5
329329

330-
### ElasticSearch Native Client Upgrade
330+
### Elasticsearch Native Client Upgrade
331331

332-
Elastisch now depends on ElasticSearch native client version `1.3.x`.
332+
Elastisch now depends on Elasticsearch native client version `1.3.x`.
333333

334334
### Single-Bucket Aggregation Fix in the Native Client
335335

@@ -346,7 +346,7 @@ Native client now has support for [aggregations](http://www.elasticsearch.org/gu
346346

347347
The API is [the same as in the REST client](http://clojureelasticsearch.info/articles/aggregation.html).
348348

349-
Note that ElasticSearch 1.2 has 26 aggregations. Currently only the most commonly
349+
Note that Elasticsearch 1.2 has 26 aggregations. Currently only the most commonly
350350
used ones are supported but support for more types will be added eventually.
351351
The supported types are:
352352

@@ -492,13 +492,13 @@ Contributed by Sandeep Jagtap.
492492

493493
## Changes between Elastisch 2.0.0-rc1 and 2.0.0
494494

495-
### ElasticSearch Client Update
495+
### Elasticsearch Client Update
496496

497-
ElasticSearch client has been upgraded to `1.2.x`.
497+
Elasticsearch client has been upgraded to `1.2.x`.
498498

499499
### Snapshotting Support in Native Client
500500

501-
Native client now supports snapshotting (updated for ElasticSearch 1.2)
501+
Native client now supports snapshotting (updated for Elasticsearch 1.2)
502502
with the same Clojure API as the REST client (all the usual API conventions
503503
apply).
504504

@@ -572,9 +572,9 @@ were adapted for recent ES releases.
572572

573573
Contributed by Oliver McCormack (The Climate Corporation).
574574

575-
### ElasticSearch Client Update
575+
### Elasticsearch Client Update
576576

577-
ElasticSearch client has been upgraded to `1.1.1`.
577+
Elasticsearch client has been upgraded to `1.1.1`.
578578

579579

580580
## Changes between Elastisch 2.0.0-beta3 and 2.0.0-beta4
@@ -615,9 +615,9 @@ REST API client now supports percolation of existing documents:
615615

616616
## Changes between Elastisch 2.0.0-beta2 and 2.0.0-beta3
617617

618-
### ElasticSearch Client Update
618+
### Elasticsearch Client Update
619619

620-
ElasticSearch client has been upgraded to `1.1.0`.
620+
Elasticsearch client has been upgraded to `1.1.0`.
621621

622622
### Clojure 1.6
623623

@@ -643,7 +643,7 @@ Contributed by Halit Olali.
643643
### (Improved) Aggregation Support
644644

645645
Elastisch 2.0 features multiple convenience functions for working with
646-
[ElasticSearch aggregations](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations.html).
646+
[Elasticsearch aggregations](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations.html).
647647

648648
`clojurewerkz.elastisch.aggregation` is a new namespace that contains
649649
helper functions that produce various types of aggregations. Just like
@@ -677,17 +677,17 @@ Aggregations support is primarily focused on REST client at the moment.
677677

678678
## Changes between Elastisch 1.4.0 and 2.0.0-beta1
679679

680-
### ElasticSearch 1.0 Compatibility
680+
### Elasticsearch 1.0 Compatibility
681681

682-
Main goal of Elastisch 2.0 is ElasticSearch 2.0 compatibility. This includes minor
683-
API changes (in line with [ElasticSearch 1.0 API and terminology changes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/breaking-changes.html))
682+
Main goal of Elastisch 2.0 is Elasticsearch 2.0 compatibility. This includes minor
683+
API changes (in line with [Elasticsearch 1.0 API and terminology changes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/breaking-changes.html))
684684
and moderate internal modifications.
685685

686686

687687
### Support for cluster nodes stats and info REST APIs
688688

689689
`clojureworkz.elastisch.rest.admin/nodes-info` and `clojureworkz.elastisch.rest.admin/nodes-stats`
690-
are new administrative functions that provide access to ElasticSearch
690+
are new administrative functions that provide access to Elasticsearch
691691
[cluster stats and node info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html).
692692

693693
Examples:
@@ -704,7 +704,7 @@ Examples:
704704
(admin/nodes-info :nodes ["node1" "node2"] ["indices" "os" "plugins"])
705705
```
706706

707-
See [ElasticSearch nodes stats
707+
See [Elasticsearch nodes stats
708708
documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html),
709709
[nodes info
710710
page](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html),
@@ -727,7 +727,7 @@ Examples:
727727
(admin/cluster-state :filter_nodes true)
728728
```
729729

730-
See [ElasticSearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-state.html) for more info.
730+
See [Elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-state.html) for more info.
731731

732732
Contributed by Joachim De Beule.
733733

@@ -747,7 +747,7 @@ Example:
747747
(admin/cluster-health :index "index1" :pretty true :level "indices")
748748
```
749749

750-
See [ElasticSearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-health.html) for more info.
750+
See [Elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-health.html) for more info.
751751

752752
Contributed by Joachim De Beule.
753753

@@ -756,7 +756,7 @@ Contributed by Joachim De Beule.
756756

757757
Added `(doc/analyze text & {:as params})`
758758

759-
See [ElasticSearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html) for more info.
759+
See [Elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html) for more info.
760760

761761
Examples:
762762

@@ -784,9 +784,9 @@ By default `clojurewerkz.elastisch.escape/escape-query-string-characters` is use
784784
Contributed by Ben Reinhart (Groupon).
785785

786786

787-
### ElasticSearch Native Client Upgrade
787+
### Elasticsearch Native Client Upgrade
788788

789-
Elastisch now depends on ElasticSearch native client version `1.0.1`.
789+
Elastisch now depends on Elasticsearch native client version `1.0.1`.
790790

791791

792792
### clj-http Update
@@ -806,18 +806,18 @@ Contributed by Richie Vos (Groupon).
806806

807807
GH issues: #56.
808808

809-
### ElasticSearch Exceptions
809+
### Elasticsearch Exceptions
810810

811-
Elastisch now uses ElasticSearch exceptions instead of generic ones in the native
811+
Elastisch now uses Elasticsearch exceptions instead of generic ones in the native
812812
client.
813813

814814
Contributed by Richie Vos (Groupon).
815815

816816
GH issues: #54, #57.
817817

818-
### ElasticSearch Native Client Upgrade
818+
### Elasticsearch Native Client Upgrade
819819

820-
Elastisch now depends on ElasticSearch native client version `0.90.8`.
820+
Elastisch now depends on Elasticsearch native client version `0.90.8`.
821821

822822
### `clojurewerkz.elastisch.native.document/update-with-script` Fix
823823

@@ -843,9 +843,9 @@ Contributed by Mark Wong-VanHaren.
843843

844844
## Changes between Elastisch 1.3.0-rc1 and 1.3.0-rc2
845845

846-
### ElasticSearch Native Client Upgrade
846+
### Elasticsearch Native Client Upgrade
847847

848-
Elastisch now depends on ElasticSearch native client version `0.90.7`.
848+
Elastisch now depends on Elasticsearch native client version `0.90.7`.
849849

850850

851851
## Changes between Elastisch 1.3.0-beta5 and 1.3.0-rc1
@@ -919,12 +919,12 @@ Contributed by Jim Dunn.
919919

920920
Native client now returns the same value in `:fields` and `:_fields`
921921
keys in search hits. This makes it both backwards compatible with
922-
earlier versions and the format ElasticSearch HTTP API uses.
922+
earlier versions and the format Elasticsearch HTTP API uses.
923923

924924

925-
### ElasticSearch Native Client Upgrade
925+
### Elasticsearch Native Client Upgrade
926926

927-
Elastisch now depends on ElasticSearch native client version `0.90.5`.
927+
Elastisch now depends on Elasticsearch native client version `0.90.5`.
928928

929929

930930

@@ -956,9 +956,9 @@ Elastisch now requires Clojure 1.4.
956956

957957
## Changes between Elastisch 1.2.0-beta3 and 1.2.0
958958

959-
### ElasticSearch Native Client Upgrade
959+
### Elasticsearch Native Client Upgrade
960960

961-
Elastisch now depends on ElasticSearch native client version `0.90.3`.
961+
Elastisch now depends on Elasticsearch native client version `0.90.3`.
962962

963963

964964
### Empty Bulk Operations are Ignored
@@ -971,9 +971,9 @@ Contributed by Baptiste Fontaine.
971971

972972
## Changes between Elastisch 1.2.0-beta2 and 1.2.0-beta3
973973

974-
### ElasticSearch Native Client Upgrade
974+
### Elasticsearch Native Client Upgrade
975975

976-
Elastisch now depends on ElasticSearch native client version `0.90.2`.
976+
Elastisch now depends on Elasticsearch native client version `0.90.2`.
977977

978978
### Support for :ignore_indices in REST API client
979979

@@ -1002,9 +1002,9 @@ the `:fields` option are now correctly converted to Clojure maps.
10021002

10031003
Contributed by Soren Macbeth.
10041004

1005-
### ElasticSearch Native Client Upgrade
1005+
### Elasticsearch Native Client Upgrade
10061006

1007-
Elastisch now depends on ElasticSearch native client version `0.90.1`.
1007+
Elastisch now depends on Elasticsearch native client version `0.90.1`.
10081008

10091009

10101010
## Changes between Elastisch 1.1.0 and 1.2.0-beta1
@@ -1050,7 +1050,7 @@ client counterpart that takes the same arguments.
10501050
### Native Client Performance Improvements
10511051

10521052
Native client is now over 50% faster on most commonly used operations
1053-
thanks to much lower conversion overhead from ElasticSearch native client
1053+
thanks to much lower conversion overhead from Elasticsearch native client
10541054
data structures to Clojure maps.
10551055

10561056
Contributed by Jon Pither.
@@ -1060,8 +1060,8 @@ Contributed by Jon Pither.
10601060

10611061
### Native Client
10621062

1063-
Elastisch `1.1.0` includes a major new feature: native ElasticSearch client.
1064-
The client uses ElasticSearch's Java API, and can be used with
1063+
Elastisch `1.1.0` includes a major new feature: native Elasticsearch client.
1064+
The client uses Elasticsearch's Java API, and can be used with
10651065
both transport and node clients.
10661066

10671067
#### Rationale
@@ -1150,7 +1150,7 @@ important for them.
11501150

11511151
GH issues: #17, #18, #20.
11521152

1153-
Note that native ElasticSearch client currently relies on [ElasticSearch 0.90.0.Beta1](http://www.elasticsearch.org/blog/2013/02/26/0.90.0.Beta1-released.html)
1153+
Note that native Elasticsearch client currently relies on [Elasticsearch 0.90.0.Beta1](http://www.elasticsearch.org/blog/2013/02/26/0.90.0.Beta1-released.html)
11541154
client libraries and some operations will only work with that version.
11551155

11561156

@@ -1303,7 +1303,7 @@ Elastisch now uses (and depends on) [Cheshire](https://github.com/dakrone/cheshi
13031303

13041304
`clojurewerkz.elastisch.rest.response/facets-from` is a new convenience function that returns the facets section of a response.
13051305
The exact response format will vary between facet types and queries but it is always returned as an immutable map and has the same
1306-
structure as in the respective ElasticSearch response JSON document.
1306+
structure as in the respective Elasticsearch response JSON document.
13071307

13081308

13091309
### Clojure 1.4 By Default
@@ -1316,8 +1316,8 @@ We encourage all users to upgrade to 1.4, it is a drop-in replacement for the ma
13161316

13171317
### Match Query Support
13181318

1319-
[ElasticSearch 0.19.9](http://www.elasticsearch.org/blog/2012/08/23/0.19.9-released.html) renames Text Query to Match Query. Elastisch adapts by introducing `clojurewerkz.elastisch.query/match` that
1320-
is effectively an alias for `clojurewerkz.elastisch.query/text` (ElasticSearch still supports `:text` in the query DSL for backwards
1319+
[Elasticsearch 0.19.9](http://www.elasticsearch.org/blog/2012/08/23/0.19.9-released.html) renames Text Query to Match Query. Elastisch adapts by introducing `clojurewerkz.elastisch.query/match` that
1320+
is effectively an alias for `clojurewerkz.elastisch.query/text` (Elasticsearch still supports `:text` in the query DSL for backwards
13211321
compatibility).
13221322

13231323

@@ -1407,7 +1407,7 @@ are new functions that implement support for [index aliases](http://www.elastics
14071407
(clojurewerkz.elastisch.rest.index/clear-cache "my-index" :filter true :field_data true)
14081408
```
14091409

1410-
It takes the same options as documented in the [ElasticSearch guide on the Clear Cache Index operation](http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache.html)
1410+
It takes the same options as documented in the [Elasticsearch guide on the Clear Cache Index operation](http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache.html)
14111411

14121412
#### Status
14131413

@@ -1433,7 +1433,7 @@ It takes the same options as documented in the [ElasticSearch guide on the Clear
14331433
(clojurewerkz.elastisch.rest.index/stats "my-index" :docs true :store true :indexing true)
14341434
```
14351435

1436-
It takes the same options as documented in the [ElasticSearch guide on the Stats Index operation](http://www.elasticsearch.org/guide/reference/api/admin-indices-stats.html)
1436+
It takes the same options as documented in the [Elasticsearch guide on the Stats Index operation](http://www.elasticsearch.org/guide/reference/api/admin-indices-stats.html)
14371437

14381438

14391439
### clj-http Update

0 commit comments

Comments
 (0)