This is the repository for developing the Airbyte SurrealDB destination connector.
The actual connector code is located in the destination-surrealdb directory, which will eventually be contributed to connectors in the Airbyte repository.
You can pull and use the published images:
# Pull latest multi-architecture image
docker pull ghcr.io/surrealdb/airbyte-destination-surrealdb:latest
# Pull specific version
docker pull ghcr.io/surrealdb/airbyte-destination-surrealdb:v0.1.0
# Pull specific commit
docker pull ghcr.io/surrealdb/airbyte-destination-surrealdb:a1b2c3dWe have two options for developing the connector:
Connector testing with local Airbyte instance
You can reopen this repository by clicking Reopen in Container on VS Code or Cursor, and run make airbyte-dev to install Airbyte and airbyte-ci dependencies within the dev env.
It will then print a comprehensive set of instructions for getting started with the connector testing.
See devcontainer.md for more details.
Connector development
There's a separate devcontainer under the destination-surrealdb directory.
Open the directory in VS Code or Cursor, do Reopen in Container, and you can run poetry run python -m pytest to run the tests.
To get started, install nix and run make develop- it will clone the Airbyte repository, run nix develop, activate a venv, and install Airbyte and airbyte-ci dependencies within the dev env.
You can then cd airbyte and run various airbyte-ci commands to test the SurrealDB connector and even other connectors.
Note that you must copy docs/integrations/surrealdb{-migrations,}.md files to airbyte/docs/integrations so let the connector passing some airbyte-ci acceptance test cases.
Roadmap:
- Implement the destination connector destination_surrealdb
- Documentation docs
- Container image for the connector (Run
airbyte-ci buildto build the image) - Unit tests unit_test
- Integration test data integration_tests
- Integration test cases
- Submit a pull request to the Airbyte repository
- Be a partner certified destination