CassandraRow

Represents a single row fetched from Cassandra. Offers getters to read individual fields by column name or column index. The getters try to convert value to desired type, whenever possible. Most of the column types can be converted to a String. For nullable columns, you should use the getXXXOption getters which convert nulls to None values, otherwise a NullPointerException would be thrown.

All getters throw an exception if column name/index is not found. Column indexes start at 0.

If the value cannot be converted to desired type, com.datastax.spark.connector.types.TypeConversionException is thrown.

Recommended getters for Cassandra types:

- ascii: getString, getStringOption - bigint: getLong, getLongOption - blob: getBytes, getBytesOption - boolean: getBool, getBoolOption - counter: getLong, getLongOption - decimal: getDecimal, getDecimalOption - double: getDouble, getDoubleOption - float: getFloat, getFloatOption - inet: getInet, getInetOption - int: getInt, getIntOption - text: getString, getStringOption - timestamp: getDate, getDateOption - timeuuid: getUUID, getUUIDOption - uuid: getUUID, getUUIDOption - varchar: getString, getStringOption - varint: getVarInt, getVarIntOption - list: getList[T] - set: getSet[T] - map: getMap[K, V]

Collection getters getList, getSet and getMap require to explicitly pass an appropriate item type:

row.getList[String]("a_list")
row.getList[Int]("a_list")
row.getMap[Int, String]("a_map")

Generic get allows to automatically convert collections to other collection types. Supported containers: - scala.collection.immutable.List - scala.collection.immutable.Set - scala.collection.immutable.TreeSet - scala.collection.immutable.Vector - scala.collection.immutable.Map - scala.collection.immutable.TreeMap - scala.collection.Iterable - scala.collection.IndexedSeq - java.util.ArrayList - java.util.HashSet - java.util.HashMap

Example:

row.get[List[Int]]("a_list")
row.get[Vector[Int]]("a_list")
row.get[java.util.ArrayList[Int]]("a_list")
row.get[TreeMap[Int, String]]("a_map")

Timestamps can be converted to other Date types by using generic get. Supported date types: - java.util.Date - java.sql.Date - org.joda.time.DateTime

Linear Supertypes

ScalaGettableData, GettableData, ScalaGettableByIndexData, GettableByIndexData, Serializable, Serializable, AnyRef, Any

Instance Constructors

new CassandraRow(metaData: CassandraRowMetadata, columnValues: IndexedSeq[AnyRef])
new CassandraRow(columnNames: IndexedSeq[String], columnValues: IndexedSeq[AnyRef])

The constructor is for testing and backward compatibility only.
The constructor is for testing and backward compatibility only. Use default constructor with shared metadata for memory saving and performance.

Annotations
@deprecated
Deprecated
(Since version 1.6.0) Use default constructor

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val columnValues: IndexedSeq[AnyRef]

Definition Classes
CassandraRow → GettableByIndexData
def contains(name: String): Boolean

Returns true if column with given name is defined and has an entry in the underlying value array, i.e.
Returns true if column with given name is defined and has an entry in the underlying value array, i.e. was requested in the result set. For columns having null value, returns true.

Definition Classes
GettableData
def copy: ScalaGettableData

Definition Classes
ScalaGettableData → ScalaGettableByIndexData
def dataAsString: String

Displays the content in human readable form, including the names and values of the columns
Displays the content in human readable form, including the names and values of the columns

Definition Classes
GettableData → GettableByIndexData
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
GettableData → GettableByIndexData → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get[T](name: String)(implicit c: TypeConverter[T]): T

Generic getter for getting columns of any type.
Generic getter for getting columns of any type. Looks the column up by column name. Column names are case-sensitive.

Definition Classes
ScalaGettableData
def get[T](index: Int)(implicit c: TypeConverter[T]): T

Generic getter for getting columns of any type.
Generic getter for getting columns of any type. Looks the column up by its index. First column starts at index 0.

