Packages

final class CassandraRow extends ScalaGettableData with Serializable

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

Linear Supertypes
ScalaGettableData, GettableData, ScalaGettableByIndexData, GettableByIndexData, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CassandraRow
  2. ScalaGettableData
  3. GettableData
  4. ScalaGettableByIndexData
  5. GettableByIndexData
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CassandraRow(metaData: CassandraRowMetadata, columnValues: IndexedSeq[AnyRef])
  2. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. val columnValues: IndexedSeq[AnyRef]
    Definition Classes
    CassandraRow → GettableByIndexData
  7. 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
  8. def copy: ScalaGettableData
    Definition Classes
    ScalaGettableData → ScalaGettableByIndexData
  9. 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
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(o: Any): Boolean
    Definition Classes
    GettableData → GettableByIndexData → AnyRef → Any
  12. 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
  13. 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
  14. 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
  15. 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
  16. def getBooleanOption(name: String): Option[Boolean]
    Definition Classes
    ScalaGettableData
  17. def getBooleanOption(index: Int): Option[Boolean]
    Definition Classes
    ScalaGettableByIndexData
  18. def getByte(name: String): Byte
    Definition Classes
    ScalaGettableData
  19. def getByte(index: Int): Byte
    Definition Classes
    ScalaGettableByIndexData
  20. def getByteOption(name: String): Option[Byte]
    Definition Classes
    ScalaGettableData
  21. def getByteOption(index: Int): Option[Byte]
    Definition Classes
    ScalaGettableByIndexData
  22. 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
  23. 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
  24. def getBytesOption(name: String): Option[ByteBuffer]
    Definition Classes
    ScalaGettableData
  25. def getBytesOption(index: Int): Option[ByteBuffer]
    Definition Classes
    ScalaGettableByIndexData
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. 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
  28. 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
  29. def getDateOption(name: String): Option[Date]
    Definition Classes
    ScalaGettableData
  30. def getDateOption(index: Int): Option[Date]
    Definition Classes
    ScalaGettableByIndexData
  31. 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
  32. 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
  33. def getDecimalOption(name: String): Option[BigDecimal]
    Definition Classes
    ScalaGettableData
  34. def getDecimalOption(index: Int): Option[BigDecimal]
    Definition Classes
    ScalaGettableByIndexData
  35. 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
  36. 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
  37. def getDoubleOption(name: String): Option[Double]
    Definition Classes
    ScalaGettableData
  38. def getDoubleOption(index: Int): Option[Double]
    Definition Classes
    ScalaGettableByIndexData
  39. 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
  40. 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
  41. def getFloatOption(name: String): Option[Float]
    Definition Classes
    ScalaGettableData
  42. def getFloatOption(index: Int): Option[Float]
    Definition Classes
    ScalaGettableByIndexData
  43. 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
  44. 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
  45. def getInetOption(name: String): Option[InetAddress]
    Definition Classes
    ScalaGettableData
  46. def getInetOption(index: Int): Option[InetAddress]
    Definition Classes
    ScalaGettableByIndexData
  47. 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
  48. 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
  49. def getIntOption(name: String): Option[Int]
    Definition Classes
    ScalaGettableData
  50. def getIntOption(index: Int): Option[Int]
    Definition Classes
    ScalaGettableByIndexData
  51. 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
  52. 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
  53. 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
  54. 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
  55. def getLongOption(name: String): Option[Long]
    Definition Classes
    ScalaGettableData
  56. def getLongOption(index: Int): Option[Long]
    Definition Classes
    ScalaGettableByIndexData
  57. 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
  58. 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
  59. 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
  60. 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
  61. def getRawCql(name: String): AnyRef

    Returns a column value by cql Name

    Returns a column value by cql Name

    Definition Classes
    GettableData
  62. 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
  63. 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
  64. def getShort(name: String): Short
    Definition Classes
    ScalaGettableData
  65. def getShort(index: Int): Short
    Definition Classes
    ScalaGettableByIndexData
  66. def getShortOption(name: String): Option[Short]
    Definition Classes
    ScalaGettableData
  67. def getShortOption(index: Int): Option[Short]
    Definition Classes
    ScalaGettableByIndexData
  68. 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
  69. 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
  70. def getStringOption(name: String): Option[String]
    Definition Classes
    ScalaGettableData
  71. def getStringOption(index: Int): Option[String]
    Definition Classes
    ScalaGettableByIndexData
  72. def getTupleValue(name: String): TupleValue

    Returns a column value of cassandra tuple type

    Returns a column value of cassandra tuple type

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

    Returns a column value of cassandra tuple type

    Returns a column value of cassandra tuple type

    Definition Classes
    ScalaGettableByIndexData
  74. def getTupleValueOption(name: String): Option[TupleValue]
    Definition Classes
    ScalaGettableData
  75. def getTupleValueOption(index: Int): Option[TupleValue]
    Definition Classes
    ScalaGettableByIndexData
  76. def getUDTValue(name: String): UDTValue

    Returns a column value of User Defined Type

    Returns a column value of User Defined Type

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

    Returns a column value of User Defined Type

    Returns a column value of User Defined Type

    Definition Classes
    ScalaGettableByIndexData
  78. def getUDTValueOption(name: String): Option[UDTValue]
    Definition Classes
    ScalaGettableData
  79. def getUDTValueOption(index: Int): Option[UDTValue]
    Definition Classes
    ScalaGettableByIndexData
  80. 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
  81. 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
  82. def getUUIDOption(name: String): Option[UUID]
    Definition Classes
    ScalaGettableData
  83. def getUUIDOption(index: Int): Option[UUID]
    Definition Classes
    ScalaGettableByIndexData
  84. 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
  85. 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
  86. def getVarIntOption(name: String): Option[BigInt]
    Definition Classes
    ScalaGettableData
  87. def getVarIntOption(index: Int): Option[BigInt]
    Definition Classes
    ScalaGettableByIndexData
  88. def hashCode(): Int
    Definition Classes
    GettableData → GettableByIndexData → AnyRef → Any
  89. 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
  90. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  91. def isNullAt(name: String): Boolean

    Returns true if column value is Cassandra null

    Returns true if column value is Cassandra null

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

    Returns true if column value is Cassandra null

    Returns true if column value is Cassandra null

    Definition Classes
    GettableByIndexData
  93. def iterator: Iterator[AnyRef]
    Definition Classes
    ScalaGettableByIndexData
  94. 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
  95. val metaData: CassandraRowMetadata
    Definition Classes
    CassandraRow → GettableData
  96. def nameOf(index: Int): String

    Returns the name of the i-th column.

    Returns the name of the i-th column.

    Definition Classes
    GettableData
  97. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  98. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  99. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  100. 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
  101. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  102. def toMap: Map[String, Any]

    Converts this row to a Map

    Converts this row to a Map

    Definition Classes
    ScalaGettableData
  103. def toString(): String
    Definition Classes
    CassandraRow → GettableData → GettableByIndexData → AnyRef → Any
  104. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  105. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  106. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from ScalaGettableData

Inherited from GettableData

Inherited from ScalaGettableByIndexData

Inherited from GettableByIndexData

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped