.NET SDK

The SurrealDB SDK for C# and .NET enables you to interact with SurrealDB from server-side applications, systems, and APIs, allowing you to integrate SurrealDB into your website or application backend, and serve dynamic content to your users. You can use the .NET SDK to interact with your SurrealDB database instances, or to run SurrealDB as an embedded database within your C# application, with functionality for executing queries, managing data, running database functions, authenticating to the database, building user signup and authentication functionality, and subscribing to data changes with live queries. When connecting to remote database instances, connections automatically reconnect when terminated.

Important

The SDK requires either .NET version 6.0 or greater or .NET Standard 2.1 or higher. The SDK is available as a NuGet package.

Note

The latest version of the SDK is 0.9.0. The SDK works seamlessly with SurrealDB versions v2.0.0 to v3.0.4, ensuring compatibility with the latest version.

Warning

This API is not yet fully stabilized and may be subject to change until the SDK reaches 1.0.0.

To contribute to the SDK code, submit an Issue or Pull Request in the surrealdb.net repository. To contribute to this documentation, submit an Issue or Pull Request in the docs.surrealdb.com repository.

Example projects

You can find example repositories that demonstrate how to integrate SurrealDB in a number of different environments:

Console App

A simple Console app example using the .NET SDK for SurrealDB.

Minimal APIs

A simple ASP.NET API example project using Minimal APIs.

Blazor Server

A Blazor Server app example querying data and consuming Live Query from a remote database.