Definition Classes
ScalaGettableByIndexData
def getBoolean(name: String): Boolean

Returns a bool column value.
Returns a bool column value. Besides working with bool Cassandra type, it can also read numbers and strings. Non-zero numbers are converted to true, zero is converted to false. Strings are converted using String#toBoolean method.

Definition Classes
ScalaGettableData
def getBoolean(index: Int): Boolean

Returns a bool column value.
Returns a bool column value. Besides working with bool Cassandra type, it can also read numbers and strings. Non-zero numbers are converted to true, zero is converted to false. Strings are converted using String#toBoolean method.

Definition Classes
ScalaGettableByIndexData
def getBooleanOption(name: String): Option[Boolean]

Definition Classes
ScalaGettableData
def getBooleanOption(index: Int): Option[Boolean]

Definition Classes
ScalaGettableByIndexData
def getByte(name: String): Byte

Definition Classes
ScalaGettableData
def getByte(index: Int): Byte

Definition Classes
ScalaGettableByIndexData
def getByteOption(name: String): Option[Byte]

Definition Classes
ScalaGettableData
def getByteOption(index: Int): Option[Byte]

Definition Classes
ScalaGettableByIndexData
def getBytes(name: String): ByteBuffer

Returns a blob column value as ByteBuffer.
Returns a blob column value as ByteBuffer. This method is not suitable for reading other types of columns. Columns of type blob can be also read as Array[Byte] with the generic get method.

Definition Classes
ScalaGettableData
def getBytes(index: Int): ByteBuffer

Returns a blob column value as ByteBuffer.
Returns a blob column value as ByteBuffer. This method is not suitable for reading other types of columns. Columns of type blob can be also read as Array[Byte] with the generic get method.

Definition Classes
ScalaGettableByIndexData
def getBytesOption(name: String): Option[ByteBuffer]

Definition Classes
ScalaGettableData
def getBytesOption(index: Int): Option[ByteBuffer]

Definition Classes
ScalaGettableByIndexData
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getDate(name: String): Date

Returns a timestamp or timeuuid column value as java.util.Date.
Returns a timestamp or timeuuid column value as java.util.Date. To convert a timestamp to one of other supported date types, use the generic get method, for example:
```
row.get[java.sql.Date](0)
```
Definition Classes
ScalaGettableData
def getDate(index: Int): Date

Returns a timestamp or timeuuid column value as java.util.Date.
Returns a timestamp or timeuuid column value as java.util.Date. To convert a timestamp to one of other supported date types, use the generic get method, for example:
```
row.get[java.sql.Date](0)
```
Definition Classes
ScalaGettableByIndexData
def getDateOption(name: String): Option[Date]

Definition Classes
ScalaGettableData
def getDateOption(index: Int): Option[Date]

Definition Classes
ScalaGettableByIndexData
def getDateTime(name: String): DateTime

Returns a timestamp or timeuuid column value as org.joda.time.DateTime.
Returns a timestamp or timeuuid column value as org.joda.time.DateTime.

Definition Classes
ScalaGettableData
def getDateTime(index: Int): DateTime

Returns a timestamp or timeuuid column value as org.joda.time.DateTime.
Returns a timestamp or timeuuid column value as org.joda.time.DateTime.

Definition Classes
ScalaGettableByIndexData
def getDateTimeOption(name: String): Option[DateTime]

Definition Classes
ScalaGettableData
def getDateTimeOption(index: Int): Option[DateTime]

Definition Classes
ScalaGettableByIndexData
def getDecimal(name: String): BigDecimal

Returns a decimal column value.
Returns a decimal column value. Can be used with all other floating point types as well as with strings containing a valid floating point number of arbitrary precision.

Definition Classes
ScalaGettableData
def getDecimal(index: Int): BigDecimal

Returns a decimal column value.
Returns a decimal column value. Can be used with all other floating point types as well as with strings containing a valid floating point number of arbitrary precision.

