Cluster Class |
Inheritance HierarchyCassandraCluster
Namespace: Cassandra
Assembly: Cassandra (in Cassandra.dll) Version: 3.11.0
Syntaxpublic class Cluster : ICluster, IDisposable
The Cluster type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Configuration |
Gets the cluster configuration.
|
 | MaxProtocolVersion |
Gets or sets the maximum protocol version used by this driver.
While property value is maintained for backward-compatibility, use SetMaxProtocolVersion(ProtocolVersion) to set the maximum protocol version used by the driver. Protocol version used can not be higher than MaxSupported. |
| 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. |
Methods| Name | Description | |
|---|---|---|
 | AllHosts |
Returns all known hosts of this cluster.
|
| Builder |
Creates a new Cluster.NewBuilder instance. This is a shortcut for new Cluster.NewBuilder() . |
| BuildFrom |
Build a new cluster based on the provided initializer. Note that for building a cluster programmatically, Cluster.NewBuilder provides a slightly less verbose shortcut with NewBuilder#Build. Also note that that all the contact points provided by initializer must share the same port. |
| Connect |
Creates a new session on this cluster.
|
| Connect(String) |
Creates a new session on this cluster and using a keyspace an existing keyspace.
|
| ConnectAndCreateDefaultKeyspaceIfNotExists |
Creates new session on this cluster, and sets it to default keyspace.
If default keyspace does not exist then it will be created and session will be set to it.
Name of default keyspace can be specified during creation of cluster object with Cluster.Builder().WithDefaultKeyspace("keyspace_name") method.
|
| ConnectAsync |
Creates a new session on this cluster.
|
| ConnectAsync(String) |
Creates a new session on this cluster and using a keyspace an existing keyspace.
|
| Dispose | Releases all resources used by the Cluster |
| 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. |
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
|
See Also