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

added stubs for the different doc pages, [ci skip]

Browse Source
This commit is contained in:
Spencer Alger
2013-11-11 15:41:48 -07:00
parent 540035b93f
commit 7905d9b78c
4 changed files with 406 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -5,7 +5,7 @@ Official *low-level* client for Elasticsearch.
## Features ## Features
- One-to-one mapping with REST API and other language clients - One-to-one mapping with REST API and other language clients
- Generalized, pluggable architecture. See [replacing core components](TODO: details the peices that are replaceable) - Generalized, pluggable architecture. See [replacing core components](docs/replacing_core_components.md)
- Configurable, automatic discovery of cluster nodes - Configurable, automatic discovery of cluster nodes
- Persistent, Keep-Alive connections - Persistent, Keep-Alive connections
- Load balancing (with pluggable selection strategy) across all available nodes. - Load balancing (with pluggable selection strategy) across all available nodes.
@ -16,7 +16,7 @@ elasticsearch.js works great in node, as well as modern browsers (many thanks to
- Node: - Node:
[![Build Status](https://travis-ci.com/elasticsearch/elasticsearch-js)](https://magnum.travis-ci.com/spenceralger/elasticsearch-js) [![Build Status](https://magnum.travis-ci.com/spenceralger/elasticsearch-js.png?token=tsFxSKHtVKG8EZavSjXY)](https://magnum.travis-ci.com/spenceralger/elasticsearch-js)
- Browsers (see [browser builds](#browser-builds)): - Browsers (see [browser builds](#browser-builds)):
@ -59,6 +59,14 @@ bower install elasticsearch-angular
bower install elasticsearch-jquery bower install elasticsearch-jquery
``` ```
## Docs
- [Configuration](#configuration)
- [API](docs/api.md)
- [Replacing Core Components](docs/replacing_core_components.md)
- [Errors](docs/errors.md)
- [Setting Up Logging](docs/setting_up_logging.md)
- [FAQ](#faq)
## Configuration ## Configuration
The `Client` constructor accepts a single object as it's argument, and the following keys can be used to configure that client instance: The `Client` constructor accepts a single object as it's argument, and the following keys can be used to configure that client instance:
@ -95,7 +103,7 @@ log: {
} }
``` ```
Unless a constructor is specified, this sets the output settings for the bundled logger. See [setting up logging](TODO: detail logging why) for more information. Unless a constructor is specified, this sets the output settings for the bundled logger. See [setting up logging](docs/setting_up_logging.md) for more information.
### connectionClass ### connectionClass
Type: `String`, `Constructor` Type: `String`, `Constructor`
@ -148,7 +156,7 @@ Type: `Number`
Defailt: `3` Defailt: `3`
How many times should the client try to connect to other nodes before returning a [ConnectionFault](TODO: error types) error. (see [node death](#node-death)) How many times should the client try to connect to other nodes before returning a [ConnectionFault](docs/error.md#connectionfault) error. (see [node death](#node-death))
### timeout ### timeout
Type: `Number` Type: `Number`
@ -202,7 +210,7 @@ The number of milliseconds this request has to complete. It defaults to the time
### Methods ### Methods
All the methods can be seen [here](TODO: api docs), or take a look at [api.js](src/lib/api.js). All the methods can be seen [here](docs/api.md), or take a look at [api.js](src/lib/api.js).
### Examples ### Examples

379
docs/api.md Normal file
View File

@ -0,0 +1,379 @@
# API
## Table Of Contents
TODO: generate this when the js_api is generated
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>
### MethodName [more info](http://elasticsearch.com)
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
<tr>
<td>Param Name</td>
<td>String</td>
<td>This is an important param</td>
</tr>
</table>

11
docs/replacing_core_components.md Normal file
View File

@ -0,0 +1,11 @@
# Replacing Core Components
TODO: detail the components that are replaceable
## API
## Connection
## ConnectionPool
## Log

3
docs/setting_up_logging.md Normal file
View File

@ -0,0 +1,3 @@
# Setting Up Logging
TODO: what are loggers, how to use bunyan/winston