Class CqlConnection

Represents a CQL connection.

Inheritance
object
MarshalByRefObject
Component
DbConnection
CqlConnection
Implements
Inherited Members
Namespace: Cassandra.Data
Assembly: Cassandra.dll
Syntax
public class CqlConnection : DbConnection, IComponent, IDbConnection, IDisposable, ICloneable

Constructors

CqlConnection()

Initializes a CqlConnection.

Declaration
public CqlConnection()

CqlConnection(string)

Initializes a CqlConnection.

Declaration
public CqlConnection(string connectionString)
Parameters
Type Name Description
string connectionString

The connection string.

Fields

ManagedConnection

Declaration
protected ISession ManagedConnection
Field Value
Type Description
ISession

Properties

ConnectionString

Declaration
public override string ConnectionString { get; set; }
Property Value
Type Description
string
Overrides

DataSource

Declaration
public override string DataSource { get; }
Property Value
Type Description
string
Overrides

Database

Returns the Keyspace

Declaration
public override string Database { get; }
Property Value
Type Description
string
Overrides

DbProviderFactory

Declaration
protected override DbProviderFactory DbProviderFactory { get; }
Property Value
Type Description
DbProviderFactory
Overrides

ServerVersion

Declaration
public override string ServerVersion { get; }
Property Value
Type Description
string
Overrides

State

Declaration
public override ConnectionState State { get; }
Property Value
Type Description
ConnectionState
Overrides

Methods

BeginDbTransaction(IsolationLevel)

Declaration
protected override DbTransaction BeginDbTransaction(IsolationLevel isolationLevel)
Parameters
Type Name Description
IsolationLevel isolationLevel
Returns
Type Description
DbTransaction
Overrides

ChangeDatabase(string)

Declaration
public override void ChangeDatabase(string databaseName)
Parameters
Type Name Description
string databaseName
Overrides

Clone()

Declaration
public object Clone()
Returns
Type Description
object

Close()

Declaration
public override void Close()
Overrides

CreateCluster(CassandraConnectionStringBuilder)

Creates a Cluster. By default Clusters are created and cached by cluster name specified in connection string.

To be overridden in child classes to change the default creation and caching behavior.

Declaration
protected virtual Cluster CreateCluster(CassandraConnectionStringBuilder connectionStringBuilder)
Parameters
Type Name Description
CassandraConnectionStringBuilder connectionStringBuilder

The CassandraConnectionStringBuilder.
Returns
Type Description
Cluster

CreateDbCommand()

Declaration
protected override DbCommand CreateDbCommand()
Returns
Type Description
DbCommand
Overrides

CreatePreparedStatement(string)

To be called by CqlCommand to creates a PreparedStatement from ManagedConnection.

To be overridden in child classes if want to cache the PreparedStatement created.

Declaration
protected virtual PreparedStatement CreatePreparedStatement(string cqlQuery)
Parameters
Type Name Description
string cqlQuery

The CQL query string.
Returns
Type Description
PreparedStatement

Returns the created PreparedStatement.

CreatedSession(string)

Creates a ISession.

To be overridden in child classes if want to cache the ISession created.

Declaration
protected virtual ISession CreatedSession(string keyspace)
Parameters
Type Name Description
string keyspace

The keyspace.
Returns
Type Description
ISession

Returns the created ISession.

Dispose(bool)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides

OnBuildingCluster(Builder)

To be overridden in child classes to change the default Builder settings for building a Cluster.

For example, some clients might want to specify the DCAwareRoundRobinPolicy when building the Cluster so that the clients could talk to only the hosts in specified datacenter for better performance.

Declaration
protected virtual void OnBuildingCluster(Builder builder)
Parameters
Type Name Description
Builder builder

The Builder for building a Cluster.

Open()

Declaration
public override void Open()
Overrides

Implements