cql

Type Members

1. trait AuthConf extends Serializable

   

   Stores credentials used to authenticate to a Cassandra cluster and uses them to configure a Cassandra connection.

   Stores credentials used to authenticate to a Cassandra cluster and uses them to configure a Cassandra connection. This driver provides implementations NoAuthConf for no authentication and PasswordAuthConf for password authentication. Other authentication configurators can be plugged in by setting cassandra.authentication.conf.factory.class option. See AuthConfFactory.

2. trait AuthConfFactory extends AnyRef

   

   Obtains authentication configuration by reading SparkConf object.

3. trait CassandraConnectionFactory extends Serializable

   

   Creates both native and Thrift connections to Cassandra.

   Creates both native and Thrift connections to Cassandra. The connector provides a DefaultConnectionFactory. Other factories can be plugged in by setting spark.cassandra.connection.factory option.

4. class CassandraConnector extends Serializable with Logging

   

   Provides and manages connections to Cassandra.

   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.keepAliveMS 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 points to connect to the Cassandra cluster, defaults to spark master host
   • spark.cassandra.connection.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.keepAliveMS: how long to keep unused connection before closing it (default 250 ms)
   • spark.cassandra.connection.timeoutMS: how long to wait for connection to the Cassandra cluster (default 5 s)
   • spark.cassandra.connection.reconnectionDelayMS.min: initial delay determining how often to try to reconnect to a dead node (default 1 s)
   • spark.cassandra.connection.reconnectionDelayMS.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)
   • spark.cassandra.read.timeoutMS: maximum period of time to wait for a read to return
   • spark.cassandra.connection.ssl.enabled: enable secure connection to Cassandra cluster
   • spark.cassandra.connection.ssl.trustStore.path: path for the trust store being used
   • spark.cassandra.connection.ssl.trustStore.password: trust store password
   • spark.cassandra.connection.ssl.trustStore.type: trust store type (default JKS)
   • spark.cassandra.connection.ssl.protocol: SSL protocol (default TLS)
   • spark.cassandra.connection.ssl.enabledAlgorithms: SSL cipher suites (default TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA)

5. case class CassandraConnectorConf(hosts: Set[InetAddress], port: Int = ..., authConf: AuthConf = NoAuthConf, localDC: Option[String] = None, keepAliveMillis: Int = ..., minReconnectionDelayMillis: Int = ..., maxReconnectionDelayMillis: Int = ..., localConnectionsPerExecutor: Option[Int] = ..., minRemoteConnectionsPerExecutor: Option[Int] = ..., maxRemoteConnectionsPerExecutor: Option[Int] = ..., compression: Compression = ..., queryRetryCount: Int = ..., connectTimeoutMillis: Int = ..., readTimeoutMillis: Int = ..., connectionFactory: CassandraConnectionFactory = DefaultConnectionFactory, cassandraSSLConf: CassandraSSLConf = ...) extends Product with Serializable

   

   Stores configuration of a connection to Cassandra.

   Stores configuration of a connection to Cassandra. Provides information about cluster nodes, ports and optional credentials for authentication.

6. case class ClusteringColumn(index: Int) extends ColumnRole with Product with Serializable

   

7. case class ColumnDef(columnName: String, columnRole: ColumnRole, columnType: ColumnType[_]) extends FieldDef with Product with Serializable

   

   A Cassandra column metadata that can be serialized.

8. sealed trait ColumnRole extends AnyRef

   

9. class DefaultScanner extends Scanner

   

10. trait FieldDef extends Serializable

    

    Abstract column / field definition.

    Abstract column / field definition. Common to tables and user-defined types

11. case class IndexDef(className: String, target: String, indexName: String, options: Map[String, String]) extends Serializable with Product

    

    Cassandra Index Metadata that can be serialized *

12. case class KeyspaceDef(keyspaceName: String, tables: Set[TableDef]) extends Product with Serializable

    

    A Cassandra keyspace metadata that can be serialized.

13. class LocalNodeFirstLoadBalancingPolicy extends LoadBalancingPolicy with Logging

    

    Selects local node first and then nodes in local DC in random order.

    Selects local node first and then nodes in local DC in random order. Never selects nodes from other DCs. For writes, if a statement has a routing key set, this LBP is token aware - it prefers the nodes which are replicas of the computed token to the other nodes.

14. class MultipleRetryPolicy extends RetryPolicy

    

    Always retries with the same CL (null forces the original statement CL see SPARKC-494), constant number of times, regardless of circumstances

    Always retries with the same CL (null forces the original statement CL see SPARKC-494), constant number of times, regardless of circumstances

    Retries indefinitely if maxRetryCount is -1

15. case class PasswordAuthConf(user: String, password: String) extends AuthConf with Product with Serializable

    

    Performs plain-text password authentication.

    Performs plain-text password authentication. Use with PasswordAuthenticator in Cassandra.

16. class RefCountMap[T] extends AnyRef

    

    Atomically counts references to objects of any type

17. final class RefCountedCache[K, V] extends AnyRef

    

    A lockless cache that caches values for multiple users and destroys them once all users release them.

    A lockless cache that caches values for multiple users and destroys them once all users release them. One value can be associated with many keys. Useful for sharing a costly resource.

18. class ReplicaAwareStatement extends StatementWrapper

    

    Associates given statement with a set of replica addresses.

    Associates given statement with a set of replica addresses. It is meant to be interpreted by LoadBalancingPolicy implementations, like LocalNodeFirstLoadBalancingPolicy.

19. case class ScanResult(rows: Iterator[Row], metadata: CassandraRowMetadata) extends Product with Serializable

    

20. trait Scanner extends AnyRef

    

    Object which will be used in Table Scanning Operations.

    Object which will be used in Table Scanning Operations. One Scanner will be created per Spark Partition, it will be created at the beginning of the compute method and Closed at the end of the compute method.

21. case class Schema(clusterName: String, keyspaces: Set[KeyspaceDef]) extends Product with Serializable

    

22. class SessionProxy extends InvocationHandler

    

    Wraps a Session and intercepts:

    Wraps a Session and intercepts:

    • close method to invoke afterClose handler
    • prepare methods to cache PreparedStatement objects.

23. trait StructDef extends Serializable

    

    Cassandra structure that contains columnar information, e.g.

    Cassandra structure that contains columnar information, e.g. a table or a user defined type. This trait allows ColumnMapper to work on tables and user defined types. Cassandra tables and user defined types are similar in a way data are extracted from them, therefore a common interface to describe their metadata is handy.

24. case class TableDef(keyspaceName: String, tableName: String, partitionKey: Seq[ColumnDef], clusteringColumns: Seq[ColumnDef], regularColumns: Seq[ColumnDef], indexes: Seq[IndexDef] = Seq.empty, isView: Boolean = false) extends StructDef with Product with Serializable

    

    A Cassandra table metadata that can be serialized.