Weaviate
Connect TableR to Weaviate over its REST/GraphQL API with an optional API key and TLS, verify the connection, and troubleshoot — via the weaviate-driver plugin.
Weaviate is reached over its REST and GraphQL APIs — the connection is provided by the weaviate-driver plugin (install it from the plugins page). Provide the host and, for secured instances, an API key.
Overview
TableR talks to Weaviate over HTTP/HTTPS — REST for schema/meta and GraphQL for queries — and browses classes like tables. Authentication is an optional API key sent as a Bearer token (password field or the api_key extra field). TLS, custom CA certificates, and mTLS client certificates are supported for secured deployments.
- REST + GraphQL — schema and data are read over HTTP(S); classes appear as tables.
- API key auth — the password field or api_key extra field is sent as a Bearer token.
- Single schema — Weaviate exposes one schema; leave the database field empty or set it to default.
- Plugin-gated — the Weaviate card appears once the weaviate-driver plugin is installed.
Before you start
- The weaviate-driver plugin installed (Plugins → Weaviate → Install).
- The Weaviate host and port (8080 self-hosted, 443 on Weaviate Cloud).
- An API key when the instance requires authentication.
- TLS enabled for remote/cloud instances.
Connection fields
These fields match TableR's Weaviate connection form. The API key is stored in the operating system keyring, never in plain configuration files.
| Field | Required | Default | Notes |
|---|---|---|---|
| Host | Yes | — | The Weaviate host; credentials cannot be embedded here. |
| Port | No | 8080 | The REST port; 443 when SSL/TLS is enabled. |
| Password | No | — | A Weaviate API key (or use the api_key extra field); stored in the OS keyring. |
| Database | No | — | Must be empty or 'default' — Weaviate exposes a single schema. |
| SSL/TLS | No | Off | Enable for HTTPS; supports custom CA and mTLS client certificates. |
Connect with the form
- 1Install the Weaviate plugin
Open Plugins, find Weaviate, and install the weaviate-driver plugin.
- 2Choose Weaviate
Open the launcher and pick the Weaviate card.
- 3Enter host and port
Use your Weaviate host and port (8080 or 443).
- 4Add the API key
Paste it into the password field (or the api_key extra field); it is saved to the keyring.
- 5Enable SSL/TLS for remote
Turn on TLS for cloud or remote instances; add CA or client certs if needed.
- 6Save and connect
Save the profile so it reappears in the launcher, then connect.
Verify the connection
Once connected, classes appear as tables; ping hits the meta endpoint:
GET /v1/meta
GET /v1/schemaIf the meta and schema responses return, the endpoint, TLS, and API key are all correct.
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
| Weaviate card missing | The weaviate-driver plugin is not installed. | Open Plugins and install the Weaviate driver, then retry. |
| Weaviate credentials cannot be embedded in the host | The host contains user:pass@. | Move the API key to the password or api_key field and keep the host clean. |
| Weaviate exposes a single schema | The database field is set to a name other than 'default'. | Leave the database empty or set it to 'default'. |
| 401 / unauthorized | Missing or wrong API key. | Add a valid API key; it is saved to the keyring. |
| Connection refused | Instance down, wrong port, or a firewall. | Confirm Weaviate is up and the REST port is reachable. |