Definition Classes
ScalaGettableByIndexData
def getDecimalOption(name: String): Option[BigDecimal]

Definition Classes
ScalaGettableData
def getDecimalOption(index: Int): Option[BigDecimal]

Definition Classes
ScalaGettableByIndexData
def getDouble(name: String): Double

Returns a column value as Double.
Returns a column value as Double. Recommended to use with float and double CQL types. This method can be also used to read a decimal column, with some loss of precision.

Definition Classes
ScalaGettableData
def getDouble(index: Int): Double

Returns a column value as Double.
Returns a column value as Double. Recommended to use with float and double CQL types. This method can be also used to read a decimal column, with some loss of precision.

Definition Classes
ScalaGettableByIndexData
def getDoubleOption(name: String): Option[Double]

Definition Classes
ScalaGettableData
def getDoubleOption(index: Int): Option[Double]

Definition Classes
ScalaGettableByIndexData
def getFloat(name: String): Float

Returns a column value as Float.
Returns a column value as Float. Recommended to use with float CQL type. This method can be also used to read a double or decimal column, with some loss of precision.

Definition Classes
ScalaGettableData
def getFloat(index: Int): Float

Returns a column value as Float.
Returns a column value as Float. Recommended to use with float CQL type. This method can be also used to read a double or decimal column, with some loss of precision.

Definition Classes
ScalaGettableByIndexData
def getFloatOption(name: String): Option[Float]

Definition Classes
ScalaGettableData
def getFloatOption(index: Int): Option[Float]

Definition Classes
ScalaGettableByIndexData
def getInet(name: String): InetAddress

Returns an inet column value.
Returns an inet column value. Can be used to read a string containing a valid Internet address, given either as a host name or IP address.

Definition Classes
ScalaGettableData
def getInet(index: Int): InetAddress

Returns an inet column value.
Returns an inet column value. Can be used to read a string containing a valid Internet address, given either as a host name or IP address.

Definition Classes
ScalaGettableByIndexData
def getInetOption(name: String): Option[InetAddress]

Definition Classes
ScalaGettableData
def getInetOption(index: Int): Option[InetAddress]

Definition Classes
ScalaGettableByIndexData
def getInt(name: String): Int

Returns a column value as a 32-bit integer number.
Returns a column value as a 32-bit integer number. Besides working with int Cassandra type, it can also read other integer numbers as bigint or varint and strings. The string must represent a valid integer number. The number must be within 32-bit integer range or the TypeConversionException will be thrown.

Definition Classes
ScalaGettableData
def getInt(index: Int): Int

Returns a column value as a 32-bit integer number.
Returns a column value as a 32-bit integer number. Besides working with int Cassandra type, it can also read other integer numbers as bigint or varint and strings. The string must represent a valid integer number. The number must be within 32-bit integer range or the TypeConversionException will be thrown.

Definition Classes
ScalaGettableByIndexData
def getIntOption(name: String): Option[Int]

Definition Classes
ScalaGettableData
def getIntOption(index: Int): Option[Int]

Definition Classes
ScalaGettableByIndexData
def getList[T](name: String)(implicit arg0: TypeConverter[T]): Vector[T]

Reads a list column value and returns it as Scala Vector.
Reads a list column value and returns it as Scala Vector. A null list is converted to an empty collection. Items of the list are converted to the given type. This method can be also used to read set and map column types. For map, the list items are converted to key-value pairs.
T
type of the list item, must be given explicitly.

Definition Classes
ScalaGettableData
def getList[T](index: Int)(implicit arg0: TypeConverter[T]): Vector[T]

Reads a list column value and returns it as Scala Vector.
Reads a list column value and returns it as Scala Vector. A null list is converted to an empty collection. Items of the list are converted to the given type. This method can be also used to read set and map column types. For map, the list items are converted to key-value pairs.
T
type of the list item, must be given explicitly.

Definition Classes
ScalaGettableByIndexData
def getLong(name: String): Long

