DseCluster Class

Information and known state of a DSE cluster.

This is the main entry point of the DSE driver. It extends the CQL driver's ICluster instance with DSE-specific features.

Inheritance Hierarchy

SystemObject
DseDseCluster

Namespace: Dse
Assembly: Dse (in Dse.dll) Version: 2.9.0

Syntax

Copy

public class DseCluster : IDseCluster, ICluster, 
	IDisposable

The DseCluster type exposes the following members.

Properties

	Name	Description
	Configuration	Gets the DSE 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.
	AnyOpenConnections
	Builder	Creates a new DseClusterBuilder instance.
	Connect	Creates a new IDseSession for this cluster.
	Connect(String)	Creates a new IDseSession for this cluster to a specific keyspaces.
	ConnectAsync	Asynchronously creates a new session on this cluster.
	ConnectAsync(String)	Asynchronously creates a new session on this cluster and using a keyspace an existing keyspace.
	Dispose	Calls Shutdown(Int32) with an infinite timeout.
	GetHost	Get a host instance for a given endpoint.
	GetReplicas	Gets a collection of replicas for a given partitionKey on a given keyspace.
	GetResolvedEndpoints
	OnInitializeAsync
	OnShutdownAsync
	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	Represents an event that is triggered when a new host is added to the cluster.
	HostRemoved	Represents an event that is triggered when a new host is decommissioned from the cluster.

Top

Examples

Copy

IDseCluster cluster = DseCluster.Builder().AddContactPoint("192.168.0.1").Build();
IDseSession session = cluster.Connect("ks1");
foreach (Row row in session.Execute(query))
{
    //do something...
}

Reference

Dse Namespace