ICluster Interface

Informations and known state of a Cassandra cluster.

This is the main entry point of the driver. A simple example of access to a Cassandra cluster would be:

 Cluster cluster = Cluster.Builder.AddContactPoint("192.168.0.1").Build(); 
             Session session = Cluster.Connect("db1"); 
             foreach (var row in session.execute("SELECT * FROM table1")) 
               //do something ...

A cluster object maintains a permanent connection to one of the cluster node that it uses solely to maintain informations on the state and current topology of the cluster. Using the connection, the driver will discover all the nodes composing the cluster as well as new nodes joining the cluster.

Namespace: Cassandra
Assembly: Cassandra (in Cassandra.dll) Version: 3.11.0

Syntax

Copy

public interface ICluster : IDisposable

The ICluster type exposes the following members.

Properties

	Name	Description
	Configuration	Cluster client configuration
	Metadata	Gets read-only metadata on the connected cluster. This includes the know nodes (with their status as seen by the driver) as well as the schema definitions. This method may trigger the creation of a connection if none has been established yet.

Top

Methods

	Name	Description
	AllHosts	Returns all known hosts of this cluster.
	Connect	Creates a new session on this cluster.
	Connect(String)	Creates a new session on this cluster and sets a keyspace to use.
	ConnectAsync	Creates a new session on this cluster.
	ConnectAsync(String)	Creates a new session on this cluster and using a keyspace an existing keyspace.
	GetHost	Get the host instance for a given Ip address.
	GetReplicas(Byte)	Gets a collection of replicas for a given partitionKey. Backward-compatibility only, use GetReplicas(keyspace, partitionKey) instead.
	GetReplicas(String, Byte)	Gets a collection of replicas for a given partitionKey on a given keyspace
	RefreshSchema	Updates keyspace metadata (including token metadata for token aware routing) for a given keyspace or a specific keyspace table. If no keyspace is provided then this method will update the metadata and token map for all the keyspaces of the cluster.
	RefreshSchemaAsync	Updates keyspace metadata (including token metadata for token aware routing) for a given keyspace or a specific keyspace table. If no keyspace is provided then this method will update the metadata and token map for all the keyspaces of the cluster.
	Shutdown	Shutdown this cluster instance. This closes all connections from all the sessions of this * Cluster instance and reclaim all resources used by it. This method has no effect if the cluster was already shutdown.
	ShutdownAsync	Shutdown this cluster instance asynchronously. This closes all connections from all the sessions of this * Cluster instance and reclaim all resources used by it. This method has no effect if the cluster was already shutdown.

Top

Events

	Name	Description
	HostAdded	Event that gets triggered when a new host is added to the cluster
	HostRemoved	Event that gets triggered when a host has been removed from the cluster

Top

Reference

Cassandra Namespace