Returns a column value as a 64-bit integer number.
Returns a column value as a 64-bit integer number. Recommended to use with bigint and counter CQL types It can also read other column types as int, varint, timestamp and string. The string must represent a valid integer number. The number must be within 64-bit integer range or com.datastax.spark.connector.types.TypeConversionException will be thrown. When used with timestamps, returns a number of milliseconds since epoch.

Definition Classes
ScalaGettableData
def getLong(index: Int): Long

Returns a column value as a 64-bit integer number.
Returns a column value as a 64-bit integer number. Recommended to use with bigint and counter CQL types It can also read other column types as int, varint, timestamp and string. The string must represent a valid integer number. The number must be within 64-bit integer range or com.datastax.spark.connector.types.TypeConversionException will be thrown. When used with timestamps, returns a number of milliseconds since epoch.

Definition Classes
ScalaGettableByIndexData
def getLongOption(name: String): Option[Long]

Definition Classes
ScalaGettableData
def getLongOption(index: Int): Option[Long]

Definition Classes
ScalaGettableByIndexData
def getMap[K, V](name: String)(implicit arg0: TypeConverter[K], arg1: TypeConverter[V]): Map[K, V]

Reads a map column value.
Reads a map column value. A null map is converted to an empty collection. Keys and values of the map are converted to the given types.
K
type of keys, must be given explicitly.
V
type of values, must be given explicitly.

Definition Classes
ScalaGettableData
def getMap[K, V](index: Int)(implicit arg0: TypeConverter[K], arg1: TypeConverter[V]): Map[K, V]

Reads a map column value.
Reads a map column value. A null map is converted to an empty collection. Keys and values of the map are converted to the given types.
K
type of keys, must be given explicitly.
V
type of values, must be given explicitly.

Definition Classes
ScalaGettableByIndexData
def getRaw(name: String): AnyRef

Returns a column value by aliased name without applying any conversion.
Returns a column value by aliased name without applying any conversion. The underlying type is the same as the type returned by the low-level Cassandra driver, is implementation defined and may change in the future. Cassandra nulls are returned as Scala nulls.

Definition Classes
GettableData
def getRaw(index: Int): AnyRef

Returns a column value by index without applying any conversion.
Returns a column value by index without applying any conversion. The underlying type is the same as the type returned by the low-level Cassandra driver, is implementation defined and may change in the future. Cassandra nulls are returned as Scala nulls.

Definition Classes
GettableByIndexData
def getRawCql(name: String): AnyRef

Returns a column value by cql Name
Returns a column value by cql Name

Definition Classes
GettableData
def getSet[T](name: String)(implicit arg0: TypeConverter[T]): Set[T]

Reads a set column value.
Reads a set column value. A null set is converted to an empty collection. Items of the set are converted to the given type. This method can be also used to read list and map column types. For map, the set items are converted to key-value pairs.
T
type of the set item, must be given explicitly.

Definition Classes
ScalaGettableData
def getSet[T](index: Int)(implicit arg0: TypeConverter[T]): Set[T]

Reads a set column value.
Reads a set column value. A null set is converted to an empty collection. Items of the set are converted to the given type. This method can be also used to read list and map column types. For map, the set items are converted to key-value pairs.
T
type of the set item, must be given explicitly.

Definition Classes
ScalaGettableByIndexData
def getShort(name: String): Short

Definition Classes
ScalaGettableData
def getShort(index: Int): Short

Definition Classes
ScalaGettableByIndexData
def getShortOption(name: String): Option[Short]

Definition Classes
ScalaGettableData
def getShortOption(index: Int): Option[Short]

Definition Classes
ScalaGettableByIndexData
def getString(name: String): String

Returns the column value converted to a String acceptable by CQL.
Returns the column value converted to a String acceptable by CQL. All data types that have human readable text representations can be converted. Note, this is not the same as calling getAny(index).toString which works differently e.g. for dates.

Definition Classes
ScalaGettableData
def getString(index: Int): String

