# .NET SDK

The SurrealDB SDK for .NET provides a number of methods for interacting with your SurrealDB database.

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 `8.0` or greater or .NET Standard `2.1` or higher.
> The SDK is available as a [NuGet package](https://www.nuget.org/packages/SurrealDb.Net).

> [!NOTE]
> The latest version of the SDK is `1.0.0`.
> The SDK works with SurrealDB versions `v2.0.0` and later, including the current release, `v3.2.4`.

## Getting started

- [Installation](/docs/reference/dotnet/installation.md) - Install the SDK and add it to your project.

- [Getting started guide](/docs/languages/dotnet.md) - Connect to SurrealDB and run your first queries.

## Learn

- [Concepts](/docs/reference/dotnet/core/create-a-new-connection.md) - Guides for connecting, authenticating, querying, and working with data.

- [API Reference](/docs/reference/dotnet/methods.md) - Complete reference for the SDK's methods, types, and errors.

## Example projects

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

- [Console App](https://github.com/surrealdb/surrealdb.net/tree/main/SurrealDb.Examples.Console) - A simple Console app example using the .NET SDK for SurrealDB.

- [Minimal APIs](https://github.com/surrealdb/surrealdb.net/tree/main/SurrealDb.Examples.MinimalApis) - A simple ASP.NET API example project using Minimal APIs.

- [Blazor Server](https://github.com/surrealdb/surrealdb.net/tree/main/SurrealDb.Examples.Blazor.Server) - A Blazor Server app example querying data and consuming Live Query from a remote database.

## Contributing

To contribute to the SDK code, submit an Issue or Pull Request in the [surrealdb.net](https://github.com/surrealdb/surrealdb.net) repository. To contribute to this documentation, submit an Issue or Pull Request in the [docs.surrealdb.com](https://github.com/surrealdb/docs.surrealdb.com) repository.

## Sources

- [GitHub repository](https://github.com/surrealdb/surrealdb.net)
- [NuGet package](https://nuget.org/packages/surrealdb.net)