The following projects can be used to implement C# applications using the YugabyteDB YSQL API.

Supported projects

Project Documentation and Guides Latest Driver Version Supported YugabyteDB Version
PostgreSQL Npgsql Driver Documentation
Hello World App
Reference Page
6.0.3 2.6 and above
Project Documentation and Guides Example Apps
Entity Framework ORM Documentation Hello World App

Learn how to establish a connection to a YugabyteDB database and begin basic CRUD operations using the Hello World examples.

For fully-runnable code snippets and explanations of common operations, see the example apps. Before running the example apps, make sure you have installed the prerequisites.

For reference documentation, including using projects with SSL, refer to the drivers and ORMs reference pages.

Prerequisites

To develop C# applications for YugabyteDB, you need the following:

  • .NET SDK
    Install .NET SDK 6.0 or later. To download it for your supported OS, visit Download .NET.

  • Create a C# project
    For ease-of-use, use an integrated development environment (IDE) such as Visual Studio. To download and install Visual Studio, visit the Visual Studio Downloads page.

    • To create a C# project in Visual Studio, select Console Application as template when creating a new project.

    • If you are not using an IDE, use the dotnet command:

      dotnet new console -o new_project_name
      
  • YugabyteDB cluster