Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
swallez committed Aug 27, 2024
1 parent bcade94 commit e6e2f02
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ The following are a list of Cargo features that can be enabled or disabled:
API might have breaking changes in any future version, or it might even be removed entirely. This feature also
enables `beta-apis`.

Additionally, this library also runs in Web Assembly runtimes that provide the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), like node.js and web browsers.

## Getting started

The client exposes all Elasticsearch APIs as associated functions, either on
the root client, `Elasticsearch`, or on one of the _namespaced clients_, such as `Cat`, `Indices`, etc. The _namespaced clients_
are based on the grouping of APIs within the [Elasticsearch](https://github.com/elastic/elasticsearch/tree/main/rest-api-spec) and [X-Pack](https://github.com/elastic/elasticsearch/tree/main/x-pack/plugin/src/test/resources/rest-api-spec/api) REST API specs from which much of the client is generated.
are based on the grouping of APIs within the [Elasticsearch](https://github.com/elastic/elasticsearch/tree/main/rest-api-spec) REST API specs from which much of the client is generated.
All API functions are `async` only, and can be `await`ed.

### Installing
Expand Down Expand Up @@ -159,6 +161,8 @@ fn main() -> Result<(), Error> {
}
```

You can also configure the list of nodes of an Elasticsearch cluster using the `MultiNodeConnectionPool`, and the client will do a round-robin load balancing among those nodes. It can also periodically re-seed the list of nodes by querying the cluster.

### Making API calls

The following will execute a `POST` request to `/_search?allow_no_indices=true` with
Expand Down

0 comments on commit e6e2f02

Please sign in to comment.