{"id":18008905,"url":"https://github.com/tlux/es_client","last_synced_at":"2026-05-03T02:36:33.408Z","repository":{"id":57497117,"uuid":"205242935","full_name":"tlux/es_client","owner":"tlux","description":"A minimalistic Elasticsearch client for Elixir.","archived":false,"fork":false,"pushed_at":"2020-08-25T09:20:38.000Z","size":95,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-10T20:18:26.646Z","etag":null,"topics":["client","elasticsearch","elixir","elixir-library","hex-package"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tlux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-29T20:11:58.000Z","updated_at":"2020-08-25T09:20:40.000Z","dependencies_parsed_at":"2022-09-03T23:51:26.065Z","dependency_job_id":null,"html_url":"https://github.com/tlux/es_client","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlux%2Fes_client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlux%2Fes_client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlux%2Fes_client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlux%2Fes_client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tlux","download_url":"https://codeload.github.com/tlux/es_client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247182337,"owners_count":20897379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","elasticsearch","elixir","elixir-library","hex-package"],"created_at":"2024-10-30T02:07:51.868Z","updated_at":"2026-05-03T02:36:28.385Z","avatar_url":"https://github.com/tlux.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ESClient\n\n[![Build Status](https://travis-ci.org/tlux/es_client.svg?branch=master)](https://travis-ci.org/tlux/es_client)\n[![Coverage Status](https://coveralls.io/repos/github/tlux/es_client/badge.svg?branch=master)](https://coveralls.io/github/tlux/es_client?branch=master)\n[![Hex.pm](https://img.shields.io/hexpm/v/es_client.svg)](https://hex.pm/packages/es_client)\n\nA minimalistic Elasticsearch client for Elixir.\n\n## Prerequisites\n\n* Elixir \u003e= 1.8\n* Erlang \u003e= 20\n\n## Installation\n\nIf [available in Hex](https://hex.pm/docs/publish), the package can be installed\nby adding `es_client` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:es_client, \"~\u003e 1.0\"},\n\n    # You will also need a JSON library\n    {:jason, \"~\u003e 1.1\"}\n  ]\nend\n```\n\nDocumentation can be generated with\n[ExDoc](https://github.com/elixir-lang/ex_doc) and published on\n[HexDocs](https://hexdocs.pm). Once published, the docs can be found at\n[https://hexdocs.pm/es_client](https://hexdocs.pm/es_client).\n\n## Usage\n\nYou can call the client directly if you have a config struct.\n\n```elixir\nconfig = %ESClient.Config{base_url: \"http://localhost:9201\"}\nESClient.get!(config, \"_cat/health\")\n```\n\nIt's also possible to pass a list of path segments.\n\n```elixir\nESClient.get!(config, [\"_cat\", \"health\"])\n```\n\nWhen the location is a tuple, the second element becomes encoded as query\nparams.\n\n```elixir\nESClient.get!(config, {[\"_cat\", \"health\"], verbose: true})\n```\n\nOr you can `use` this module to build your own custom client and obtain values\nfrom the application config.\n\n```elixir\ndefmodule MyCustomClient\n  use ESClient, otp_app: :my_app\nend\n```\n\nDon't forget to add the configuration to your config.exs.\n\n```elixir\nuse Mix.Config\n# or\nimport Config\n\nconfig :my_app, MyCustomClient,\n  base_url: \"http://localhost:9201\",\n  json_keys: :atoms,\n  json_library: Jason,\n  timeout: 15_000\n```\n\nThen, use your client.\n\n```elixir\nMyCustomClient.get!(\"_cat/health\")\n```\n\n## Missing Features\n\n* Authentication\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlux%2Fes_client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftlux%2Fes_client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlux%2Fes_client/lists"}