Elasticsearch
Connect TableR to Elasticsearch over its REST API with TLS, optional basic auth, verify the connection, and troubleshoot — via the elasticsearch-driver plugin.
Elasticsearch is reached over its REST API — the connection is provided by the elasticsearch-driver plugin (install it from the plugins page). TLS is required for any non-loopback host.
Overview
TableR talks to the Elasticsearch REST endpoint over HTTP/HTTPS and browses indices like tables. The driver verifies the server reports Elasticsearch (via X-Elastic-Product) — an OpenSearch endpoint is refused with a hint to use the OpenSearch engine instead. Basic auth (username/password) is optional.
- REST API — connects over HTTP(S) to the cluster endpoint (default port 9200).
- TLS enforced — non-loopback hosts require SSL/TLS; only localhost may use plain HTTP.
- Product check — an endpoint that reports OpenSearch is rejected; use the OpenSearch card instead.
- Plugin-gated — the Elasticsearch card appears once the elasticsearch-driver plugin is installed.
Before you start
- The elasticsearch-driver plugin installed (Plugins → Elasticsearch → Install).
- The cluster host and port (default 9200, or 443 behind HTTPS).
- TLS enabled for any remote cluster (required).
- Optional: a username and password when the cluster enforces basic auth.
Connection fields
These fields match TableR's Elasticsearch connection form. The password is stored in the operating system keyring, never in plain configuration files.
| Field | Required | Default | Notes |
|---|---|---|---|
| Host | Yes | — | The Elasticsearch host; credentials cannot be embedded here. |
| Port | No | 9200 | The REST port; 443 when SSL/TLS is enabled. |
| Username | No | — | Optional basic-auth user (e.g. elastic). |
| 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 Elasticsearch plugin
Open Plugins, find Elasticsearch, and install the elasticsearch-driver plugin.
- 2Choose Elasticsearch
Open the launcher and pick the Elasticsearch card.
- 3Enter host and port
Use your cluster 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 cluster 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 |
|---|---|---|
| Elasticsearch card missing | The elasticsearch-driver plugin is not installed. | Open Plugins and install the Elasticsearch 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. |
| reports OpenSearch, not Elasticsearch | The endpoint is an OpenSearch cluster. | Connect with the OpenSearch engine instead. |
| 401 / unauthorized | Missing or wrong basic-auth credentials. | Add a valid username/password; the password is saved to the keyring. |
| Connection refused | Cluster down, wrong port, or a firewall. | Confirm the cluster is up and the REST port is reachable. |