Session Class |
Each session maintains multiple connections to the cluster nodes, provides policies to choose which node to use for each query (round-robin on all nodes of the cluster by default), and handles retries for failed query (when it makes sense), etc...
Session instances are thread-safe and usually a single instance is enough per application. However, a given session can only be set to one keyspace at a time, so one instance per keyspace is necessary.
Inheritance HierarchyCassandraSession
Namespace: Cassandra
Assembly: Cassandra (in Cassandra.dll) Version: 3.11.0
Syntaxpublic class Session : ISession, IDisposable
The Session type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BinaryProtocolVersion | |
| Cluster |
Gets the cluster information and state
|
| Configuration |
Gets the cluster configuration
|
| IsDisposed |
Determines if the session is already disposed
|
| Keyspace |
Gets or sets the keyspace
|
| Policies | |
| UserDefinedTypes |
Gets the user defined type mappings
|
Methods| Name | Description | |
|---|---|---|
 | BeginExecute(IStatement, AsyncCallback, Object) |
Begins asynchronous execute operation.
|
| BeginExecute(String, ConsistencyLevel, AsyncCallback, Object) |
Begins asynchronous execute operation
|
| BeginPrepare |
Begins asynchronous prepare operation
|
| ChangeKeyspace |
Switches to the specified keyspace.
|
| CreateKeyspace |
Creates new keyspace in current cluster.
|
| CreateKeyspaceIfNotExists |
Creates new keyspace in current cluster.
If keyspace with specified name already exists, then this method does nothing.
|
| DeleteKeyspace |
Deletes specified keyspace from current cluster.
If keyspace with specified name does not exist, then exception will be thrown.
|
| DeleteKeyspaceIfExists |
Deletes specified keyspace from current cluster.
If keyspace with specified name does not exist, then this method does nothing.
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| EndExecute |
Ends asynchronous execute operation
|
| EndPrepare |
Ends asynchronous prepare operation
|
| Execute(String) |
Executes the provided query.
|
| Execute(IStatement) |
Executes the provided query.
|
| Execute(String, ConsistencyLevel) |
Executes the provided query.
|
| Execute(String, Int32) |
Executes the provided query.
|
| Execute(String, String) |
Executes the provided query with the provided execution profile.
The execution profile must have been added previously to the Cluster using WithExecutionProfiles(ActionIExecutionProfileOptions).
|
| Execute(IStatement, String) |
Executes the provided statement with the provided execution profile.
The execution profile must have been added previously to the Cluster using WithExecutionProfiles(ActionIExecutionProfileOptions).
|
| ExecuteAsync(IStatement) |
Executes a query asynchronously
|
| ExecuteAsync(IStatement, String) |
Executes a query asynchronously with the provided execution profile.
The execution profile must have been added previously to the Cluster using WithExecutionProfiles(ActionIExecutionProfileOptions).
|
| Prepare(String) |
Prepares the provided query string.
|
| Prepare(String, IDictionaryString, Byte) |
Prepares the query string, sending the custom payload request.
|
| PrepareAsync(String) |
Prepares the provided query string asynchronously.
|
| PrepareAsync(String, IDictionaryString, Byte) |
Prepares the provided query string asynchronously, and sending the custom payload request.
|
| WaitForSchemaAgreement(IPEndPoint) | |
| WaitForSchemaAgreement(RowSet) |
Extension Methods| Name | Description | |
|---|---|---|
 | CreateBatch | Overloaded. (Defined by SessionExtensions.) |
| CreateBatch(BatchType) | Overloaded. (Defined by SessionExtensions.) |
| GetState |
Gets a snapshot containing information on the connections pools held by this Client at the current time.
(Defined by Extensions.)The information provided in the returned object only represents the state at the moment this method was called and it's not maintained in sync with the driver metadata. |
| GetTableTEntity | Extension method used for backward-compatibility, use TableTEntity(ISession) constructor instead. Creates a new instance of the Linq IQueryProvider that represents a table in Cassandra using the mapping configuration provided. Fluent configuration or attributes can be used to define mapping information. |
See Also