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

added docs to the repo

Browse Source
This commit is contained in:
Spencer Alger
2013-12-27 16:41:38 -07:00
parent 11c976e9f8
commit 65f9cc7e99
101 changed files with 3907 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/_descriptions/bulk.asciidoc Normal file
View File

@ -0,0 +1 @@
Perform many index/delete operations in a single API call.

1
docs/_descriptions/clearScroll.asciidoc Normal file
View File

@ -0,0 +1 @@
Clear the scroll request created by specifying the scroll parameter to search.

1
docs/_descriptions/cluster.getSettings.asciidoc Normal file
View File

@ -0,0 +1 @@
Get cluster settings (previously set with `putSettings()`)

1
docs/_descriptions/cluster.health.asciidoc Normal file
View File

@ -0,0 +1 @@
Get a very simple status on the health of the cluster.

3
docs/_descriptions/cluster.nodeHotThreads.asciidoc Normal file
View File

@ -0,0 +1,3 @@
Returns information about the hottest threads in the cluster or on a specific node as a String. The information is returned as text, and allows you to understand what are currently the most taxing operations happening in the cluster, for debugging or monitoring purposes.
WARNING: This endpoint returns plain text

1
docs/_descriptions/cluster.nodeInfo.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve one or more (or all) of the cluster nodes' information.

1
docs/_descriptions/cluster.nodeShutdown.asciidoc Normal file
View File

@ -0,0 +1 @@
Shutdown one or more (or all) nodes in the cluster.

1
docs/_descriptions/cluster.nodeStats.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve one or more (or all) of the cluster nodes statistics.

1
docs/_descriptions/cluster.putSettings.asciidoc Normal file
View File

@ -0,0 +1 @@
Update cluster wide specific settings.

1
docs/_descriptions/cluster.reroute.asciidoc Normal file
View File

@ -0,0 +1 @@
Explicitly execute a cluster reroute allocation command including specific commands.

1
docs/_descriptions/cluster.state.asciidoc Normal file
View File

@ -0,0 +1 @@
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).

1
docs/_descriptions/count.asciidoc Normal file
View File

@ -0,0 +1 @@
Get the number of documents for the cluster, index, type, or a query.

1
docs/_descriptions/create.asciidoc Normal file
View File

@ -0,0 +1 @@
Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur.

1
docs/_descriptions/delete.asciidoc Normal file
View File

@ -0,0 +1 @@
Delete a typed JSON document from a specific index based on its id.

1
docs/_descriptions/deleteByQuery.asciidoc Normal file
View File

@ -0,0 +1 @@
Delete documents from one or more indices and one or more types based on a query.

1
docs/_descriptions/exists.asciidoc Normal file
View File

@ -0,0 +1 @@
Returns a boolean indicating whether or not a given document exists.

1
docs/_descriptions/explain.asciidoc Normal file
View File

@ -0,0 +1 @@
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].

1
docs/_descriptions/get.asciidoc Normal file
View File

@ -0,0 +1 @@
Get a typed JSON document from the index based on its id.

1
docs/_descriptions/getSource.asciidoc Normal file
View File

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

5
docs/_descriptions/index.asciidoc Normal file
View File

@ -0,0 +1,5 @@
Stores a typed JSON document in an index, making it searchable. When the `id` param is not set, a unique id will be auto-generated. When you specify an `id` either a new document will be created, or an existing document will be updated. To enforce "put-if-absent" behavior set the `opType` to `"create"` or use the `create()` method.
Optimistic concurrency control is performed, when the `version` argument is specified. By default, no version checks are performed.
By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <<api-indices-refresh>>.

1
docs/_descriptions/indices.analyze.asciidoc Normal file
View File

@ -0,0 +1 @@
Perform the analysis process on a text and return the tokens breakdown of the text.

1
docs/_descriptions/indices.clearCache.asciidoc Normal file
View File

@ -0,0 +1 @@
Clear either all caches or specific cached associated with one ore more indices.

1
docs/_descriptions/indices.close.asciidoc Normal file
View File

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

1
docs/_descriptions/indices.create.asciidoc Normal file
View File

@ -0,0 +1 @@
Create an index in Elasticsearch.

1
docs/_descriptions/indices.delete.asciidoc Normal file
View File

@ -0,0 +1 @@
Delete an index in Elasticsearch

1
docs/_descriptions/indices.deleteAlias.asciidoc Normal file
View File

@ -0,0 +1 @@
Delete a specific alias.

1
docs/_descriptions/indices.deleteMapping.asciidoc Normal file
View File

@ -0,0 +1 @@
Delete a mapping (type definition) along with its data.

1
docs/_descriptions/indices.deleteTemplate.asciidoc Normal file
View File

@ -0,0 +1 @@
Delete an index template by its name.

1
docs/_descriptions/indices.deleteWarmer.asciidoc Normal file
View File

@ -0,0 +1 @@
Delete an index warmer.

1
docs/_descriptions/indices.exists.asciidoc Normal file
View File

@ -0,0 +1 @@
Return a boolean indicating whether given index exists.

