In this section, you will find detailed instructions on how to embed SurrealDB into your application depending on your programming language.
The purpose of this section is to guide you through the process of embedding SurrealDB, ensuring that you have all the necessary dependencies and configurations in place to start using SurrealDB effectively.
Whether you are a beginner getting started with SurrealDB or an experienced user looking to set up SurrealDB in a new environment, this section will provide you with step-by-step instructions and best practices to ensure a smooth embedding process.
The following languages are supported:
When embedding SurrealDB in web browsers, you have two options:
IndexedDB: SurrealDB can be configured to use IndexedDB to store and persist data within the web browser. SurrealDB first serializes both keys and values into a Uint8Array, utilizing IndexedDB as a binary key-value store - offering good performance, and with the ability to offer all of the functionality and features that SurrealDB offers when running in alternative ways.
SDK: Alternatively, you can use the SurrealDB SDK to connect to a remote SurrealDB instance instead of using IndexedDB for local persistence.