Skip to main content

SurrealDB integration

SurrealDB is a cloud-hosted NoSQL database.

To integrate SurrealDB to Windmill, you need to save the following elements as a resource.

Add SurrealDB Resource

PropertyTypeDescriptionRequiredWhere to find
namespacestringNamespace for the SurrealDB instancetrueSurrealDB Dashboard -> Namespaces
databasestringDatabase name for the SurrealDB instancetrueSurrealDB Dashboard -> Databases
scopestringScope of the SurrealDB instancetrueSurrealDB Dashboard -> Scopes
userstringUsername for the SurrealDB instancefalseSurrealDB Dashboard -> Users
passstringPassword for the SurrealDB instancefalseSurrealDB Dashboard -> Users
urlstringURL of the SurrealDB instancefalseProvided by SurrealDB when you create the instance

Your resource can be passed as a parameter or fetched directly within scripts, flows, low-code apps and full-code apps.

tip

Feel free to create your own SurrealDB scripts on Windmill.