Airbyte
This guide helps you configure SurrealDB as a destination in Airbyte using the official connector.
Prerequisites
To connect SurrealDB to Airbyte, you need the following:
- An Airbyte deployment with access to the SurrealDB destination connector.
- SurrealDB
v2.2.0 or later. - A SurrealDB instance (self-hosted or SurrealDB Cloud) reachable by Airbyte.
- Ensure your SurrealDB database can be accessed by Airbyte. If your database is within a VPC, you may need to allow access from the IP you’re using to expose Airbyte.
- A token or user credentials with
DEFINE TABLE, DEFINE INDEX, UPSERT, SELECT, and REMOVE permissions.
Setup instructions
Follow these steps to configure SurrealDB as a destination. You can use either a self-hosted instance or SurrealDB Cloud .
Before proceeding, ensure you have the endpoint URL and credentials for your SurrealDB instance and that Airbyte can reach it over the network.
Option 1: Self-hosted SurrealDB
- Ensure your SurrealDB instance is reachable from Airbyte. This might involve opening network access or configuring an SSH tunnel.
- Create a dedicated user or token in SurrealDB, for example:
DEFINE USER airbyte ON ROOT PASSWORD "YourPassword" ROLES OWNER;
Use the generated credentials when setting up the destination.
Option 2: SurrealDB Cloud
- Visit the Instances page and select your instance.
- Click Connect with Surreal CLI to obtain a connection command containing the
--endpoint and authentication details. - Verify you can connect using
surreal sql with those parameters.
Finish Airbyte configuration
- Open the Airbyte dashboard and add a new Destination.
- Select SurrealDB from the list of destination types.
- Provide the host, port, namespace, database, and either the username/password or token you created earlier.
- Click Set up destination and run the connection test.
Upon a successful test, you can start syncing data from your sources into SurrealDB tables. Each stream will be output into its own table in SurrealDB. Each table will contain 3 columns:
_airbyte_raw_id: a uuid assigned by Airbyte to each event that is processed. The column type in SurrealDB is string. The connector use this as the ID of each record in the destination SurrealDB table._airbyte_extracted_at: a timestamp representing when the event was pulled from the data source. The column type in SurrealDB is datetime._airbyte_data: a json blob representing with the event data. The column type in SurrealDB is object.
Known Limitations
SurrealDB destination forces all identifier (table, schema and columns) names to be lowercase.
