Skip to main content

SurrealDB

Overview​

The SurrealDB destination connector lets you connect to a SurrealDB HTTP endpoint and validate credentials. Destination loading (writing data into SurrealDB) is not yet available.

Prerequisites​

  • A reachable SurrealDB HTTP endpoint.
  • A SurrealDB user with permission to access the target namespace and database.
  • Network access from your workspace to the SurrealDB endpoint.

Authentication​

This connector authenticates using HTTP Basic Auth (username + password) against SurrealDB’s SQL HTTP endpoint.

During credential validation, the connector sends a request to:

  • POST {endpoint}/sql

With headers:

  • surreal-ns: {namespace}
  • surreal-db: {database}

And a simple SQL body:

  • RETURN 1;

Configuration​

Provide the following fields when configuring the destination:

FieldTypeRequiredDescription
endpointstringyesBase URL for your SurrealDB HTTP endpoint. The connector will call the sql path under this endpoint. Example: http://localhost:8000
usernamestringyesSurrealDB username for Basic Auth.
passwordstringyesSurrealDB password for Basic Auth.
namespacestringyesSurrealDB namespace to use (sent as the surreal-ns header).
databasestringyesSurrealDB database to use (sent as the surreal-db header).

Data loading status​

This destination is currently in development. While connection and credential validation are supported, syncing/loading data into SurrealDB is not yet implemented.

If you attempt to run a sync, the connector will fail with an error indicating that destination loading is still in development.

Streams​

Not applicable yet. This destination does not currently write any streams/tables/records into SurrealDB.