com.datastax.spark.connector

CassandraRow

class CassandraRow extends 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, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CassandraRow
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CassandraRow(data: Array[AnyRef], columnNames: Array[String])

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

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

  5. def ->[B](y: B): (CassandraRow, B)

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

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  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.

    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.

  11. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (CassandraRow) ⇒ Boolean): CassandraRow

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

  13. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): CassandraRow

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

  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  18. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from CassandraRow to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  19. 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.

  20. 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.

  21. def getAny(name: String): Any

  22. def getAny(index: Int): Any

    Returns a column value without applying any conversion.

    Returns a column value without applying any conversion. The underlying type is the same as the type returned by the low-level Cassandra driver.

  23. def getAnyOption(name: String): Option[Any]

  24. def getAnyOption(index: Int): Option[Any]

    Returns a column value without applying any conversion, besides converting a null to a None.

    Returns a column value without applying any conversion, besides converting a null to a None. The underlying type is the same as the type returned by the low-level Cassandra driver.

  25. def getAnyRef(name: String): AnyRef

  26. def getAnyRef(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.

  27. def getAnyRefOption(name: String): Option[AnyRef]

  28. def getAnyRefOption(index: Int): Option[AnyRef]

    Returns a column value without applying any conversion, besides converting a null to a None.

    Returns a column value without applying any conversion, besides converting a null to a None. The underlying type is the same as the type returned by the low-level Cassandra driver.

  29. def getBool(name: String): Boolean

  30. def getBool(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.

  31. def getBoolOption(name: String): Option[Boolean]

  32. def getBoolOption(index: Int): Option[Boolean]

  33. def getBytes(name: String): ByteBuffer

  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.

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

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

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

    Definition Classes
    AnyRef → Any

  38. def getDate(name: String): Date

  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:

    row.get[java.sql.Date](0)
row.get[org.joda.time.DateTime](0)

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

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

  42. def getDecimal(name: String): BigDecimal

  43. 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.

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

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

  46. def getDouble(name: String): Double

  47. 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.

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

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

  50. def getFloat(name: String): Float

  51. 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.

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

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

  54. def getInet(name: String): InetAddress

  55. 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.

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

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

  58. def getInt(name: String): Int

  59. 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.

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

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

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

  63. 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.

  64. def getLong(name: String): Long

  65. 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.

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

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

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

  69. 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.

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

  71. 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.

  72. def getString(name: String): String

  73. 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.

  74. def getStringOption(name: String): Option[String]

  75. def getStringOption(index: Int): Option[String]

  76. def getUUID(name: String): UUID

  77. 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.

  78. def getUUIDOption(name: String): Option[UUID]

  79. def getUUIDOption(index: Int): Option[UUID]

  80. def getVarInt(name: String): BigInt

  81. 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.

  82. def getVarIntOption(name: String): Option[BigInt]

  83. def getVarIntOption(index: Int): Option[BigInt]

  84. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  85. def indexOf(name: String): Int

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

  86. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  87. def isNull(name: String): Boolean

    Returns true if column value is Cassandra null

  88. def isNull(index: Int): Boolean

    Returns true if column value is Cassandra null

  89. def nameOf(index: Int): String

    Returns the name of the i-th column.

  90. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  91. final def notify(): Unit

    Definition Classes
    AnyRef

  92. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  93. def size: Int

    Total number of columns in this row.

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

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

    Definition Classes
    AnyRef

  95. def toMap: Map[String, Any]

    Converts this row to a Map

  96. def toString(): String

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

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

    Definition Classes
    CassandraRow → AnyRef → Any

  97. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  99. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  100. def →[B](y: B): (CassandraRow, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from CassandraRow to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cassandraRow: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from CassandraRow to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cassandraRow: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: CassandraRow

    Implicit information
    This member is added by an implicit conversion from CassandraRow to ArrowAssoc[CassandraRow] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cassandraRow: ArrowAssoc[CassandraRow]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: CassandraRow

    Implicit information
    This member is added by an implicit conversion from CassandraRow to Ensuring[CassandraRow] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cassandraRow: Ensuring[CassandraRow]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CassandraRow to StringAdd

Inherited by implicit conversion any2stringfmt from CassandraRow to StringFormat

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

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

Ungrouped