This commit is contained in:
Spencer Alger
2015-01-05 12:54:10 -07:00
15 changed files with 38 additions and 26 deletions

View File

@ -1 +1 @@
Get the source of a document by it's index, type and id.
Get the source of a document by its index, type and id.

View File

@ -1 +1 @@
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.

View File

@ -889,7 +889,8 @@ link:#[back to top]
client.getSource([params, [callback]])
--------
Get the source of a document by it's index, type and id.
Get the source of a document by its index, type and id.
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.4/docs-get.html[the elasticsearch docs] for more about this method.
@ -2955,7 +2956,8 @@ link:#[back to top]
client.indices.close([params, [callback]])
--------
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-open-close.html[the elasticsearch docs] for more about this method.

View File

@ -668,7 +668,8 @@ link:#[back to top]
client.getSource([params, [callback]])
--------
Get the source of a document by it's index, type and id.
Get the source of a document by its index, type and id.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more about this method.
@ -1988,7 +1989,8 @@ link:#[back to top]
client.indices.close([params, [callback]])
--------
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for more about this method.

View File

@ -763,7 +763,8 @@ link:#[back to top]
client.getSource([params, [callback]])
--------
Get the source of a document by it's index, type and id.
Get the source of a document by its index, type and id.
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/docs-get.html[the elasticsearch docs] for more about this method.
@ -2529,7 +2530,8 @@ link:#[back to top]
client.indices.close([params, [callback]])
--------
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for more about this method.

View File

@ -775,7 +775,8 @@ link:#[back to top]
client.getSource([params, [callback]])
--------
Get the source of a document by it's index, type and id.
Get the source of a document by its index, type and id.
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/docs-get.html[the elasticsearch docs] for more about this method.
@ -2607,7 +2608,8 @@ link:#[back to top]
client.indices.close([params, [callback]])
--------
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for more about this method.

View File

@ -800,7 +800,8 @@ link:#[back to top]
client.getSource([params, [callback]])
--------
Get the source of a document by it's index, type and id.
Get the source of a document by its index, type and id.
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/docs-get.html[the elasticsearch docs] for more about this method.
@ -2720,7 +2721,8 @@ link:#[back to top]
client.indices.close([params, [callback]])
--------
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for more about this method.

View File

@ -879,7 +879,8 @@ link:#[back to top]
client.getSource([params, [callback]])
--------
Get the source of a document by it's index, type and id.
Get the source of a document by its index, type and id.
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.3/docs-get.html[the elasticsearch docs] for more about this method.
@ -2870,7 +2871,8 @@ link:#[back to top]
client.indices.close([params, [callback]])
--------
Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations.
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-open-close.html[the elasticsearch docs] for more about this method.

View File

@ -3,7 +3,7 @@
We also provide builds of the elasticsearch.js client for use in the browser. These versions of the client are currently ***experimental***. We test these builds using https://saucelabs.com/u/elasticsearch-js[saucelabs] in Chrome, Firefox, and Internet Explorer 10, and 11.
While there is https://github.com/elasticsearch/elasticsearch-js/issues/96#issuecomment-42617480[a way to get it working in IE 9], the browser severly limits what you can do with cross-domain requests. Because of these limits, many of the API calls and other functionality do not work.
While there is https://github.com/elasticsearch/elasticsearch-js/issues/96#issuecomment-42617480[a way to get it working in IE 9], the browser severely limits what you can do with cross-domain requests. Because of these limits, many of the API calls and other functionality do not work.
=== Bower
If you use bower to manage your dependencies, then just run:
@ -14,7 +14,7 @@ bower install elasticsearch
---------
=== Download
* v3.0.0: https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-3.0.0.zip[zip], https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-3.0.0.tar.gz[tar.gz]
* v3.0.2: https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-3.0.2.zip[zip], https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-3.0.2.tar.gz[tar.gz]
=== Angular Build

View File

