CassandraConnector

Provides and manages connections to Cassandra.

A CassandraConnector instance is serializable and can be safely sent over network, because it automatically reestablishes the connection to the same cluster after deserialization. Internally it saves a list of all nodes in the cluster, so a connection can be established even if the host given in the initial config is down.

Multiple CassandraConnectors in the same JVM connected to the same Cassandra cluster will share a single underlying Cluster object. CassandraConnector will close the underlying Cluster object automatically whenever it is not used i.e. no Session or Cluster is open for longer than spark.cassandra.connection.keep_alive_ms property value.

A CassandraConnector object is configured from CassandraConnectorConf object which can be either given explicitly or automatically configured from SparkConf. The connection options are:

spark.cassandra.connection.host: contact point to connect to the Cassandra cluster, defaults to spark master host
spark.cassandra.connection.rpc.port: Cassandra thrift port, defaults to 9160
spark.cassandra.connection.native.port: Cassandra native port, defaults to 9042
spark.cassandra.connection.factory: name of a Scala module or class implementing CassandraConnectionFactory that allows to plugin custom code for connecting to Cassandra
spark.cassandra.connection.keep_alive_ms: how long to keep unused connection before closing it (default 250 ms)
spark.cassandra.connection.timeout_ms: how long to wait for connection to the Cassandra cluster (default 5 s)
spark.cassandra.connection.reconnection_delay_ms.min: initial delay determining how often to try to reconnect to a dead node (default 1 s)
spark.cassandra.connection.reconnection_delay_ms.max: final delay determining how often to try to reconnect to a dead node (default 60 s)
spark.cassandra.auth.username: login for password authentication
spark.cassandra.auth.password: password for password authentication
spark.cassandra.auth.conf.factory: name of a Scala module or class implementing AuthConfFactory that allows to plugin custom authentication configuration
spark.cassandra.query.retry.count: how many times to reattempt a failed query (default 10)

Linear Supertypes

Logging, Serializable, Serializable, AnyRef, Any

Instance Constructors

new CassandraConnector(conf: CassandraConnectorConf)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from CassandraConnector to any2stringadd[CassandraConnector] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (CassandraConnector, B)

Implicit information
This member is added by an implicit conversion from CassandraConnector to ArrowAssoc[CassandraConnector] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def authConf: AuthConf

Configured authentication options
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def closeResourceAfterUse[T, C <: AnyRef { def close(): Unit }](closeable: C)(code: (C) ⇒ T): T

Automatically closes resource after use.
Automatically closes resource after use. Handy for closing streams, files, sessions etc. Similar to try-with-resources in Java 7.
def closestLiveHost: Host

Returns the local node, if it is one of the cluster nodes.
Returns the local node, if it is one of the cluster nodes. Otherwise returns any node.
def connectionFactory: CassandraConnectionFactory

Connection configurator
def createThriftClient(): CassandraClientProxy
def createThriftClient(host: InetAddress): CassandraClientProxy

Opens a Thrift client to the given host.
Opens a Thrift client to the given host. Don't use it unless you really know what you are doing.
def ensuring(cond: (CassandraConnector) ⇒ Boolean, msg: ⇒ Any): CassandraConnector

Implicit information
This member is added by an implicit conversion from CassandraConnector to Ensuring[CassandraConnector] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (CassandraConnector) ⇒ Boolean): CassandraConnector

Implicit information
This member is added by an implicit conversion from CassandraConnector to Ensuring[CassandraConnector] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): CassandraConnector

Implicit information
This member is added by an implicit conversion from CassandraConnector to Ensuring[CassandraConnector] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): CassandraConnector

Implicit information
This member is added by an implicit conversion from CassandraConnector to Ensuring[CassandraConnector] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from CassandraConnector to StringFormat[CassandraConnector] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def hosts: Set[InetAddress]

