Added docs on aliases

Author: sksamuel

README.md

@@ -496,6 +496,11 @@ by combining inserts or using aggressive caching.
 
 For full details see the [docs on bulk operations](docs/bulk.md).
 
+
+
+
+
+
 ## Show Query JSON
 
 It can be useful to see the json output of requests in case you wish to tinker with the request in a REST client or your browser. It can be much easier to tweak a complicated query when you have the instant feedback of the HTTP interface.
@@ -513,6 +518,15 @@ Not all requests have a json body. For example _get-by-id_ is modelled purely by
 
 
 
+
+## Aliases
+
+An [index alias](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html) is a logical name used to reference one or more indices. Most Elasticsearch APIs accept an index alias in place of an index name.
+
+For elastic4s syntax for aliases [click here](docs/alias.md).
+
+
+
 ## Synchronous Operations
 
 All operations are normally asynchronous. Sometimes though you might want to block - for example when doing snapshots or when creating the initial index. You can call `.await` on any operation to block until the result is ready. This is especially useful when testing.
@@ -525,6 +539,9 @@ val resp = client.execute {
 
 
 
+
+
+
 ## Search Iterator
 
 Sometimes you may wish to iterate over all the results in a search, without worrying too much about handling futures, and re-requesting
@@ -549,6 +566,10 @@ batch have been iterated on, the `SearchIterator` will then execute another quer
 So if you are looking for a pure non blocking solution, consider the reactive streams implementation. However, if you just want a
 quick and simple way to iterate over some data without bringing back all the results at once `SearchIterator` is perfect.
 
+
+
+
+
 ## Elastic Reactive Streams
 
 Elastic4s has an implementation of the [reactive streams](http://www.reactive-streams.org) api for both publishing and subscribing that is built

docs/alias.md

@@ -0,0 +1,71 @@
+## Alias
+
+An [index alias](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html) is a logical name used to reference one or more indices. Most Elasticsearch APIs accept an index alias in place of an index name.
+
+### Add and Remove
+
+To add and remove aliases using elastic4s, we create instances of `AliasAction` and pass those to an `AliasRequest` which we can create manually or by the DSL method `aliases`.
+
+For example, to add a single alias to the `beach` index.
+
+```scala
+client.execute {
+  aliases(
+    addAlias("beaches_alias", "beach")
+  )
+}
+```
+
+We can perform multiple alias actions in a single request, including removal.
+
+```scala
+client.execute {
+  aliases(
+    removeAlias("beaches_alias", "beach"),
+    addAlias("mountains_alias", "mountains")
+  )
+}
+```
+
+### Filters
+
+Aliases can also include [filters](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html#filtered).
+
+```scala
+client.execute {
+  aliases(
+    addAlias("metal_beaches", "beaches").filter(prefixQuery("name", "g"))
+  )
+}
+```
+
+### Exists
+
+To check if an alias exists, we can use:
+
+```scala
+client.execute {
+  aliasExists("mountains_alias")
+}
+```
+
+### Get Aliases
+
+We can retrieve aliases for a given index(es), or we can retrieve indexes for a given alias(es), or combinations therefore.
+
+To lookup aliases used by one or more index:
+
+```
+client.execute {
+  getAliases(Seq("mountains", "beaches"), Nil)
+}
+```
+
+And to lookup by alias:
+
+```
+client.execute {
+  getAliases(Nil, Seq("mountains_alias", "metal_beaches"))
+}
+```
+

elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/alias/AliasesApi.scala

@@ -6,19 +6,25 @@ import scala.language.implicitConversions
 
 trait AliasesApi {
 
-  def aliases(first: AliasAction, rest: AliasAction*): IndicesAliasesRequest =
-    aliases(first +: rest)
+  def aliases(first: AliasAction, rest: AliasAction*): IndicesAliasesRequest = aliases(first +: rest)
   def aliases(actions: Iterable[AliasAction]) = IndicesAliasesRequest(actions.toSeq)
 
   def addAlias(alias: String, index: String) = AddAliasActionRequest(alias, index)
+
+  @deprecated("use addAlias(alias, index)", "7.7.0")
   def addAlias(alias: String)                = new AddAliasExpectsOn(alias)
+  @deprecated("use addAlias(alias, index)", "7.7.0")
   class AddAliasExpectsOn(alias: String) {
+    @deprecated("use addAlias(alias, index)", "7.7.0")
     def on(index: String) = AddAliasActionRequest(alias, index)
   }
 
   def removeAlias(alias: String, index: String) = RemoveAliasAction(alias, index)
+  @deprecated("use removeAlias(alias, index)", "7.7.0")
   def removeAlias(alias: String)                = new RemoveAliasExpectsOn(alias)
+  @deprecated("use removeAlias(alias, index)", "7.7.0")
   class RemoveAliasExpectsOn(alias: String) {
+    @deprecated("use removeAlias(alias, index)", "7.7.0")
     def on(index: String) = RemoveAliasAction(alias, index)
   }