@ -1,7 +1,7 @@
[[configuration]]
== Configuration
The `Client` constructor accepts a single object as it's argument. In the <<config-options>> section all of the available options/keys are listed.
The `Client` constructor accepts a single object as its argument. In the <<config-options>> section all of the available options/keys are listed.
[source,js]
------

View File

@ -7,7 +7,7 @@ These are the standard Error types which may be passed back from the client. To
`ConnectionFault`:: The connection was unable to initiate or complete a request with the Elasticsearch node.
`NoConnections`:: All of the connections in the ConnectionPool are dead.
`RequestTimeout`:: The request timed-out.
`Serialization`:: The response received from Elasticsearch could not be deserilaized.
`Serialization`:: The response received from Elasticsearch could not be deserialized.
`503` or `ServiceUnavailable`:: Elasticsearch responded with a 503 status.
`500` or `InternalServerError`:: Elasticsearch responded with a 500 status.
`412` or `PreconditionFailed`:: Elasticsearch responded with a 412 status.
@ -15,4 +15,4 @@ These are the standard Error types which may be passed back from the client. To
`403` or `Forbidden`:: Elasticsearch responded with a 403 status.
`404` or `NotFound`:: Elasticsearch responded with a 404 status.
`400` or `BadRequest`:: Elasticsearch responded with a 400 status.
`Generic`:: Elasticsearch responded with a status that does not map to it's own error type.
`Generic`:: Elasticsearch responded with a status that does not map to its own error type.

View File

@ -29,4 +29,4 @@ var client = new elasticsearch.Client({
client.getDog( ... );
--------------
When the client is created, it's prototype is set to the API version selected, and therefore you can access the client via the `this` variable within your API methods. Make requests within your methods using `this.transport.request(params, cb)`. For more information about the transport, see <<transport-reference>>.
When the client is created, its prototype is set to the API version selected, and therefore you can access the client via the `this` variable within your API methods. Make requests within your methods using `this.transport.request(params, cb)`. For more information about the transport, see <<transport-reference>>.

View File

@ -18,7 +18,7 @@ var client = new elasticsearch.Client({
Almost all of the methods on the client accept two arguments:
* `params` - an optional object/hash of parameters <<api-conventions,More info here>>.
* `callback` - an optional function that will be called with the final result of the method. When omitted, a https://github.com/cujojs/when/blob/master/docs/api.md#promise[promise] is returned. api-conventions-cb[More info here].
* `callback` - an optional function that will be called with the final result of the method. When omitted, a https://github.com/cujojs/when/blob/master/docs/api.md#promise[promise] is returned. <<api-conventions-cb,More info here>>.
==== Ping the cluster
@ -70,11 +70,11 @@ client.indices.delete({
-----------------
=== Searching for documents
A very common use-case for elasticsearch is to sort through large collections of documents in order to find ones that are relavent to a query. In most cases you will use the client's `search()` method to accomplish this.
A very common use-case for elasticsearch is to sort through large collections of documents in order to find ones that are relevant to a query. In most cases you will use the client's `search()` method to accomplish this.
==== Elasticsearch Query DSL
For many searches you will want to define a search document that tells elasticsearch exactly how to find the documents you are looking for. To do this you will use the http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html[elasticsearch query DSL]. If you are not familiary with Elasticsearch's query DSL is it recommended that you research the topic at elasticsearch.org or watch/read one of these introductions:
For many searches you will want to define a search document that tells elasticsearch exactly how to find the documents you are looking for. To do this you will use the http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html[elasticsearch query DSL]. If you are not familiar with Elasticsearch's query DSL is it recommended that you research the topic at elasticsearch.org or watch/read one of these introductions:
* https://www.youtube.com/watch?v=52G5ZzE0XpY#t=1471[Clinton Gormley "Getting down and dirty with Elasticsearch"]
* http://okfnlabs.org/blog/2013/07/01/elasticsearch-query-tutorial.html#query-dsl-overview[Querying Elasticsearch - A Tutorial and Guide]