Categorygithub.com/nickchomey/conduit-connector-surrealdb
repositorypackage
0.0.0-20250101211458-fb5486d1b143
Repository: https://github.com/nickchomey/conduit-connector-surrealdb.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

Conduit Connector for

Conduit connector for SurrealDB.

How to build?

Run make build to build the connector, or make build-debug if you want to step debug it.

Testing

Note, currently there are no tests

Run make test to run all the unit tests. Run make test-integration to run the integration tests.

The Docker compose file at test/docker-compose.yml can be used to run the required resource locally.

Configuration

namedescriptionrequireddefault value
URLURL is the connection string for the SurrealDB server.true""
UsernameUsername is the username for the SurrealDB server.true""
PasswordPassword is the password for the SurrealDB server.true""
NamespaceNamespace is the namespace for the SurrealDB server.true""
DatabaseDatabase is the database name for the SurrealDB server.true""
ScopeScope is the scope for the SurrealDB server.true""

Source

There is currently no Source connector

Destination

A destination connector pushes data from upstream resources to an external resource via Conduit.

namedescriptionrequireddefault value
DeleteOldKeyPrimary key will be set to "id". Specify whether you want to keep the source Primary Key column as well.falsefalse

Known Issues & Limitations

  • Batching doesn't work for Create, Update and Delete operations, as surrealdb doesn't have bulk mechanisms for those. Only Snapshot has batching. But the connector is built to easily implement batching when it becomes possible

Planned work

  • Item A
  • Item B