Skip to content

Commit

Permalink
Updated the README to mention our ES compatibility story. (#4513)
Browse files Browse the repository at this point in the history
Closes #4511
  • Loading branch information
fulmicoton authored Feb 5, 2024
1 parent b630f9b commit d3b6242
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,19 @@ Cloud-native search engine for observability (logs, traces, and soon metrics!).

# 🙋 FAQ

### How can I switch from Elasticsearch to Quickwit?
### How can I switch from Elasticsearch or Opensearch to Quickwit?

Quickwit has an Elasticsearch-compatible Ingest-API to make it easier to migrate your log shippers (Vector, Fluent Bit, Syslog, ...) to Quickwit. However, we only support [ES aggregation DSL](https://quickwit.io/docs/reference/aggregation), the query DSL support is planned for Q2 2023.
Quickwit supports a large subset of Elasticsearch/Opensearch API.

For instance, it has a ES-compatible ingest API to make it easier to migrate your log shippers (Vector, Fluent Bit, Syslog, ...) to Quickwit.

On the search-side, the most popular Elasticsearch endpoints, query DSL, and even aggregations are supported.

The list of available endpoints and queries is available [here](https://quickwit.io/docs/reference/es_compatible_api), while the list of supported aggregations is available [here](https://quickwit.io/docs/reference/aggregation).

Let us know if part of the API you are using is missing!

If the client you are using is refusing to connect to Quickwit due to missing headers, you can use the `extra_headers` option in the [node configuration](https://quickwit.io/docs/configuration/node-config#rest-configuration) to impersonate any compatible version of Elasticsearch or Opensearch.

### How is Quickwit different from traditional search engines like Elasticsearch or Solr?

Expand Down

0 comments on commit d3b6242

Please sign in to comment.