1
docs/_descriptions/indices.existsAlias.asciidoc Normal file
View File

@ -0,0 +1 @@
Return a boolean indicating whether given alias exists.

1
docs/_descriptions/indices.existsType.asciidoc Normal file
View File

@ -0,0 +1 @@
Check if a type/types exists in an index/indices.

1
docs/_descriptions/indices.flush.asciidoc Normal file
View File

@ -0,0 +1 @@
Explicitly flush one or more indices.

1
docs/_descriptions/indices.getAlias.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve a specified alias.

1
docs/_descriptions/indices.getAliases.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve specified aliases

1
docs/_descriptions/indices.getFieldMapping.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve mapping definition of a specific field.

1
docs/_descriptions/indices.getMapping.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve mapping definition of index or index/type.

1
docs/_descriptions/indices.getSettings.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve settings for one or more (or all) indices.

1
docs/_descriptions/indices.getTemplate.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve an index template by its name.

1
docs/_descriptions/indices.getWarmer.asciidoc Normal file
View File

@ -0,0 +1 @@
Retreieve an index warmer.

1
docs/_descriptions/indices.open.asciidoc Normal file
View File

@ -0,0 +1 @@
Open a closed index, making it available for search.

1
docs/_descriptions/indices.optimize.asciidoc Normal file
View File

@ -0,0 +1 @@
Explicitly optimize one or more indices.

1
docs/_descriptions/indices.putAlias.asciidoc Normal file
View File

@ -0,0 +1 @@
Create an alias for a specific index/indices.

1
docs/_descriptions/indices.putMapping.asciidoc Normal file
View File

@ -0,0 +1 @@
Register specific mapping definition for a specific type.

1
docs/_descriptions/indices.putSettings.asciidoc Normal file
View File

@ -0,0 +1 @@
Change specific index level settings in real time.

1
docs/_descriptions/indices.putTemplate.asciidoc Normal file
View File

@ -0,0 +1 @@
Create an index template that will automatically be applied to new indices created.

1
docs/_descriptions/indices.putWarmer.asciidoc Normal file
View File

@ -0,0 +1 @@
Create an index warmer to run registered search requests to warm up the index before it is available for search.

1
docs/_descriptions/indices.refresh.asciidoc Normal file
View File

@ -0,0 +1 @@
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.

1
docs/_descriptions/indices.segments.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve low level segments information that a Lucene index (shard level) is built with.

1
docs/_descriptions/indices.snapshotIndex.asciidoc Normal file
View File

@ -0,0 +1 @@
Initiate a snapshot through the gateway of one or more indices.

1
docs/_descriptions/indices.stats.asciidoc Normal file
View File

@ -0,0 +1 @@
Retrieve statistics on different operations happening on an index.

1
docs/_descriptions/indices.status.asciidoc Normal file
View File

@ -0,0 +1 @@
Get a comprehensive status information of one or more indices.

1
docs/_descriptions/indices.updateAliases.asciidoc Normal file
View File

@ -0,0 +1 @@
Update specified aliases.

1
docs/_descriptions/indices.validateQuery.asciidoc Normal file
View File

@ -0,0 +1 @@
Validate a potentially expensive query without executing it.

1
docs/_descriptions/info.asciidoc Normal file
View File

@ -0,0 +1 @@
Get basic info from the current cluster.

1
docs/_descriptions/mget.asciidoc Normal file
View File

@ -0,0 +1 @@
Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids.

1
docs/_descriptions/mlt.asciidoc Normal file
View File

@ -0,0 +1 @@
(more like this) Gets more documents that are “like” the document specified using `index`, `type`, and `id`.

1
docs/_descriptions/msearch.asciidoc Normal file
View File

@ -0,0 +1 @@
Execute several search requests within the same request.

1
docs/_descriptions/percolate.asciidoc Normal file
View File

@ -0,0 +1 @@
Match a document against registered percolator queries.

1
docs/_descriptions/scroll.asciidoc Normal file
View File

@ -0,0 +1 @@
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.

4
docs/_descriptions/search.asciidoc Normal file
View File

@ -0,0 +1,4 @@
Return documents matching a query, aggregations/facets, highlighted snippets, suggestions, and more. Write your queries as either http://www.elasticsearch.org/guide/reference/api/search/uri-request/[simple query strings] in the `q` parameter, or by specifying a http://www.elasticsearch.org/guide/reference/api/search/request-body/[full request definition] using the http://www.elasticsearch.org/guide/reference/query-dsl/[Elasticsearch Query DSL] in the `body` parameter.
TIP: https://github.com/fullscale/elastic.js[elastic.js] can be used to make building query bodies easier.

1
docs/_descriptions/suggest.asciidoc Normal file
View File

@ -0,0 +1 @@
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.

4
docs/_descriptions/update.asciidoc Normal file
View File

@ -0,0 +1,4 @@
Update parts of a document. The required body parameter can contain one of two things:
* a partial document, which will be merged with the existing one.
* a `script` which will update the document content