Cluster class Core

Exposes the operations which are available to be performed against a cluster.

Namely the ability to access Buckets as well as performing management operations against the cluster.

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

bucket(String name) Bucket
Returns a Bucket which can be used to perform operations against a specific bucket.
close() Future<void>
Disconnects and this Cluster, cleaning up all resources associated with it.
diagnostics([DiagnosticsOptions? options]) Future<DiagnosticsResult>
Returns a diagnostics report about the currently active connections with the cluster.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
ping([PingOptions? options]) Future<PingResult>
Performs a ping operation against the cluster.
query(String statement, [QueryOptions? options]) Future<QueryResult>
Executes a SQL++ query against the cluster.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

connect(String connectionString, [ClusterOptions? options]) Future<Cluster>
Connects to a cluster using the provided connectionString and options.