Returns the column value converted to a String acceptable by CQL.
Returns the column value converted to a String acceptable by CQL. All data types that have human readable text representations can be converted. Note, this is not the same as calling getAny(index).toString which works differently e.g. for dates.

Definition Classes
ScalaGettableByIndexData
def getStringOption(name: String): Option[String]

Definition Classes
ScalaGettableData
def getStringOption(index: Int): Option[String]

Definition Classes
ScalaGettableByIndexData
def getTupleValue(name: String): TupleValue

Returns a column value of cassandra tuple type
Returns a column value of cassandra tuple type

Definition Classes
ScalaGettableData
def getTupleValue(index: Int): TupleValue

Returns a column value of cassandra tuple type
Returns a column value of cassandra tuple type

Definition Classes
ScalaGettableByIndexData
def getTupleValueOption(name: String): Option[TupleValue]

Definition Classes
ScalaGettableData
def getTupleValueOption(index: Int): Option[TupleValue]

Definition Classes
ScalaGettableByIndexData
def getUDTValue(name: String): UDTValue

Returns a column value of User Defined Type
Returns a column value of User Defined Type

Definition Classes
ScalaGettableData
def getUDTValue(index: Int): UDTValue

Returns a column value of User Defined Type
Returns a column value of User Defined Type

Definition Classes
ScalaGettableByIndexData
def getUDTValueOption(name: String): Option[UDTValue]

Definition Classes
ScalaGettableData
def getUDTValueOption(index: Int): Option[UDTValue]

Definition Classes
ScalaGettableByIndexData
def getUUID(name: String): UUID

Returns an uuid column value.
Returns an uuid column value. Can be used to read a string containing a valid UUID.

Definition Classes
ScalaGettableData
def getUUID(index: Int): UUID

Returns an uuid column value.
Returns an uuid column value. Can be used to read a string containing a valid UUID.

Definition Classes
ScalaGettableByIndexData
def getUUIDOption(name: String): Option[UUID]

Definition Classes
ScalaGettableData
def getUUIDOption(index: Int): Option[UUID]

Definition Classes
ScalaGettableByIndexData
def getVarInt(name: String): BigInt

Returns a varint column value.
Returns a varint column value. Can be used with all other integer types as well as with strings containing a valid integer number of arbitrary size.

Definition Classes
ScalaGettableData
def getVarInt(index: Int): BigInt

Returns a varint column value.
Returns a varint column value. Can be used with all other integer types as well as with strings containing a valid integer number of arbitrary size.

Definition Classes
ScalaGettableByIndexData
def getVarIntOption(name: String): Option[BigInt]

Definition Classes
ScalaGettableData
def getVarIntOption(index: Int): Option[BigInt]

Definition Classes
ScalaGettableByIndexData
def hashCode(): Int

Definition Classes
GettableData → GettableByIndexData → AnyRef → Any
def indexOf(name: String): Int

Returns index of column with given name or -1 if column not found
Returns index of column with given name or -1 if column not found

Definition Classes
GettableData
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isNullAt(name: String): Boolean

Returns true if column value is Cassandra null
Returns true if column value is Cassandra null

Definition Classes
GettableData
def isNullAt(index: Int): Boolean

Returns true if column value is Cassandra null
Returns true if column value is Cassandra null

Definition Classes
GettableByIndexData
def iterator: Iterator[AnyRef]

Definition Classes
ScalaGettableByIndexData
def length: Int

Total number of columns in this row.
Total number of columns in this row. Includes columns with null values.

Definition Classes
GettableByIndexData
val metaData: CassandraRowMetadata

Definition Classes
CassandraRow → GettableData
def nameOf(index: Int): String

Returns the name of the i-th column.
Returns the name of the i-th column.

Definition Classes
GettableData
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def size: Int

Total number of columns in this row.
Total number of columns in this row. Includes columns with null values.

