Skip to content

Add SurrealDB destination connector #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mumoshu
Copy link

@mumoshu mumoshu commented Jun 6, 2025

Hi 👋 Here's the initial implementation of SurrealDB destination connector based on surrealdb.py!

I've verified this to work by running integration tests against a local SurrealDB instance run using the surreal command and also a remote, dockerized SurrealDB instance like:

uv sync --extra surrealdb --group test --group lint
uv run pytest --log-cli-level=DEBUG -sv test/integration/connectors/surrealdb

Note that:

  • The integration test runs against a local SurrealDB instance only if surreal command is available in $PATH. Please install it if you'd like the test to actually run.
  • The integration test runs against a remote SurrealDB instance only if assets/remote_config.json exists (It's disabled by default. Please refer to the included example remote_config.json in case you'd like to set up a sort of CI for this connector)
  • There are a bunch of diffs on uv.lock due to that I had to run uv sync --extra surrealdb to test the connector. Please feel free to modify it in any way you like. FWIW, I used uv 0.7.11.
  • This connector does not support embedded SurrealDB for now.

This is the initial implementation of SurrealDB destination connector based on [surrealdb.py](https://github.com/surrealdb/surrealdb.py)!

The integration tests cover local SurrealDB instances run from within pytest (in case `surreal` command is in PATH) and also
remote instances (in case `assets/remote_config.json` exists).

I've verified this to work by running integration tests like:

```
uv sync --extra surrealdb --group test --group lint
uv run pytest --log-cli-level=DEBUG -sv test/integration/connectors/surrealdb
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant