ContextQMD
Back to Yugabyte Db

Build a YugabyteDB YEDIS application using C#

docs/content/stable/yedis/develop/client-drivers/yedis/csharp.md

2026.1.0.0-b833.1 KB
Original Source

Prerequisites

This tutorial assumes that you have:

  • installed YugabyteDB, created a universe, and are able to interact with it using the Redis shell. If not, follow the steps in Quick start.
  • installed Visual Studio.

Write a HelloWorld C# application

In your Visual Studio create a new Project and choose Console Application as template. Follow the instructions to save the project.

Install StackExchange.Redis C# driver

To install the driver in your Visual Studio project:

<ol> <li>Open your Project Solution View.</li> <li>Right-click on Packages and click Add Packages.</li> <li>Search for StackExchange.Redis and click Add Package.</li> ![Search Package](/images/develop/client-drivers/csharp/visual-studio-search-redis-package.png) </ol>

Copy the contents below to your Program.cs file.

cs
using System;
using System.Collections.Generic;
using StackExchange.Redis;

namespace Yugabyte_CSharp_Demo
{
    class Program
    {
        static private void printHash(HashEntry[] hashes)
        {
            foreach (var hashEntry in hashes)
            {
                Console.WriteLine(string.Format("{0}: {1}", hashEntry.Name, hashEntry.Value));
            }
        }
        static void Main(string[] args)
        {
            try
            {
                ConfigurationOptions config = new ConfigurationOptions
                {
                    EndPoints =
                    {
                        { "127.0.0.1", 6379 },
                    },
                    CommandMap = CommandMap.Create(new HashSet<string>
                    {   // EXCLUDE commands that are not fully supported on YugabyteDB side.
                        "SUBSCRIBE", "CLUSTER", "TIME", "PING"
                    }, available: false)
                };

                ConnectionMultiplexer connection = ConnectionMultiplexer.Connect(config);
                IDatabase redisDB = connection.GetDatabase();
                var hashKey = "1";
                HashEntry[] setHash = {
                  new HashEntry("name", "John"),
                  new HashEntry("age", 35),
                  new HashEntry("language", "C#"),
                  new HashEntry("client", "Redis")
                };
                Console.WriteLine("Successfully executed HMSET:");
                printHash(setHash);
                redisDB.HashSet(hashKey, setHash);

                var getHash = redisDB.HashGetAll(hashKey);
                Console.WriteLine("Successfully executed HMGET:");
                printHash(getHash);
            }
            catch (RedisConnectionException e)
            {
                Console.WriteLine("Unable to make a connection to local YugabyteDB. " +
                                  "Error:", e.Message);
            }
        }
    }
}

Run the application

Run the C# application from menu select Run -> Start Without Debugging

You should see the following as the output.

Successfully executed HMSET:
name: John
age: 35
language: C#
client: Redis
Successfully executed HMGET:
age: 35
client: Redis
language: C#
name: John