Connect the C# driver to your database

This driver supports the vector and non-vector data types.

DataStax recommends the Data API and clients for Serverless (Vector) databases. You can use the Data API to perform CQL operations on your table data in Serverless (Vector) databases.

DataStax recommends drivers only for Serverless (Non-Vector) databases, existing applications that previously used a CQL-based driver, or if you need to use some CQL functions that aren’t supported by the Data API. For more information, see Connection methods comparison.

This example creates a new C# project and configures it to connect to your Serverless (Non-Vector) database. It adds dependencies, connection code, and code to run a CQL query and print the output to the console.

Prerequisites

Connect to your database

  1. Create a new C# project and configure it to connect to your Cassandra database:

    mkdir csharpproject
    cd csharpproject
    dotnet new console
  2. Add the C# driver Latest CassandraCSharpDriver release on NuGet dependencies to your project.

    dotnet add package CassandraCSharpDriver -v <version>
  3. Replace the code in Program.cs with the following code to connect to your Serverless (Non-Vector) database.

    In the WithCloudSecureConnectionBundle method call, include the absolute path to your Serverless (Non-Vector) database’s SCB file (secure-connect-DATABASE_NAME.zip). In the WithCredentials method call, include your credentials.

    using System;
    using System.Linq;
    using Cassandra;
    
    namespace csharpproject
    {
        class Program
        {
            static void Main(string[] args)
            {
                var session =
                    Cluster.Builder()
                           .WithCloudSecureConnectionBundle(@"/SECURE_CONNECT_BUNDLE_PATH/secure-connect-DATABASE_NAME.zip")
                           .WithCredentials("clientId", "clientSecret")
                           .Build()
                           .Connect();
            }
        }
    }
  4. After the connection code, add the following code to the Main method in Program.cs. This code runs a CQL query and prints the output to the console.

    var rowSet = session.Execute("select * from system.local");
    Console.WriteLine(rowSet.First().GetValue<string>("cluster_name"));
  5. Run your C# project with the dotnet runtime:

    dotnet restore
    dotnet build
    dotnet run --no-build

For installation and data migration instructions, see the C# driver quickstart.

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com