com.datastax.spark.connector

CassandraRow

Related Docs: object CassandraRow | package connector

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:

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:

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:

Linear Supertypes
Serializable, Serializable, ScalaGettableData, AbstractGettableData, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CassandraRow
  2. Serializable
  3. Serializable
  4. ScalaGettableData
  5. AbstractGettableData
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

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

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

    Definition Classes
    Any
  7. def clone(): AnyRef

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

  9. val columnValues: IndexedSeq[AnyRef]

  10. 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
    AbstractGettableData
  11. def copy(): ScalaGettableData

    Definition Classes
    ScalaGettableData
  12. 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
    AbstractGettableData
  13. def ensuring(cond: (CassandraRow) ⇒ Boolean, msg: ⇒ Any): CassandraRow

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

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

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

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

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

    Definition Classes
    AbstractGettableData → AnyRef → Any
  19. def fieldNames: IndexedSeq[String]

    Attributes
    protected
    Definition Classes
    CassandraRowAbstractGettableData
  20. def fieldValues: IndexedSeq[AnyRef]

    Attributes
    protected
    Definition Classes
    CassandraRowAbstractGettableData
  21. def finalize(): Unit

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

    Implicit information
    This member is added by an implicit conversion from CassandraRow to StringFormat[CassandraRow] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. 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
  24. 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
    ScalaGettableData
  25. def getBoolean(name: String): Boolean

    Definition Classes
    ScalaGettableData
  26. 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
    ScalaGettableData
  27. def getBooleanOption(name: String): Option[Boolean]

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

    Definition Classes
    ScalaGettableData
  29. def getByte(name: String): Byte

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

    Definition Classes
    ScalaGettableData
  31. def getByteOption(name: String): Option[Byte]

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

    Definition Classes
    ScalaGettableData
  33. def getBytes(name: String): ByteBuffer

    Definition Classes
    ScalaGettableData
  34. 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
    ScalaGettableData
  35. def getBytesOption(name: String): Option[ByteBuffer]

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

    Definition Classes
    ScalaGettableData
  37. final def getClass(): Class[_]

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

    Definition Classes
    ScalaGettableData
  39. 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
    ScalaGettableData
  40. def getDateOption(name: String): Option[Date]

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

    Definition Classes
    ScalaGettableData
  42. def getDateTime(name: String): DateTime

    Definition Classes
    ScalaGettableData
  43. 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
    ScalaGettableData
  44. def getDateTimeOption(name: String): Option[DateTime]

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

    Definition Classes
    ScalaGettableData
  46. def getDecimal(name: String): BigDecimal

    Definition Classes
    ScalaGettableData
  47. 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
    ScalaGettableData
  48. def getDecimalOption(name: String): Option[BigDecimal]

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

    Definition Classes
    ScalaGettableData
  50. def getDouble(name: String): Double

    Definition Classes
    ScalaGettableData
  51. 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
    ScalaGettableData
  52. def getDoubleOption(name: String): Option[Double]

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

    Definition Classes
    ScalaGettableData
  54. def getFloat(name: String): Float

    Definition Classes
    ScalaGettableData
  55. 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
    ScalaGettableData
  56. def getFloatOption(name: String): Option[Float]

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

    Definition Classes
    ScalaGettableData
  58. def getInet(name: String): InetAddress

    Definition Classes
    ScalaGettableData
  59. 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
    ScalaGettableData
  60. def getInetOption(name: String): Option[InetAddress]

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

    Definition Classes
    ScalaGettableData
  62. def getInt(name: String): Int

    Definition Classes
    ScalaGettableData
  63. 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
    ScalaGettableData
  64. def getIntOption(name: String): Option[Int]

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

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

    Definition Classes
    ScalaGettableData
  67. 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
    ScalaGettableData
  68. def getLong(name: String): Long

    Definition Classes
    ScalaGettableData
  69. 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
    ScalaGettableData
  70. def getLongOption(name: String): Option[Long]

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

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

    Definition Classes
    ScalaGettableData
  73. 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
    ScalaGettableData
  74. def getRaw(name: String): AnyRef

    Definition Classes
    ScalaGettableData
  75. 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
    ScalaGettableData
  76. def getSet[T](name: String)(implicit arg0: TypeConverter[T]): Set[T]

    Definition Classes
    ScalaGettableData
  77. 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
    ScalaGettableData
  78. def getShort(name: String): Short

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

    Definition Classes
    ScalaGettableData
  80. def getShortOption(name: String): Option[Short]

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

    Definition Classes
    ScalaGettableData
  82. def getString(name: String): String

    Definition Classes
    ScalaGettableData
  83. 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
    ScalaGettableData
  84. def getStringOption(name: String): Option[String]

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

    Definition Classes
    ScalaGettableData
  86. def getUDTValue(name: String): UDTValue

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

    Returns a column value of User Defined Type

    Returns a column value of User Defined Type

    Definition Classes
    ScalaGettableData
  88. def getUDTValueOption(name: String): Option[UDTValue]

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

    Definition Classes
    ScalaGettableData
  90. def getUUID(name: String): UUID

    Definition Classes
    ScalaGettableData
  91. 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
    ScalaGettableData
  92. def getUUIDOption(name: String): Option[UUID]

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

    Definition Classes
    ScalaGettableData
  94. def getVarInt(name: String): BigInt

    Definition Classes
    ScalaGettableData
  95. 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
    ScalaGettableData
  96. def getVarIntOption(name: String): Option[BigInt]

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

    Definition Classes
    ScalaGettableData
  98. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  99. 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
    AbstractGettableData
  100. final def isInstanceOf[T0]: Boolean

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

    Returns true if column value is Cassandra null

    Returns true if column value is Cassandra null

    Definition Classes
    AbstractGettableData
  102. def isNullAt(index: Int): Boolean

    Returns true if column value is Cassandra null

    Returns true if column value is Cassandra null

    Definition Classes
    AbstractGettableData
  103. def iterator: Iterator[AnyRef]

    Definition Classes
    ScalaGettableData
  104. def length: Int

    Total number of columns in this row.

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

    Definition Classes
    AbstractGettableData
  105. def nameOf(index: Int): String

    Returns the name of the i-th column.

    Returns the name of the i-th column.

    Definition Classes
    AbstractGettableData
  106. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  107. final def notify(): Unit

    Definition Classes
    AnyRef
  108. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  109. def size: Int

    Total number of columns in this row.

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

    Definition Classes
    AbstractGettableData
  110. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Converts this row to a Map

    Converts this row to a Map

    Definition Classes
    ScalaGettableData
  112. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  116. def [B](y: B): (CassandraRow, B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from ScalaGettableData

Inherited from AbstractGettableData

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped