Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yugabytedb-samples/yugabyte-simple-csharp-app
A simple C# application that connects to a YugabyteDB database cluster and performs basic CRUD operations.
https://github.com/yugabytedb-samples/yugabyte-simple-csharp-app
demos
Last synced: about 6 hours ago
JSON representation
A simple C# application that connects to a YugabyteDB database cluster and performs basic CRUD operations.
- Host: GitHub
- URL: https://github.com/yugabytedb-samples/yugabyte-simple-csharp-app
- Owner: YugabyteDB-Samples
- License: apache-2.0
- Created: 2022-02-10T16:27:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T16:32:03.000Z (4 months ago)
- Last Synced: 2024-07-16T20:26:54.100Z (4 months ago)
- Topics: demos
- Language: C#
- Homepage:
- Size: 195 KB
- Stars: 3
- Watchers: 66
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple C# Application for YugabyteDB
This application connects to your YugabyteDB instance via the
[Npgsql](https://docs.yugabyte.com/latest/reference/drivers/ysql-client-drivers/#npgsql) driver for PostgreSQL and performs basic SQL operations. The instructions below are provided for [YugabyteDB Aeon](https://cloud.yugabyte.com/) deployments.
If you use a different type of deployment, then update the `sample-app.cs` file with proper connection parameters.
## Prerequisites
* [.NET 6.0 SDK](https://dotnet.microsoft.com/en-us/download) or later version.
* Command line tool or your favourite IDE, such as Visual Studio Code.
## Start YugabyteDB Aeon Cluster
* [Start YugabyteDB Aeon](https://docs.yugabyte.com/latest/yugabyte-cloud/cloud-quickstart/qs-add/) instance. You can use
the free tier at no cost.
* Add an IP address of your machine/laptop to the [IP allow list](https://docs.yugabyte.com/latest/yugabyte-cloud/cloud-secure-clusters/add-connections/#manage-ip-allow-lists)
## Clone Application Repository
Clone the repository and change dirs into it:
```bash
git clone https://github.com/YugabyteDB-Samples/yugabyte-simple-csharp-app.git && cd yugabyte-simple-csharp-app
```
## Provide Cluster Connection Parameters
Locate and define the following connection parameters in the `sample-app.cs` file:
* `urlBuilder.Host` - the hostname of your instance.
* `urlBuilder.Username` - the username for your instance.
* `urlBuilder.Password` - the database password.
* `urlBuilder.SslMode` - make sure it's set to `SslMode.VerifyFull`.
* `urlBuilder.RootCertificate` - a full path to your CA root cert (for example, `/Users/dmagda/certificates/root.crt`).
Note, you can easily find all the settings on the YugabyteDB Aeon dashboard:
## Run the Application
Build and run the application:
```bash
dotnet run
```
Upon successful execution, you will see output similar to the following:
```bash
>>>> Connecting to YugabyteDB!
>>>> Successfully connected to YugabyteDB!
>>>> Successfully created table DemoAccount.
>>>> Selecting accounts:
name = Jessica, age = 28, country = USA, balance = 10000
name = John, age = 28, country = Canada, balance = 9000
>>>> Transferred 800 between accounts
>>>> Selecting accounts:
name = Jessica, age = 28, country = USA, balance = 9200
name = John, age = 28, country = Canada, balance = 9800
```
## Explore Application Logic
Congrats! You've successfully executed a simple C# app that works with YugabyteDB.
Now, explore the source code of `sample-app.cs`:
1. `connect` function - establishes a connection with your cloud instance via the Npgsql driver.
2. `createDatabase` function - creates a table and populates it with sample data.
3. `selectAccounts` function - queries the data with SQL `SELECT` statements.
4. `transferMoneyBetweenAccounts` function - updates records consistently with distributed transactions.
## Questions or Issues?
Having issues running this application or want to learn more from Yugabyte experts?
Join [our Slack channel](https://communityinviter.com/apps/yugabyte-db/register),
or raise a question on StackOverflow and tag the question with `yugabytedb`!