Posts Tagged ‘API’
  • ElasticSearch API cheatsheet

    :revdate: 2017-02-19 16:00:00 +0100 :page-liquid: :icons: font :experimental:

    ElasticSearch documentation is exhaustive, but the way it’s structured has some room for improvement. This post is meant as a cheat-sheet entry point into ElasticSearch APIs.

    [options=header,footer] |=== 2.+| Category | Description | Call examples

    .9+|[Document API^] .4+| Single Document API |[Adds a new document^] l| PUT /my_index/my_type/1 { “my_field” : “my_value” }

    POST /my_index/my_type { … }

    PUT /my_index/my_type/1/_create { … }[Gets an existing document^]  
    l GET /my_index/my_type/0[Deletes a document^]  
    l DELETE /my_index/my_type/0

    |[Updates a document^] l| PUT /my_index/my_type/1 { … }

    .5+| Multi-Document API |[Multi-get^] l| GET /_mget { “docs” : [ { “_index” : “my_index”, “_type” : “my_type”, “_id” : “1” } ] }

    GET /my_index/_mget { “docs” : [ { “_type” : “my_type”, “_id” : “1” } ] }

    GET /my_index/my_type/_mget { “docs” : [ { “_id” : “1” } ] }[Performs many index/delete operations in one call^]

    | icon:exclamation-triangle[][Deletes by query^] l| POST /my_index/_delete_by_query { “query”: { “match”: { … } } }

    | icon:exclamation-triangle[][Updates by query^] l| POST /my_index/_update_by_query?conflicts=proceed POST /my_index/_update_by_query?conflicts=proceed { “query”: { “term”: { “my_field”: “my_value” } } }

    POST /my_index1,my_index2/my_type1,my_type2/_update_by_query

    | icon:exclamation-triangle[][Reindexes^] l| POST /_reindex { “source”: { “index”: “old_index” }, “dest”: { “index”: “new_index” } }

    .7+|[Search API^] | URI Search |[Executes a search with query parameters on the URL^] l| GET /my_index/my_type/_search?q=my_field:my_value GET /my_index/my_type/_search { “query” : { “term” : { “my_field” : “my_value” } } }

    Search Shards API[Gets indices/shards of a search would be executed against^]  
    l GET /my_index/_search_shards

    | Count API |[Executes a count query^] l| GET /my_index/my_type/_count?q=my_field:my_value GET /my_index/my_type/_count { “query” : { “term” : { “my_field” : “my_value” } } }

    | Validate API |[Validates a search query^] l| GET /my_index/my_type/_validate?q=my_field:my_value GET /my_index/my_type/_validate { “query” : { “term” : { “my_field” : “my_value” } } }

    | Explain API |[Provides feedback on computation of a search^] l| GET /my_index/my_type/0/_explain { “query” : { “match” : { “message” : “elasticsearch” } } } GET /my_index/my_type/0/_explain?q=message:elasticsearch

    | Profile API | icon:exclamation-triangle[][Provides timing information on individual components during a search^] l| GET /_search { “profile”: true, “query” : { … } }

    | Field Stats API | icon:exclamation-triangle[][Finds statistical properties of fields without executing a search^] l| GET /_field_stats?fields=my_field GET /my_index/_field_stats?fields=my_field GET /my_index1,my_index2/_field_stats?fields=my_field

    .28+|[Indices API^] .7+|[Index management] |[Instantiates a new index^] l| PUT /my_index { “settings” : { … } }

    |[Deletes existing indices^] l| DELETE /my_index DELETE /my_index1,my_index2 DELETE /my_index* DELETE /_all

    |[Retrieves information about indices^] l| GET /my_index GET /my_index* GET my_index/_settings,_mappings[Checks whether an index exists^]  
    l HEAD /my_index

    |[Closes/opens an index^] l| POST /my_index/_close POST /my_index/_open[Shrinks an index to a new index with fewer primary shards^]

    |[Rolls over an alias to a new index if conditions are met^] l| POST /my_index/_rollover { “conditions”: { … } }

    .3+|[Mapping management^] |[Adds a new type to an existing index] l| PUT /my_index/_mapping/new_type { “properties”: { “my_field”: { “type”: “text” } } }

    |[Retrieves mapping definition for fields^] l| GET /my_index/_mapping/my_type/field/my_field GET /my_index1,my_index2/_mapping/my_type/field/my_field GET /_all/_mapping/my_type1,my_type2/field/my_field1,my_field2 GET /_all/_mapping/my_type1/field/my_field[Checks whether a type exists^]  
    l HEAD /my_index/_mapping/my_type

    .2+|[Alias management^] |[Creates an alias over an index^] l| POST /_aliases { “actions” : [ { “add” : { “index” : “my_index”, “alias” : “my_alias” } } ] }

    POST /_aliases { “actions” : [ { “add” : { “index” : [“index1”, “index2”] , “alias” : “another_alias” } } ] }

    |[Removes an alias^] l| POST /_aliases { “actions” : [ { “remove” : { “index” : “my_index”, “alias” : “my_old_alias” } } ] }

    .7+|[Index settings^] |[Updates settings of indices^] l| PUT /my_index/_settings { … }[Retrieves settings of indices^]  
    l GET /my_index/_settings

    |[Performs an analysis process of a text and return the tokens^] l| GET /_analyze { “analyzer” : “standard”, “text” : “this is a test” }

    |[Creates a new template^] l| PUT /_template/my_template { … }[Deletes an existing template^]  
    l DELETE /_template/my_template[Gets info about an existing template^]  
    l GET /_template/my_template[Checks whether a template exists^]  
    l HEAD /_template/my_template
    Replica configuration
    icon:exclamation-triangle[][Sets index data location on a disk^]

    .4+|[Monitoring^] |[Provides statistics on indices^] l| GET /_stats GET /my_index1/_stats GET /my_index1,my_index2/_stats GET /my_index1/_stats/flush,merge

    |[Provides info on Lucene segments^] l| GET /_segments GET /my_index1/_segments GET /my_index1,my_index2/_segments

    |[Provide recovery info on indices^] l| GET /_recovery GET /my_index1/_recovery GET /my_index1,my_index2/_recovery

    |[Provide store info on shard copies of indices^] l| GET /_shard_stores GET /my_index1/_shard_stores GET /my_index1,my_index2/_shard_stores

    .4+|[Status management^] |[Clears the cache of indices^] l| POST /_cache/clear POST /my_index/_cache/clear POST /my_index1,my_index2/_cache/clear

    |[Explicitly refreshes indices^] l| POST /_refresh POST /my_index/_refresh POST /my_index1,my_index2/_refresh

    |[Flushes in-memory transaction log on disk^] l| POST /_flush POST /my_index/_flush POST /my_index1,my_index2/_flush

    |[Merge Lucene segments^] l| POST /_forcemerge?max_num_segments=1 POST /my_index/_forcemerge?max_num_segments=1 POST /my_index1,my_index2/_forcemerge?max_num_segments=1

    .18+|[cat API^] | cat aliases |[Shows information about aliases, including filter and routing infos^] l| GET /_cat/aliases?v GET /_cat/aliases/my_alias?v

    cat allocations[Provides a snapshot on how many shards are allocated and how much disk space is used for each node ^]  
    l GET /_cat/allocation?v

    | cat count |[Provides quick access to the document count^] l| GET /_cat/count?v GET /_cat/count/my_index?v

    | cat fielddata |[Shows heap memory currently being used by fielddata^] l| GET /_cat/fielddata?v GET /_cat/fielddata/my_field1,my_field2?v

    | cat health |[One-line representation of the same information from^] /_cluster/health l| GET /_cat/health?v GET /_cat/health?v&ts=0

    | cat indices |[Provides a node-spanning cross-section of each index^] l| GET /_cat/indices?v GET /_cat/indices?v&s=index GET /_cat/indices?v&health=yellow GET /_cat/indices/my_index*?v&health=yellow

    cat master[Displays the master’s node ID, bound IP address, and node name^]  
    l GET /_cat/master?v

    | cat nodeattrs |[Shows custom node attributes^] l| GET /_cat/nodeattrs?v GET /_cat/nodeattrs?v&h=name,id,pid,ip

    | cat nodes |[Shows cluster topology^] l| GET /_cat/nodes?v GET /_cat/nodes?v&h=name,id,pid,ip

    cat pending tasks[Provides the same information as^] /_cluster/pending_tasks  
    l GET /_cat/pending_tasks?v

    | cat plugins |[Provides a node-spanning view of running plugins per node^] l| GET /_cat/plugins?v GET /_cat/plugins?v&h=name,id,pid,ip

    | cat recovery |[Shows on-going and completed index shard recoveries^] l| GET /_cat/recovery?v GET /_cat/recovery?v&h=name,id,pid,ip

    cat repositories[Shows snapshot repositories registered in the cluster^]  
    l GET /_cat/repositories?v

    | cat thread pool |[Shows cluster-wide thread pool statistics per node^] l| GET /_cat/thread_pool?v GET /_cat/thread_pool?v&h=id,pid,ip

    | cat shards |[Displays shards to nodes relationships^] l| GET /_cat/shards?v GET /_cat/shards/my_index?v GET /_cat/shards/my_ind*?v

    | cat segments |[Provides information similar to^] _segments l| GET /_cat/segments?v GET /_cat/segments/my_index?v GET /_cat/segments/my_index1,my_index2?v

    cat snapshots[Shows snapshots belonging to a repository^]  
    l /_cat/snapshots/my_repo?v

    | cat templates |[Provides information about existing templates^] l| GET /_cat/templates?v GET /_cat/templates/my_template GET /_cat/templates/my_template*

    .11+|[Cluster API^] | Cluster Health |[Gets the status of a cluster’s health^] l| GET /_cluster/health GET /_cluster/health?wait_for_status=yellow&timeout=50s GET /_cluster/health/my_index1 GET /_cluster/health/my_index1,my_index2

    | Cluster State |[Gets state information about a cluster^] l| GET /_cluster/state GET /_cluster/state/version,nodes/my_index1 GET /_cluster/state/version,nodes/my_index1,my_index2 GET /_cluster/state/version,nodes/_all

    | Cluster Stats |[Retrieves statistics from a cluster^] l| GET /_cluster/stats GET /_cluster/stats?human&pretty

    Pending cluster tasks[Returns a list of any cluster-level changes^]  
    l GET /_cluster/pending_tasks

    | Cluster Reroute |[Executes a cluster reroute allocation^] l| GET /_cluster/reroute { … }

    | Cluster Update Settings |[Update cluster-wide specific settings^] l| GET /_cluster/settings { “persistent” : { … }, “transient” : { … } }

    | Node Stats |[Retrieves cluster nodes statistics^] l| GET /_nodes/stats GET /_nodes/my_node1,my_node2/stats GET /_nodes/ GET /_nodes/stats/indices,os,process

    | Node Info |[Retrieves cluster nodes information^] l| GET /_nodes GET /_nodes/my_node1,my_node2 GET /_nodes/_all/indices,os,process GET /_nodes/indices,os,process GET /_nodes/my_node1,my_node2/_all

    | Task Management API | icon:exclamation-triangle[][Retrieve information about tasks currently executing on nodes in the cluster^] l| GET /_tasks GET /_tasks?nodes=my_node1,my_node2 GET /_tasks?nodes=my_node1,my_node2&actions=cluster:*

    | Nodes Hot Threads |[Gets current hot threads on nodes in the cluster^] l| GET /_nodes/hot_threads GET /_nodes/hot_threads/my_node GET /_nodes/my_node1,my_node2/hot_threads

    | Cluster Allocation Explain API | icon:exclamation-triangle[][Answers the question “why is this shard unnassigned?”^] l| GET /_cluster/allocation/explain GET /_cluster/allocation/explain { “index”: “myindex”, “shard”: 0, “primary”: false }

    4.+ icon:exclamation-triangle[] marks an experimental (respectively new) API that is subject to removal (resp. change) in future versions


    NOTE: Last updated on Feb. 22^th^

    Categories: Development Tags: ElasticElasticSearchAPI
  • Extension functions for more consistent APIs

    Hair extensions

    Kotlin’s extension functions are a great way to add behavior to a type sitting outside one’s control - the JDK or a third-party library.

    For example, the JDK’s String class offers the toLowerCase() and toUpperCase() methods but nothing to capitalize the string. In Kotlin, this can be helped by adding the desired behavior to the String class through an extension function:

    fun String.capitalize() = when {
        length < 2 -> toUpperCase()
        else -> Character.toUpperCase(toCharArray()[0]) + substring(1).toLowerCase()

    Extension functions usage is not limited to external types, though. It can also improve one’s own codebase, to handle null values more elegantly.

    This is a way one would define a class and a function in Kotlin:

    class Foo {
        fun foo() = println("foo")

    Then, it can be used on respectively non-nullable and nullable types like that:

    val foo1 = Foo()
    val foo2: Foo? = Foo()

    Notice the compiler enforces the usage of the null-safe ?. operator on the nullable type instance to prevent NullPointerException.

    Instead of defining the foo() method directly on the type, let’s define it as an extension function, but with a twist. Let’s make the ?. operator part of the function definition:

    class Foo
    fun Foo?.safeFoo() = println("null-safe foo")

    Usage is now slightly modified:

    val foo1 = Foo()
    val foo2: Foo? = Foo()
    val foo3: Foo? = null

    Whether the type is non-nullable or not, the calling syntax is consistent. Interestingly enough, the output is the following:

    null-safe foo
    null-safe foo
    null-safe foo

    Yes, it’s possible to call a method on a null instances! Now, let’s update the Foo class slightly:

    class Foo {
        val foo = 1

    What if the foo() extension function should print the foo property instead of a constant string?

    fun Foo?.safeFoo() = println(foo)

    The compiler complains:

    Only safe (?.) or non-null asserted (!!.) calls are allowed on a nullable receiver of type Foo?

    The extension function needs to be modified according to the compiler’s error:

    fun Foo?.safeFoo() = println(this?.foo)

    The output becomes:


    Extension functions are a great way to make API more consistent and to handle null elegantly instead of dropping the burden on caller code.

    Categories: Kotlin Tags: designAPIextension function