Skip to content

Commit

Permalink
Update documentation as per review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
darshan-lukhi committed Jun 8, 2024
1 parent 0611c5c commit 1b99ad9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
[![License](https://img.shields.io/badge/license-Apache--2.0-purple.svg?style=flat)](LICENSE.txt)
[![Status](https://img.shields.io/badge/status-alpha-yellow.svg?style=flat)](./readme.md)

The Hasura Elasticsearch Connector allows for connecting to a Elasticsearch search engine, giving you an instant
GraphQL API on top of your Elasticsearch data.
With this connector, Hasura allows you to instantly create a real-time GraphQL API on top of your documents in Elasticsearch. This connector supports Elasticsearch functionalities listed in the table below, allowing for efficient and scalable data operations. Additionally, you will benefit from all the powerful features of Hasura’s Data Delivery Network (DDN) platform, including query pushdown capabilities that delegate all query operations to the Elasticsearch, thereby enhancing query optimization and performance.

This connector is built using the [Go Data Connector SDK](https://github.com/hasura/ndc-sdk-go) and implements the [Data Connector Spec](https://github.com/hasura/ndc-spec).

Expand Down
10 changes: 5 additions & 5 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Elasticsearch Connector takes a `QueryRequest`, which contains information a

### Components

The architecture of the Elasticsearch Connector is composed of three main components:
The connector has three main components:

1. **prepareElasticsearchQuery**
2. **Search**
Expand Down Expand Up @@ -37,8 +37,8 @@ func prepareElasticsearchQuery(
Executes the DSL query against Elasticsearch and returns results.

**Functionality:**
- Execute the query on the Elasticsearch index.
- Fetch raw search results.
- Execute queries on the specified Elasticsearch index.
- Fetch search results.

**API:**

Expand All @@ -55,8 +55,8 @@ func (e *Client) Search(
Converts Elasticsearch search results into `QueryResponse`.

**Functionality:**
- Traverse through each field in the Elasticsearch response.
- Construct and return the `QueryResponse`, ensuring it aligns with the expected fields.
- Traverse each field in the Elasticsearch response.
- Construct and return the QueryResponse, ensuring it conforms to the expected fields.

**API:**

Expand Down

0 comments on commit 1b99ad9

Please sign in to comment.