Definition Classes
GettableByIndexData
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toMap: Map[String, Any]

Converts this row to a Map
Converts this row to a Map

Definition Classes
ScalaGettableData
def toString(): String

Definition Classes
CassandraRow → GettableData → GettableByIndexData → 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( ... )

Related Docs: object CassandraRow | package connector

final class CassandraRow extends ScalaGettableData with Serializable

Instance Constructors

new CassandraRow(metaData: CassandraRowMetadata, columnValues: IndexedSeq[AnyRef])

new CassandraRow(columnNames: IndexedSeq[String], columnValues: IndexedSeq[AnyRef])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val columnValues: IndexedSeq[AnyRef]

def contains(name: String): Boolean

def copy: ScalaGettableData

def dataAsString: String

final def eq(arg0: AnyRef): Boolean

def equals(o: Any): Boolean

def finalize(): Unit

def get[T](name: String)(implicit c: TypeConverter[T]): T

def get[T](index: Int)(implicit c: TypeConverter[T]): T

def getBoolean(name: String): Boolean

def getBoolean(index: Int): Boolean

def getBooleanOption(name: String): Option[Boolean]

def getBooleanOption(index: Int): Option[Boolean]

def getByte(name: String): Byte

def getByte(index: Int): Byte

def getByteOption(name: String): Option[Byte]

def getByteOption(index: Int): Option[Byte]

def getBytes(name: String): ByteBuffer

def getBytes(index: Int): ByteBuffer

def getBytesOption(name: String): Option[ByteBuffer]

def getBytesOption(index: Int): Option[ByteBuffer]

final def getClass(): Class[_]

def getDate(name: String): Date

def getDate(index: Int): Date

def getDateOption(name: String): Option[Date]

def getDateOption(index: Int): Option[Date]

def getDateTime(name: String): DateTime

def getDateTime(index: Int): DateTime

def getDateTimeOption(name: String): Option[DateTime]

def getDateTimeOption(index: Int): Option[DateTime]

def getDecimal(name: String): BigDecimal

def getDecimal(index: Int): BigDecimal

def getDecimalOption(name: String): Option[BigDecimal]

def getDecimalOption(index: Int): Option[BigDecimal]

def getDouble(name: String): Double

def getDouble(index: Int): Double

def getDoubleOption(name: String): Option[Double]

def getDoubleOption(index: Int): Option[Double]

def getFloat(name: String): Float

def getFloat(index: Int): Float

def getFloatOption(name: String): Option[Float]

def getFloatOption(index: Int): Option[Float]

def getInet(name: String): InetAddress

def getInet(index: Int): InetAddress

def getInetOption(name: String): Option[InetAddress]

def getInetOption(index: Int): Option[InetAddress]

def getInt(name: String): Int

def getInt(index: Int): Int

def getIntOption(name: String): Option[Int]

def getIntOption(index: Int): Option[Int]

def getList[T](name: String)(implicit arg0: TypeConverter[T]): Vector[T]

def getList[T](index: Int)(implicit arg0: TypeConverter[T]): Vector[T]

def getLong(name: String): Long

def getLong(index: Int): Long

def getLongOption(name: String): Option[Long]

def getLongOption(index: Int): Option[Long]

def getMap[K, V](name: String)(implicit arg0: TypeConverter[K], arg1: TypeConverter[V]): Map[K, V]

def getMap[K, V](index: Int)(implicit arg0: TypeConverter[K], arg1: TypeConverter[V]): Map[K, V]

def getRaw(name: String): AnyRef

def getRaw(index: Int): AnyRef

def getRawCql(name: String): AnyRef

def getSet[T](name: String)(implicit arg0: TypeConverter[T]): Set[T]

def getSet[T](index: Int)(implicit arg0: TypeConverter[T]): Set[T]

def getShort(name: String): Short

def getShort(index: Int): Short

def getShortOption(name: String): Option[Short]

def getShortOption(index: Int): Option[Short]

def getString(name: String): String