Package com.datastax.driver.core

The main package for the Java Driver for Cassandra.

The main entry for this package is the Cluster class.

Interface Summary

Interface	Description
ApplicationInfo
Authenticator	Handles SASL authentication with Cassandra servers.
AuthProvider	Provides Authenticator instances for use when connecting to Cassandra nodes.
Cluster.Initializer	Initializer for Cluster instances.
DriverConfigReporter	Builds the DRIVER_CONFIG payload that the control connection sends in its CQL STARTUP options, so ScyllaDB can store it in system.clients.client_options and operators can inspect a client's effective driver settings while investigating incidents.
EndPoint	Encapsulates the information needed by the driver to open connections to a node.
EndPointFactory	Produces EndPoint instances representing the connection information to every node.
ExtendedAuthProvider	An auth provider that represents the host as an EndPoint instead of a raw InetSocketAddress.
ExtendedRemoteEndpointAwareSslOptions
GettableByIndexData	Collection of (typed) CQL values that can be retrieved by index (starting at zero).
GettableByNameData	Collection of (typed) CQL values that can be retrieved by name.
GettableData	Collection of (typed) CQL values that can be retrieved either by index (starting at zero) or by name.
Host.LifecycleAwareStateListener	A StateListener that tracks when it gets registered or unregistered with a cluster.
Host.StateListener	Interface for listeners that are interested in hosts added, up, down and removed events.
LatencyTracker	Interface for objects that are interested in tracking the latencies of the driver queries to each Cassandra nodes.
PagingIterable<S extends PagingIterable<S,T>,T>	Defines an iterable whose elements can be remotely fetched and paged, possibly asynchronously.
PreparedStatement	Represents a prepared statement, a query with bound variables that has been prepared (pre-parsed) by the database.
RemoteEndpointAwareSSLOptions	Child interface to SSLOptions with the possibility to pass remote endpoint data when instantiating SslHandlers.
ResultSet	The result of a query.
ResultSetFuture	A future on a ResultSet.
Row	A CQL Row returned in a ResultSet.
SchemaChangeListener	Interface for objects that are interested in tracking schema change events in the cluster.
Session	A session holds connections to a Cassandra cluster, allowing it to be queried.
Session.State	The state of a Session.
SettableByIndexData<T extends SettableByIndexData<T>>	Collection of (typed) CQL values that can be set by index (starting at zero).
SettableByNameData<T extends SettableData<T>>	Collection of (typed) CQL values that can set by name.
SettableData<T extends SettableData<T>>	Collection of (typed) CQL values that can be set either by index (starting at zero) or by name.
SSLOptions	Defines how the driver configures SSL connections.
TimestampGenerator	Generates client-side, microsecond-precision query timestamps.

Class Summary

