Surrealism extensions

Available since: v3.0.0-beta

Note

Surrealism is currently in active development and is not yet stable. We are looking forward to any and all feedback on the plugin system, either via raising an issue or PR on the SurrealDB repo, or anywhere else in the SurrealDB community.

Surrealism is a feature that allows you to write your own extensions (plugins) for SurrealDB. They are written with Rust code that can then be compiled to Web Assembly and accessed inside a running SurrealDB instance.

Surrealism was built in order to allow users to extend SurrealDB in ways that benefit them, without needing to make any changes to the code of SurrealDB itself. Some potential use cases are:

• Adding functions to create fake / mock data for testing.
• Accessing functionality in Rust crates that are too specific to merge into SurrealDB itself, such as language-specific functionality, custom case conversions, or quantitative finance.
• Anything else you have built in your own code that you would like to access inside SurrealDB.

How Surrealism works

Surrealism works by using the following steps:

• The addition of a surrealism.toml file plus the #[surrealism] annotation over functions to expose.
• A CLI command compiles this code into a WASM binary.
• Statements inside SurrealDB to allow access to the file and to define a module holding the functions.

The next page contains a walkthrough to show how this process works.