SurrealDB
Connect TableR to SurrealDB over its HTTP API with a namespace, optional sign-in credentials or a bearer token, verify the connection, and troubleshoot — via the surrealdb-driver plugin.
SurrealDB is reached over its HTTP API — the connection is provided by the surrealdb-driver plugin (install it from the plugins page). Provide the host, pick a namespace/database, and authenticate with a user/password pair or a token alone.
Overview
TableR calls SurrealDB's HTTP /sql endpoint and queries with SurrealQL. The host field accepts a plain host (with the port appended) or a full gateway URL. Authentication is flexible: username + password signs in with Basic auth, while a password alone is sent as a Bearer token.
- HTTP /sql — connects to the SurrealDB HTTP endpoint (default port 8000); full URLs work too.
- Two auth modes — username + password for sign-in, or password alone as a Bearer token.
- Namespace + database — the namespace extra field (ns) and the database field scope your data.
- Plugin-gated — the SurrealDB card appears once the surrealdb-driver plugin is installed.
Before you start
- The surrealdb-driver plugin installed (Plugins → SurrealDB → Install).
- The SurrealDB host and port (default 8000), or a full gateway URL.
- A namespace and database to work in.
- Credentials: a user/password pair, or just a token in the password field.
Connection fields
These fields match TableR's SurrealDB connection form. The password or token is stored in the operating system keyring, never in plain configuration files.
| Field | Required | Default | Notes |
|---|---|---|---|
| Host | Yes | — | The SurrealDB host, or a full gateway URL including scheme. |
| Port | No | 8000 | The HTTP port; ignored when the host is a full URL. |
| Username | No | — | Sign-in user; paired with the password for Basic auth. |
| Password | No | — | Sign-in password — or a Bearer token when the username is empty. Stored in the OS keyring. |
| Namespace | No | — | The SurrealDB namespace (the ns extra field). |
| Database | No | — | The database inside the namespace. |
| SSL/TLS | No | Off | Enable for HTTPS endpoints. |
Connect with the form
- 1Install the SurrealDB plugin
Open Plugins, find SurrealDB, and install the surrealdb-driver plugin.
- 2Choose SurrealDB
Open the launcher and pick the SurrealDB card.
- 3Enter host and port
Use your SurrealDB host and port (8000), or paste a full gateway URL.
- 4Set namespace and database
Use the ns extra field for the namespace and the Database field for the database.
- 5Add credentials
Username + password for sign-in, or just the password field for a Bearer token.
- 6Save and connect
Save the profile so it reappears in the launcher, then connect.
Verify the connection
Once connected, open a query tab and run SurrealQL:
SELECT * FROM your_table LIMIT 10;
INFO FOR DB;If rows and the database info return, the endpoint, credentials, and namespace are correct.
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
| SurrealDB card missing | The surrealdb-driver plugin is not installed. | Open Plugins and install the SurrealDB driver, then retry. |
| SurrealDB host is required | The host field is empty. | Enter the SurrealDB host or a full gateway URL. |
| IAM / authentication error | Wrong credentials or token, or missing sign-in scope. | Re-check the user/password or token; confirm the account can access the namespace. |
| Connection refused | Server down, wrong port, or a firewall. | Confirm SurrealDB is running and the HTTP port is reachable. |
| Namespace or database not found | Wrong ns or database value. | Check the namespace (ns field) and database names. |