DataStax C# Driver for Apache Cassandra

A modern, feature-rich and highly tunable C# client library for Apache Cassandra (1.2+) and DataStax Enterprise (3.1+) using exclusively Cassandra's binary protocol and Cassandra Query Language v3.

Installation

Get it on Nuget

PM> Install-Package CassandraCSharpDriver

Features

• Sync and Async API
• Simple, Prepared, and Batch statements
• Asynchronous IO, parallel execution, request pipelining
• Connection pooling
• Auto node discovery
• Automatic reconnection
• Configurable load balancing and retry policies
• Works with any cluster size
• Linq2Cql and Ado.Net support

Documentation

• Documentation index
• Getting started guide
• API docs

Getting Help

You can use the project Mailing list or create a ticket on the Jira issue tracker.

Upgrading from previous versions

If you are upgrading from the 2.1 branch of the driver, be sure to have a look at the upgrade guide.

If you are upgrading from the 1.x branch of the driver, follow the upgrade guide to 2.0, and then the above document.

Basic Usage

//Create a cluster instance using 3 cassandra nodes.varcluster=Cluster.Builder().AddContactPoints("host1","host2","host3").Build();//Create connections to the nodes using a keyspacevarsession=cluster.Connect("sample_keyspace");//Execute a query on a connection synchronouslyvarrs=session.Execute("SELECT * FROM sample_table");//Iterate through the RowSetforeach(varrowinrs){varvalue=row.GetValue<int>("sample_int_column");//do something with the value}

Prepared statements

Prepare your query once and bind different parameters to obtain best performance.

//Prepare a statement oncevarps=session.Prepare("UPDATE user_profiles SET birth=? WHERE key=?");//...bind different parameters every time you need to executevarstatement=ps.Bind(newDateTime(1942,11,27),"hendrix");//Execute the bound statement with the provided parameterssession.Execute(statement);

Batching statements

You can execute multiple statements (prepared or unprepared) in a batch to update/insert several rows atomically even in different column families.

//Prepare the statements involved in a profile update oncevarprofileStmt=session.Prepare("UPDATE user_profiles SET email=? WHERE key=?");varuserTrackStmt=session.Prepare("INSERT INTO user_track (key, text, date) VALUES (?, ?, ?)");//...you should reuse the prepared statement//Bind the parameters and add the statement to the batch batchvarbatch=newBatchStatement().Add(profileStmt.Bind(emailAddress,"hendrix")).Add(userTrackStmt.Bind("hendrix","You changed your email",DateTime.Now));//Execute the batchsession.Execute(batch);

Asynchronous API

Session allows asynchronous execution of statements (for any type of statement: simple, bound or batch) by exposing the ExecuteAsync method.

//Execute a statement asynchronously using awaitvarrs=awaitsession.ExecuteAsync(statement);

Avoid boilerplate mapping code

The driver features a built-in Mapper and Linq components that can use to avoid boilerplate mapping code between cql rows and your application entities.

Useruser=mapper.Single<User>("SELECT name, email FROM users WHERE id = ?",userId);

See the driver components documentation for more information.

Automatic pagination of results

You can iterate indefinitely over the RowSet, having the rows fetched block by block until the rows available on the client side are exhausted.

varstatement=newSimpleStatement("SELECT * from large_table");//Set the page size, in this case the RowSet will not contain more than 1000 at any timestatement.SetPageSize(1000);varrs=session.Execute(statement);foreach(varrowinrs){//The enumerator will yield all the rows from Cassandra//Retrieving them in the back in blocks of 1000.}

User defined types mapping

You can map your Cassandra User Defined Types to your application entities.

For a given udt

CREATETYPE address (
street text,
city text,
zip_code int,
phones set<text>
);

For a given class

publicclassAddress{publicstringStreet{get;set;}publicstringCity{get;set;}publicintZipCode{get;set;}publicIEnumerable<string>Phones{get;set;}}

You can either map the properties by name

//Map the properties by name automaticallysession.UserDefinedTypes.Define(UdtMap.For<Address>());

Or you can define the properties manually

session.UserDefinedTypes.Define(UdtMap.For<Address>().Map(a =>a.Street,"street").Map(a =>a.City,"city").Map(a =>a.ZipCode,"zip_code").Map(a =>a.Phones,"phones"));

You should map your UDT to your entity once and you will be able to use that mapping during all your application lifetime.

varrs=session.Execute("SELECT id, name, address FROM users where id = x");varrow=rs.First();//You can retrieve the field as a value of type AddressvaruserAddress=row.GetValue<Address>("address");Console.WriteLine("user lives on {0} Street",userAddress.Street);

Setting cluster and statement execution options

You can set the options on how the driver connects to the nodes and the execution options.

//Example at cluster levelvarcluster=Cluster.Builder().AddContactPoints(hosts).WithCompression(CompressionType.LZ4).WithLoadBalancingPolicy(newDCAwareRoundRobinPolicy("west"));//Example at statement (simple, bound, batch) levelvarstatement=newSimpleStatement(query).SetConsistencyLevel(ConsistencyLevel.Quorum).SetRetryPolicy(DowngradingConsistencyRetryPolicy.Instance).SetPageSize(1000);

Feedback Requested

Help us focus our efforts! Provide your input on the Platform and Runtime Survey (we kept it short).

Building and running the tests

You can use Visual Studio or msbuild to build the solution.

Check the documentation for building the driver from source and running the tests.

License

Copyright 2012-2015, DataStax.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.