Class	Description
AbstractGettableData
AbstractMonotonicTimestampGenerator	Base implementation for monotonic timestamp generators.
AbstractSession	Abstract implementation of the Session interface.
AbstractTableMetadata	Base class for Tables and Materialized Views metadata.
AggregateMetadata	Describes a CQL aggregate function (created with CREATE AGGREGATE...).
AtomicMonotonicTimestampGenerator	A timestamp generator that guarantees monotonically increasing timestamps among all client threads, and logs warnings when timestamps drift in the future.
AuthProvider.TransitionalModePlainTextAuthenticator	Dummy Authenticator that accounts for DSE authentication configured with transitional mode.
BatchStatement	A statement that groups a number of Statement so they get executed as a batch.
BoundStatement	A prepared statement with values bound to the bind variables.
CloseFuture	A future on the shutdown of a Cluster or Session instance.
Cluster	Information and known state of a Cassandra cluster.
Cluster.Builder	Helper class to build Cluster instances.
ClusterWidePercentileTracker	A PercentileTracker that aggregates all measurements into a single histogram.
ClusterWidePercentileTracker.Builder	Helper class to build PerHostPercentileTracker instances with a fluent interface.
CodecRegistry	A registry for TypeCodecs.
CodecUtils	A set of utility methods to deal with type conversion and serialization.
ColumnDefinitions	Metadata describing the columns returned in a ResultSet or a PreparedStatement.
ColumnDefinitions.Definition	A column definition.
ColumnMetadata	Describes a Column.
Configuration	The configuration of the cluster.
Configuration.Builder	A builder to create a new Configuration object.
DataType	Data types supported by cassandra.
DataType.CollectionType	Instances of this class represent collection types, that is, lists, sets or maps.
DataType.CustomType	A "custom" type is a type that cannot be expressed as a CQL type.
DataType.NativeType	Instances of this class represent CQL native types, also known as CQL primitive types.
DefaultApplicationInfo
DefaultDriverConfigReporter	Default DriverConfigReporter: serializes the driver configuration to the cross-driver DRIVER_CONFIG JSON shape, which Connection.Factory then sends in the control connection's STARTUP options.
DefaultEndPointFactory
DefaultPreparedStatement
DelegatingCluster	Base class for custom Cluster implementations that wrap another instance (delegate / decorator pattern).
Duration	Represents a duration.
ExecutionInfo	Basic information on the execution of a query.
ExtendedAuthProvider.NoAuthProvider
FramingFormatHandler	A handler to deal with different protocol framing formats.
FunctionMetadata	Describes a CQL function (created with CREATE FUNCTION...).
Host	A Cassandra node.
IndexMetadata	An immutable representation of secondary index metadata.
JdkSSLOptions	Deprecated. Use RemoteEndpointAwareJdkSSLOptions instead.
JdkSSLOptions.Builder	Helper class to build JDK-based SSL options.
KeyspaceMetadata	Describes a keyspace defined in this cluster.
LocalDate	A date with no time components, no time zone, in the ISO 8601 calendar.
LoggingMonotonicTimestampGenerator	A monotonic timestamp generator that logs warnings when timestamps drift in the future (see this class's constructors and LoggingMonotonicTimestampGenerator.onDrift(long, long) for more information).
LwtInfo
MapExtensionReader
MaterializedViewMetadata	An immutable representation of a materialized view.
Metadata	Keeps metadata on the connected cluster, including known nodes and schema definitions.
MetadataIdInfo
Metrics	Metrics exposed by the driver.
MetricsOptions	Metrics options.
MetricsUtil
Native	Helper class to deal with native system calls through the JNR library.
NettyOptions	A set of hooks that allow clients to customize the driver's underlying Netty layer.
NettySSLOptions	Deprecated. Use RemoteEndpointAwareNettySSLOptions instead.
PagingState	The paging state of a query.
ParseUtils	Simple utility class used to help parsing CQL values (mainly UDT and collection ones).
PercentileTracker	A LatencyTracker that records query latencies over a sliding time interval, and exposes an API to retrieve the latency at a given percentile.
PercentileTracker.Builder<B,T>	Base class for PercentileTracker implementation builders.
PerHostPercentileTracker	A PercentileTracker that maintains a separate histogram for each host.
PerHostPercentileTracker.Builder	Helper class to build PerHostPercentileTracker instances with a fluent interface.
PlainTextAuthProvider	A simple AuthProvider implementation.
PoolingOptions	Options related to connection pooling.
PreparedId	Identifies a PreparedStatement.
ProtocolFeatures	A listing of features that may or not apply to a given ProtocolVersion.
ProtocolFeatures.Feature	An abstract implementation of feature that may or not apply to a given ProtocolVersion.
ProtocolFeatureStore
ProtocolOptions	Options of the Cassandra native binary protocol.
QueryLogger	A configurable LatencyTracker that logs all executed statements.
QueryLogger.Builder	Helper class to build QueryLogger instances with a fluent API.
QueryLogger.ConstantThresholdQueryLogger	A QueryLogger that uses a constant threshold in milliseconds to track slow queries.
QueryLogger.DynamicThresholdQueryLogger	A QueryLogger that uses a dynamic threshold in milliseconds to track slow queries.
QueryOptions	Options related to defaults for individual queries.
QueryTrace	The Cassandra trace for a query.
QueryTrace.Event	A trace event.
RegularStatement	A regular (non-prepared and non batched) CQL statement.
RemoteEndpointAwareJdkSSLOptions	RemoteEndpointAwareSSLOptions implementation based on built-in JDK classes.
RemoteEndpointAwareJdkSSLOptions.Builder	Helper class to build RemoteEndpointAwareJdkSSLOptions instances.
RemoteEndpointAwareNettySSLOptions	RemoteEndpointAwareSSLOptions implementation based on Netty's SSL context.
SchemaChangeListenerBase	Base implementation for SchemaChangeListener.
ServerSideTimestampGenerator	A timestamp generator that always returns Long.MIN_VALUE, in order to let Cassandra assign server-side timestamps.
ShardingInfo	Keeps the information the driver maintains on data layout of a given node.
ShardingInfo.ConnectionShardingInfo
SimpleStatement	A simple RegularStatement implementation built directly from a query string.
SniEndPoint	An endpoint to access nodes through a proxy that uses SNI routing.
SniEndPointFactory
SniSSLOptions
SniSSLOptions.Builder
SocketOptions	Options to configure low-level socket options for the connections kept to the Cassandra hosts.
Statement	An executable query.
StatementWrapper	Base class for custom Statement implementations that wrap another statement.
TableMetadata	Describes a Table.
TableOptionsMetadata
TabletInfo
TabletMap	Holds currently known tablet mappings.
TabletMap.HostShardPair	Simple class to hold UUID of a host and a shard number.
TabletMap.KeyspaceTableNamePair	Simple keyspace name and table name pair.
TabletMap.Tablet	Represents a single tablet created from tablets-routing-v1 custom payload.
TabletMap.TabletSet	Set of tablets bundled with ReadWriteLock to allow concurrent modification for different sets.
TabletMapListener
ThreadingOptions	A set of hooks that allow clients to customize the driver's internal executors.
ThreadLocalMonotonicTimestampGenerator	A timestamp generator that guarantees monotonically increasing timestamps on a per-thread basis, and logs warnings when timestamps drift in the future.
Token	A token on the Cassandra ring.
TokenRange	A range of tokens on the Cassandra ring.
TupleType	A tuple type.
TupleValue	A value for a Tuple.
TypeCodec<T>	A Codec that can serialize and deserialize to and from a given CQL type and a given Java Type.
TypeCodec.AbstractCollectionCodec<E,C extends Collection<E>>	Base class for codecs mapping CQL lists and sets to Java collections.
TypeCodec.AbstractMapCodec<K,V>	Base class for codecs mapping CQL maps to a Java Map.
TypeCodec.AbstractTupleCodec<T>	Base class for codecs mapping CQL tuples to Java objects.
TypeCodec.AbstractUDTCodec<T>	Base class for codecs mapping CQL user-defined types (UDTs) to Java objects.
TypeCodec.PrimitiveBooleanCodec	A codec that is capable of handling primitive booleans, thus avoiding the overhead of boxing and unboxing such primitives.
TypeCodec.PrimitiveByteCodec	A codec that is capable of handling primitive bytes, thus avoiding the overhead of boxing and unboxing such primitives.
TypeCodec.PrimitiveDoubleCodec	A codec that is capable of handling primitive doubles, thus avoiding the overhead of boxing and unboxing such primitives.
TypeCodec.PrimitiveFloatCodec	A codec that is capable of handling primitive floats, thus avoiding the overhead of boxing and unboxing such primitives.
TypeCodec.PrimitiveIntCodec	A codec that is capable of handling primitive ints, thus avoiding the overhead of boxing and unboxing such primitives.
TypeCodec.PrimitiveLongCodec	A codec that is capable of handling primitive longs, thus avoiding the overhead of boxing and unboxing such primitives.
TypeCodec.PrimitiveShortCodec	A codec that is capable of handling primitive shorts, thus avoiding the overhead of boxing and unboxing such primitives.
TypeTokens	Utility methods to create TypeToken instances.
UDTValue	A value for a User Defined Type.
UserType	A User Defined Type (UDT).
UserType.Field	A UDT field.
VersionNumber	A version number in the form X.Y.Z with optional pre-release labels and build metadata.

Enum Summary

Enum	Description
BatchStatement.Type	The type of batch to use.
ClusteringOrder	Clustering orders.
ConsistencyLevel
DataType.Name	The CQL type name.
HostDistance	The distance to a Cassandra node as assigned by a LoadBalancingPolicy (through its distance method).
IndexMetadata.Kind
ProtocolOptions.Compression	Compression supported by the Cassandra binary protocol.
ProtocolVersion	Versions of the native protocol supported by the driver.
QueryOptions.CQL4SkipMetadataResolveMethod
QueryOptions.RequestRoutingMethod	The request routing method for queries.
WriteType	The type of a Cassandra write query.

Annotation Types Summary

Annotation Type	Description
IgnoreJDK6Requirement	Annotation used to mark classes in this project as excluded from JDK 6 signature check performed by animal-sniffer Maven plugin as they require JDK 8 or higher.