OpenSearch
Connect TableR to OpenSearch over its REST API with TLS, optional basic auth, verify the connection, and troubleshoot — via the opensearch-driver plugin.
OpenSearch is reached over its REST API — the connection is provided by the opensearch-driver plugin (install it from the plugins page). TLS is required for any non-loopback host.
Overview
TableR talks to the OpenSearch REST endpoint over HTTP/HTTPS and browses indices like tables. Basic auth (username/password) is optional; AWS OpenSearch domains typically sit behind HTTPS on port 443.
- REST API — connects over HTTP(S) to the domain endpoint (default port 9200).
- TLS enforced — non-loopback hosts require SSL/TLS; only localhost may use plain HTTP.
- Plugin-gated — the OpenSearch card appears once the opensearch-driver plugin is installed.
Before you start
- The opensearch-driver plugin installed (Plugins → OpenSearch → Install).
- The domain host and port (9200 self-hosted, 443 on AWS OpenSearch).
- TLS enabled for any remote host (required).
- Optional: a username and password when fine-grained access control is on.
Connection fields
These fields match TableR's OpenSearch connection form. The password is stored in the operating system keyring, never in plain configuration files.
| Field | Required | Default | Notes |
|---|---|---|---|
| Host | Yes | — | The OpenSearch host or AWS domain endpoint; no embedded credentials. |
| Port | No | 9200 | The REST port; 443 when SSL/TLS is enabled. |
| Username | No | — | Optional basic-auth user (e.g. admin). |
| Password | No | — | Optional basic-auth password; stored in the OS keyring. |
| SSL/TLS | No | Off | Required for non-loopback hosts; optional only for localhost. |
Connect with the form
- 1Install the OpenSearch plugin
Open Plugins, find OpenSearch, and install the opensearch-driver plugin.
- 2Choose OpenSearch
Open the launcher and pick the OpenSearch card.
- 3Enter host and port
Use your domain host and port (9200 or 443).
- 4Enable SSL/TLS
Required for any remote host; only localhost may stay on plain HTTP.
- 5Add credentials (optional)
Username and password when the domain enforces basic auth.
- 6Save and connect
Save the profile so it reappears in the launcher, then connect.
SSL/TLS
Driver plugins require TLS for non-loopback hosts — the connection is refused without it. Keep SSL/TLS on for anything that is not localhost.
- Off — plain HTTP, localhost only.
- On — HTTPS to the REST endpoint on port 443 (or your TLS port).
Verify the connection
Once connected, indices appear as tables; ping runs a root request:
GET /
GET _cat/indices?vIf the cluster name/version and the index list return, the endpoint, TLS, and credentials are correct.
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
| OpenSearch card missing | The opensearch-driver plugin is not installed. | Open Plugins and install the OpenSearch driver, then retry. |
| driver plugins require TLS for non-loopback hosts | SSL/TLS is off for a remote host. | Enable SSL/TLS — only localhost may use plain HTTP. |
| 401 / unauthorized | Missing or wrong basic-auth credentials. | Add a valid username/password; the password is saved to the keyring. |
| Connection refused | Domain down, wrong port, or a firewall/security group. | Confirm the domain is up and the REST port is reachable. |