|
1 | 1 | # elasticsearch-lua |
2 | 2 |
|
3 | | -[](https://travis-ci.org/DhavalKapil/elasticsearch-lua) [](https://coveralls.io/github/DhavalKapil/elasticsearch-lua?branch=master) |
| 3 | +[](https://travis-ci.org/DhavalKapil/elasticsearch-lua) [](https://coveralls.io/github/DhavalKapil/elasticsearch-lua?branch=2.x.y) |
4 | 4 |
|
5 | | -> A simple low level client for elasticsearch written in lua. |
| 5 | +[](https://gitter.im/DhavalKapil/elasticsearch-lua?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](LICENSE) |
| 6 | + |
| 7 | +[](https://luarocks.org/modules/dhavalkapil/elasticsearch) [](https://img.shields.io/badge/Lua-5.1%2C%20JIT%2C%205.2%2C%205.3-blue.svg) |
| 8 | + |
| 9 | +A low level client for Elasticsearch written in Lua. |
6 | 10 |
|
7 | 11 | In accordance with other official low level clients, the client accepts associative arrays in the form of lua table as parameters. |
8 | 12 |
|
9 | 13 | ## Features: |
10 | 14 |
|
11 | | -1. One-to-one mapping with REST API and other language clients |
| 15 | +1. One-to-one mapping with REST API and other language clients. |
12 | 16 | 2. Proper load balancing across all nodes. |
13 | | -3. Pluggable and multiple selection strategies and connection pool. |
| 17 | +3. Pluggable and multiple connection, selection strategies and connection pool. |
14 | 18 | 4. Console logging facility. |
15 | 19 | 5. Almost every parameter is configurable. |
16 | 20 |
|
17 | | -## Requirements |
| 21 | +## Elasticsearch Version Matrix |
18 | 22 |
|
19 | | -`elasticsearch-lua` works for lua >= 5.1 version. |
| 23 | +| Elasticsearch Version | elasticsearch-lua Branch | |
| 24 | +| --------------------- | ------------------------ | |
| 25 | +| >= 2.0, < 5.0 | 2.x.y | |
20 | 26 |
|
21 | | -It has been successfully tested for elasticsearch version 1.6. |
| 27 | +## Lua Version Requirements |
22 | 28 |
|
23 | | -## Setup |
| 29 | +`elasticsearch-lua` works for lua >= 5.1 version. |
24 | 30 |
|
25 | | -1. Clone this repository and `cd` to it. |
26 | | -2. Download and install ``luarocks``. Follow [these](https://github.com/keplerproject/luarocks/wiki/Installation-instructions-for-Unix) steps. Make sure to change lua's version to 5.3 while installation(default is 5.1). |
27 | | -3. Install dependencies: |
28 | | -``` |
29 | | - [sudo] luarocks install elasticsearch-scm-0.rockspec |
30 | | -``` |
31 | | -4. Add the source directory to your lua program's `package.path`. |
| 31 | +## Setup |
32 | 32 |
|
33 | | -OR |
| 33 | +It can be installed using [luarocks](https://luarocks.org) |
34 | 34 |
|
35 | | -It can also be installed using luarocks |
36 | 35 | ``` |
37 | 36 | [sudo] luarocks install --server=http://luarocks.org/manifests/dhavalkapil elasticsearch |
38 | 37 | ``` |
39 | 38 |
|
40 | 39 | ## Documentation |
41 | 40 |
|
| 41 | +The complete documetation is [here](http://elasticsearch-lua.readthedocs.io/). |
| 42 | + |
42 | 43 | ### Create elasticsearch client instance: |
43 | 44 |
|
44 | 45 | ```lua |
@@ -166,3 +167,11 @@ data, err = client:update{ |
166 | 167 | } |
167 | 168 | } |
168 | 169 | ``` |
| 170 | + |
| 171 | +## Contribution |
| 172 | + |
| 173 | +Feel free to [file issues](https://github.com/DhavalKapil/elasticsearch-lua/issues) and submit [pull requests](https://github.com/DhavalKapil/elasticsearch-lua/pulls) – contributions are welcome. Please try to follow the code style used in the repository. |
| 174 | + |
| 175 | +## License |
| 176 | + |
| 177 | +elasticsearch-lua is licensed under the [MIT license](https://dhaval.mit-license.org/2015/license.txt). |
0 commit comments