Known cluster hosts.
Known cluster hosts. This is going to return all cluster hosts after at least one successful connection has been made
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
def log: Logger

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logName: String

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def nativePort: Int

Configured native port
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def openSession(): Session

Returns a shared session to Cassandra and increases the internal open reference counter.
Returns a shared session to Cassandra and increases the internal open reference counter. It does not release the session automatically, so please remember to close it after use. Closing a shared session decreases the session reference counter. If the reference count drops to zero, the session may be physically closed.
def rpcPort: Int

Configured thrift client port
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withCassandraClientDo[T](code: (CassandraClientProxy) ⇒ T): T
def withCassandraClientDo[T](host: InetAddress)(code: (CassandraClientProxy) ⇒ T): T
def withClusterDo[T](code: (Cluster) ⇒ T): T

Allows to use Cassandra Cluster in a safe way without risk of forgetting to close it.
Allows to use Cassandra Cluster in a safe way without risk of forgetting to close it. Multiple, concurrent calls might share the same Cluster. The Cluster will be closed when not in use for some time. It is not recommended to obtain sessions from this method. Use withSessionDo instead which allows for proper session sharing.
def withSessionDo[T](code: (Session) ⇒ T): T

Allows to use Cassandra Session in a safe way without risk of forgetting to close it.
Allows to use Cassandra Session in a safe way without risk of forgetting to close it. The Session object obtained through this method is a proxy to a shared, single Session associated with the cluster. Internally, the shared underlying Session will be closed shortly after all the proxies are closed.
def →[B](y: B): (CassandraConnector, B)

Implicit information
This member is added by an implicit conversion from CassandraConnector to ArrowAssoc[CassandraConnector] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object CassandraConnector | package cql

class CassandraConnector extends Serializable with Logging

Instance Constructors

new CassandraConnector(conf: CassandraConnectorConf)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (CassandraConnector, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def authConf: AuthConf

def clone(): AnyRef

def closeResourceAfterUse[T, C <: AnyRef { def close(): Unit }](closeable: C)(code: (C) ⇒ T): T

def closestLiveHost: Host

def connectionFactory: CassandraConnectionFactory

def createThriftClient(): CassandraClientProxy

def createThriftClient(host: InetAddress): CassandraClientProxy

def ensuring(cond: (CassandraConnector) ⇒ Boolean, msg: ⇒ Any): CassandraConnector

def ensuring(cond: (CassandraConnector) ⇒ Boolean): CassandraConnector

def ensuring(cond: Boolean, msg: ⇒ Any): CassandraConnector

def ensuring(cond: Boolean): CassandraConnector

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

def hosts: Set[InetAddress]

final def isInstanceOf[T0]: Boolean

def isTraceEnabled(): Boolean

def log: Logger

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

def logDebug(msg: ⇒ String): Unit

def logError(msg: ⇒ String, throwable: Throwable): Unit

def logError(msg: ⇒ String): Unit

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

def logInfo(msg: ⇒ String): Unit

def logName: String

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

def logTrace(msg: ⇒ String): Unit

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

def logWarning(msg: ⇒ String): Unit

def nativePort: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def openSession(): Session

def rpcPort: Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withCassandraClientDo[T](code: (CassandraClientProxy) ⇒ T): T

def withCassandraClientDo[T](host: InetAddress)(code: (CassandraClientProxy) ⇒ T): T

def withClusterDo[T](code: (Cluster) ⇒ T): T

def withSessionDo[T](code: (Session) ⇒ T): T

def →[B](y: B): (CassandraConnector, B)

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CassandraConnector to any2stringadd[CassandraConnector]

Inherited by implicit conversion StringFormat from CassandraConnector to StringFormat[CassandraConnector]

Inherited by implicit conversion Ensuring from CassandraConnector to Ensuring[CassandraConnector]

Inherited by implicit conversion ArrowAssoc from CassandraConnector to ArrowAssoc[CassandraConnector]

Ungrouped