Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Zatvobor/tirexs
An Elixir flavored HTTP client and DSL library for Elasticsearch
https://github.com/Zatvobor/tirexs
elasticsearch
Last synced: 3 months ago
JSON representation
An Elixir flavored HTTP client and DSL library for Elasticsearch
- Host: GitHub
- URL: https://github.com/Zatvobor/tirexs
- Owner: Zatvobor
- License: other
- Created: 2013-02-14T16:22:03.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2022-01-10T05:34:18.000Z (about 3 years ago)
- Last Synced: 2024-10-02T07:58:30.927Z (4 months ago)
- Topics: elasticsearch
- Language: Elixir
- Homepage: https://hexdocs.pm/tirexs/api-reference.html
- Size: 647 KB
- Stars: 429
- Watchers: 12
- Forks: 92
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - An Elixir flavored DSL for building JSON based requests to Elasticsearch engine. (ORM and Datamapping)
- fucking-awesome-elixir - tirexs - An Elixir flavored DSL for building JSON based requests to Elasticsearch engine. (ORM and Datamapping)
- awesome-elixir - tirexs - An Elixir flavored DSL for building JSON based requests to Elasticsearch engine. (ORM and Datamapping)
README
[](https://travis-ci.org/Zatvobor/tirexs) [](https://hex.pm/packages/tirexs) [](https://hex.pm/packages/tirexs) [](https://beta.hexfaktor.org/github/Zatvobor/tirexs)
An Elixir flavored HTTP client and DSL library for building JSON based settings, mappings, queries to Elasticsearch engine.
## Getting Started
1. Add this to the `defp deps do` list in your mix.exs file:
```elixir
{:tirexs, "~> 0.8"}
```
2. Also in mix.exs, add `:tirexs` to the `:applications` list in `def application`.
3. In config/dev.exs, configure `tirexs`:
```elixir
# The default uri is http://127.0.0.1:9200
config :tirexs, :uri, "http://127.0.0.1:9200"
```
See [lib/tirexs/env.ex](https://github.com/Zatvobor/tirexs/blob/master/lib/tirexs/env.ex) for more configuration options.
4. Index a document:
```elixir
import Tirexs.HTTP
put("/my_index/users/1", [name: "Jane", email: "[email protected]"])
# {:ok, 201,
# %{_id: "1", _index: "my_index", _type: "users", _version: 1, created: true}}
```
5. Fetch the document:
```elixir
get("/my_index/users/1")
# {:ok, 200,
# %{_id: "1", _index: "my_index",
# _source: %{email: "[email protected]", name: "Jane"}, _type: "users",
# _version: 1, found: true}}
```
6. Simplified search:
```elixir
get("/my_index/users/_search?q=name:jane")
# {:ok, 200,
# %{_shards: %{failed: 0, successful: 5, total: 5},
# hits: %{hits: [%{_id: "1", _index: "my_index", _score: 0.30685282,
# _source: %{email: "[email protected]", name: "Jane"}, _type: "users"}],
# max_score: 0.30685282, total: 1}, timed_out: false, took: 10}}
```
7. Query DSL
```elixir
import Tirexs.Search
query = search [index: "my_index"] do
query do
match "name", "jane"
end
end
# [search: [query: [match: [name: [query: "jane"]]]], index: "my_index"]
Tirexs.Query.create_resource(query)
# {:ok, 200,
# %{_shards: %{failed: 0, successful: 5, total: 5},
# hits: %{hits: [%{_id: "1", _index: "my_index", _score: 0.30685282,
# _source: %{email: "[email protected]", name: "Jane"}, _type: "users"}],
# max_score: 0.30685282, total: 1}, timed_out: false, took: 5}}
```
Check out [/examples](/examples) directory as a quick intro.
[](https://gitter.im/Zatvobor/tirexs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## tirexs is split into several layers
- [Raw HTTP layer](https://hexdocs.pm/tirexs/Tirexs.HTTP.html) and [API helpers](https://hexdocs.pm/tirexs/Tirexs.Resources.APIs.html)
- Multiple operations in single call such as [Bulk API](https://hexdocs.pm/tirexs/Tirexs.Bulk.html) and [mget API](https://hexdocs.pm/tirexs/Tirexs.MultiGet.html)
- [DSL flavored helpers](https://hexdocs.pm/tirexs/Tirexs.DSL.html)
Find out more in [api reference](https://hexdocs.pm/tirexs/api-reference.html)
## Not sure?
Look around using [https://hex.pm/packages?search=elasticsearch...](https://hex.pm/packages?search=elasticsearch&sort=downloads) to find out some other packages.
## Contributing
If you feel like porting or fixing something, please drop a [pull request](https://github.com/Zatvobor/tirexs/pulls) or [issue tracker](https://github.com/Zatvobor/tirexs/issues) at GitHub! Check out the [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
## License
`Tirexs` source code is released under Apache 2 License.
Check [LICENSE](LICENSE) and [NOTICE](NOTICE) files for more details. The project HEAD is https://github.com/zatvobor/tirexs.
[](https://github.com/igrigorik/ga-beacon)