Class/Object

com.datastax.spark.connector.types

UserDefinedType

Related Docs: object UserDefinedType | package types

Permalink

case class UserDefinedType(name: String, columns: IndexedSeq[UDTFieldDef]) extends StructDef with ColumnType[UDTValue] with Product with Serializable

A Cassandra user defined type metadata. A UDT consists of a sequence of ordered fields, called columns.

Linear Supertypes
Product, Equals, ColumnType[UDTValue], StructDef, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UserDefinedType
  2. Product
  3. Equals
  4. ColumnType
  5. StructDef
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UserDefinedType(name: String, columns: IndexedSeq[UDTFieldDef])

    Permalink

Type Members

  1. type Column = FieldDef

    Permalink

    Allows to specify concrete type of column in subclasses, so that columns and columnByName members return concrete types.

    Allows to specify concrete type of column in subclasses, so that columns and columnByName members return concrete types. Columns in tables may carry more information than columns in user defined types.

    Definition Classes
    UserDefinedTypeStructDef
  2. type ValueRepr = UDTValue

    Permalink

    Type of the data described by this struct

    Type of the data described by this struct

    Definition Classes
    UserDefinedTypeStructDef

Value Members

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def columnByIndex(index: Int): Column

    Permalink

    For quickly finding a column definition by index.

    For quickly finding a column definition by index. If column is not found, throws NoSuchElementException with information about the requested index of the column and name of the structure.

    Definition Classes
    StructDef
  9. def columnByName: Map[String, Column]

    Permalink

    For quickly finding a column definition by name.

    For quickly finding a column definition by name. If column is not found, throws NoSuchElementException with information about the name of the column and name of the structure.

    Definition Classes
    StructDef
  10. lazy val columnNames: IndexedSeq[String]

    Permalink

    Names of the columns, in the same order as column definitions.

    Names of the columns, in the same order as column definitions.

    Definition Classes
    StructDef
  11. lazy val columnRefs: IndexedSeq[ColumnRef]

    Permalink

    References to the columns

    References to the columns

    Definition Classes
    StructDef
  12. lazy val columnTypes: IndexedSeq[ColumnType[_]]

    Permalink

    Types of the columns, in the same order as column names and column definitions.

    Types of the columns, in the same order as column names and column definitions.

    Definition Classes
    StructDef
  13. val columns: IndexedSeq[UDTFieldDef]

    Permalink

    Sequence of column definitions in this data structure.

    Sequence of column definitions in this data structure. The order of the columns is implementation-defined.

    Definition Classes
    UserDefinedTypeStructDef
  14. def converterToCassandra: NullableTypeConverter[UDTValue]

    Permalink

    Returns a converter that converts this column to type that can be saved by TableWriter.

    Returns a converter that converts this column to type that can be saved by TableWriter.

    Definition Classes
    UserDefinedTypeColumnType
  15. lazy val converterToScala: TypeConverter[UDTValue]

    Permalink

    Returns a converter that converts values to the Scala type associated with this column.

    Returns a converter that converts values to the Scala type associated with this column.

    Definition Classes
    ColumnType
  16. def cqlTypeName: String

    Permalink

    Name of the CQL type.

    Name of the CQL type. Useful for CQL generation.

    Definition Classes
    UserDefinedTypeColumnType
  17. def ensuring(cond: (UserDefinedType) ⇒ Boolean, msg: ⇒ Any): UserDefinedType

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  22. val fieldConverters: IndexedSeq[TypeConverter[_ <: AnyRef]]

    Permalink
  23. def finalize(): Unit

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from UserDefinedType to StringFormat[UserDefinedType] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  26. def isCollection: Boolean

    Permalink
    Definition Classes
    UserDefinedTypeColumnType
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def missingColumns(columnsToCheck: Seq[ColumnRef]): Seq[ColumnRef]

    Permalink

    Returns the columns that are not present in the structure.

    Returns the columns that are not present in the structure.

    Definition Classes
    StructDef
  29. val name: String

    Permalink

    Human-readable name for easy identification of this structure.

    Human-readable name for easy identification of this structure. Used in the error message when the column is not found. E.g. a table name or a type name.

    Definition Classes
    UserDefinedTypeStructDef
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. def newInstance(columnValues: Any*): UDTValue

    Permalink

    Creates new instance of this struct.

    Creates new instance of this struct. Column values must be given in the same order as columnNames

    Definition Classes
    UserDefinedTypeStructDef
  32. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. def scalaTypeName: String

    Permalink

    Name of the Scala type.

    Name of the Scala type. Useful for source generation.

    Definition Classes
    ColumnType
  35. def scalaTypeTag: scala.reflect.api.JavaUniverse.TypeTag[UDTValue]

    Permalink

    Returns the TypeTag of the Scala type recommended to represent values of this column.

    Returns the TypeTag of the Scala type recommended to represent values of this column.

    Definition Classes
    UserDefinedTypeColumnType
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def [B](y: B): (UserDefinedType, B)

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

Inherited from Product

Inherited from Equals

Inherited from ColumnType[UDTValue]

Inherited from StructDef

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped