habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

additional changes required for 1.4

Browse Source
This commit is contained in:
Spencer Alger
2014-09-12 16:34:09 -07:00
parent e1ace4f2a9
commit 56d04a4185
3 changed files with 4540 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
docs/api_methods.asciidoc
View File

@ -1,11 +1,12 @@
[[api-reference]]
== 1.3 API
== 1.4 API
NOTE: This is currently the default API, but in upcomming versions that will change. We recommend setting the `apiVersion` config param when you instantiate your client to make sure that the API does not change unexpectedly.
[[js-api-method-index]]
* <<api-abortbenchmark,abortBenchmark>>
* <<api-benchmark,benchmark>>
* <<api-bulk,bulk>>
* <<api-clearscroll,clearScroll>>
* <<api-count,count>>
@ -35,6 +36,7 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
* <<api-puttemplate,putTemplate>>
* <<api-scroll,scroll>>
* <<api-search,search>>
* <<api-searchexists,searchExists>>
* <<api-searchshards,searchShards>>
* <<api-searchtemplate,searchTemplate>>
* <<api-suggest,suggest>>
@ -75,6 +77,7 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
* <<api-indices-existstemplate,indices.existsTemplate>>
* <<api-indices-existstype,indices.existsType>>
* <<api-indices-flush,indices.flush>>
* <<api-indices-get,indices.get>>
* <<api-indices-getalias,indices.getAlias>>
* <<api-indices-getaliases,indices.getAliases>>
* <<api-indices-getfieldmapping,indices.getFieldMapping>>
@ -132,6 +135,33 @@ The default method is `POST` and the usual <<api-conventions,params and return v
link:#[back to top]
[[api-benchmark]]
=== `benchmark`
[source,js]
--------
client.benchmark([params, [callback]])
--------
// no description
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`verbose`::
`Boolean` -- Specify whether to return verbose statistics about each iteration (default: false)
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`type`::
`String` -- The name of the document type
link:#[back to top]
[[api-bulk]]
=== `bulk`
@ -608,6 +638,16 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
==== Params
[horizontal]
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
`String` -- Specific version type
Options:::
* `"internal"`
* `"external"`
* `"external_gte"`
* `"force"`
`id`::
`String` -- Script ID
`lang`::
@ -864,6 +904,16 @@ The default method is `GET` and the usual <<api-conventions,params and return va
==== Params
[horizontal]
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
`String` -- Specific version type
Options:::
* `"internal"`
* `"external"`
* `"external_gte"`
* `"force"`
`id`::
`String` -- Script ID
`lang`::
@ -942,6 +992,16 @@ The default method is `GET` and the usual <<api-conventions,params and return va
==== Params
[horizontal]
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
`String` -- Specific version type
Options:::
* `"internal"`
* `"external"`
* `"external_gte"`
* `"force"`
`id`::
`String` -- Template ID
@ -1190,8 +1250,6 @@ client.mlt({
`Number` -- The offset from which to return results
`searchIndices`::
`String, String[], Boolean` -- A comma-separated list of indices to perform the query against (default: the index containing the document)
`searchQueryHint`::
`String` -- The search query hint
`searchScroll`::
`String` -- A scroll search request definition
`searchSize`::
@ -1501,6 +1559,22 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
==== Params
[horizontal]
`[opType=index]`::
`String` -- Explicit operation type
Options:::
* `"index"`
* `"create"`
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
`String` -- Specific version type
Options:::
* `"internal"`
* `"external"`
* `"external_gte"`
* `"force"`
`id`::
`String` -- Script ID
`lang`::
@ -1724,6 +1798,8 @@ Options:::
`Boolean` -- Whether to calculate and return scores even if they are not used for sorting
`version`::
`Boolean` -- Specify whether to return document version as part of a hit
`queryCache`::
`Boolean` -- Specify if query cache should be used for this request or not, defaults to index level setting
`index`::
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`type`::
@ -1731,6 +1807,49 @@ Options:::
link:#[back to top]
[[api-searchexists]]
=== `searchExists`
[source,js]
--------
client.searchExists([params, [callback]])
--------
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/exists.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`[expandWildcards=open]`::
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
Options:::
* `"open"`
* `"closed"`
`minScore`::
`Number` -- Include only documents with a specific `_score` value in the result
`preference`::
`String` -- Specify the node or shard the operation should be performed on (default: random)
`routing`::
`String` -- Specific routing value
`source`::
`String` -- The URL-encoded query definition (instead of using the request body)
`index`::
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
`type`::
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
link:#[back to top]
[[api-searchshards]]
=== `searchShards`
@ -2039,7 +2158,7 @@ Options:::
`fields`::
`String, String[], Boolean` -- A comma-separated list of fields to return in the response
`lang`::
`String` -- The script language (default: mvel)
`String` -- The script language (default: groovy)
`parent`::
`String` -- ID of the parent document
`refresh`::
@ -2056,6 +2175,10 @@ Options:::
`String` -- Specific routing value
`script`::
`Anything` -- The URL-encoded script definition (instead of using request body)
`scriptId`::
`Anything` -- The id of a stored script
`scriptedUpsert`::
`Boolean` -- True if the script referenced in script or script_id should be called to perform inserts - defaults to false
`timeout`::
`Date, Number` -- Explicit operation timeout
`timestamp`::
@ -2701,8 +2824,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`Boolean` -- Simulate the operation only and return the resulting state
`explain`::
`Boolean` -- Return an explanation of why the commands can or cannot be executed
`filterMetadata`::
`Boolean` -- Don't return cluster state metadata (default: false)
`metric`::
`String, String[], Boolean` -- Limit the information returned to the specified metrics. Defaults to all but metadata
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`timeout`::
@ -2859,6 +2982,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index name to limit the operation
`recycler`::
`Boolean` -- Clear the recycler cache
`queryCache`::
`Boolean` -- Clear query cache
link:#[back to top]
@ -3073,7 +3198,7 @@ client.indices.exists([params, [callback]])
Return a boolean indicating whether given index exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3219,6 +3344,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`Boolean` -- Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
`full`::
`Boolean` -- If set to true a new index writer is created and settings that have been changed related to the index writer will be refreshed. Note: if a full flush is required for a setting to take effect this will be part of the settings update process and it not required to be executed by the user. (This setting can be considered as internal)
`waitIfOngoing`::
`Boolean` -- If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is false and will cause an exception to be thrown on the shard level if another flush operation is already running.
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -3234,6 +3361,39 @@ Options:::
link:#[back to top]
[[api-indices-get]]
=== `indices.get`
[source,js]
--------
client.indices.get([params, [callback]])
--------
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-index.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`ignoreUnavailable`::
`Boolean` -- Ignore unavailable indexes (default: false)
`allowNoIndices`::
`Boolean` -- Ignore if a wildcard expression resolves to no concrete indices (default: false)
`expandWildcards`::
`String, String[], Boolean` -- Whether wildcard expressions should get expanded to open or closed indices (default: open)
`index`::
`String, String[], Boolean` -- A comma-separated list of index names
`feature`::
`String, String[], Boolean` -- A comma-separated list of features
link:#[back to top]
[[api-indices-getalias]]
=== `indices.getAlias`

4372
docs/api_methods_1_3.asciidoc Normal file
View File

File diff suppressed because it is too large Load Diff

2
package.json
View File

@ -31,7 +31,7 @@
"master",
"1.x"
],
"default_api_branch": "1.3"
"default_api_branch": "1.4"
},
"devDependencies": {
"aliasify": "~1.2.4",