# search-ui-engines-connector

Part of the [Search UI](https://github.com/elastic/search-ui) project.

This Connector is used to connect Search UI to Elasticsearch Engines.

## Usage

```shell
npm install --save @elastic/search-ui-engines-connector
```

```js
import EnginesConnector from "@elastic/search-ui-engines-connector";

const connector = new EnginesConnector({
  host: "https://my-engines-demo.ent.us-east4.gcp.elastic-cloud.com/",
  engineName: "puggles",
  apiKey: "QTJDMHhJVUJENHg5WETWcXlrWVQ6dXFlcF9QRWdRWHl2Rm9iSndka1Rndw=="
});
```

## EnginesConnector

**Kind**: global class

### new ElasticsearchAPIConnector(options)

| Param   | Type                             |
| ------- | -------------------------------- |
| options | [<code>Options</code>](#Options) |

## Options

**Kind**: global typedef

| Param      | Type                | Default | Description                                                     |
| ---------- | ------------------- | ------- | --------------------------------------------------------------- |
| host       | <code>string</code> |         | Engines Host.                                                   |
| engineName | <code>string</code> |         | The name of the engine to search                                |
| apiKey     | <code>string</code> |         | API Key for the engine. Can be found within the Engine view UI. |

## Query Configuration Requirements

- `search_fields` object is required with all fields you want to search by.