scalikejdbc.metadata

Index

case class Index(name: String, columnNames: List[String], isUnique: Boolean, qualifier: Option[String], indexType: IndexType, ordinalPosition: Option[Short], ascOrDesc: Option[String], cardinality: Option[Long], pages: Option[Long], filterCondition: Option[String]) extends Product with Serializable

Index meta data.

name

name index name; null when TYPE is tableIndexStatistic

columnNames

target column names (collection of COLUMN_NAME without null values: column name; null when TYPE is tableIndexStatistic)

isUnique

unique index (opposite of NON_UNIQUE: Can index values be non-unique. false when TYPE is tableIndexStatistic)

qualifier

index catalog (may be null); null when TYPE is tableIndexStatistic

indexType

index type: tableIndexStatistic, tableIndexClustered, tableIndexHashed, tableIndexOther

ordinalPosition

column sequence number within index; zero when TYPE is tableIndexStatistic

ascOrDesc

column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic

cardinality

When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.

pages

When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.

filterCondition

Filter condition, if any. (may be null)

Source
Index.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Index
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Index(name: String, columnNames: List[String], isUnique: Boolean, qualifier: Option[String], indexType: IndexType, ordinalPosition: Option[Short], ascOrDesc: Option[String], cardinality: Option[Long], pages: Option[Long], filterCondition: Option[String])

    name

    name index name; null when TYPE is tableIndexStatistic

    columnNames

    target column names (collection of COLUMN_NAME without null values: column name; null when TYPE is tableIndexStatistic)

    isUnique

    unique index (opposite of NON_UNIQUE: Can index values be non-unique. false when TYPE is tableIndexStatistic)

    qualifier

    index catalog (may be null); null when TYPE is tableIndexStatistic

    indexType

    index type: tableIndexStatistic, tableIndexClustered, tableIndexHashed, tableIndexOther

    ordinalPosition

    column sequence number within index; zero when TYPE is tableIndexStatistic

    ascOrDesc

    column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic

    cardinality

    When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.

    pages

    When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.

    filterCondition

    Filter condition, if any. (may be null)

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. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. val ascOrDesc: Option[String]

    column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic

  8. val cardinality: Option[Long]

    When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.

  9. def clone(): AnyRef

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

  10. val columnNames: List[String]

    target column names (collection of COLUMN_NAME without null values: column name; null when TYPE is tableIndexStatistic)

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

    Definition Classes
    AnyRef

  12. val filterCondition: Option[String]

    Filter condition, if any.

    Filter condition, if any. (may be null)

  13. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  15. val indexType: IndexType

    index type: tableIndexStatistic, tableIndexClustered, tableIndexHashed, tableIndexOther

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. val isUnique: Boolean

    unique index (opposite of NON_UNIQUE: Can index values be non-unique.

    unique index (opposite of NON_UNIQUE: Can index values be non-unique. false when TYPE is tableIndexStatistic)

  18. val name: String

    name index name; null when TYPE is tableIndexStatistic

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

    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  22. val ordinalPosition: Option[Short]

    column sequence number within index; zero when TYPE is tableIndexStatistic

  23. val pages: Option[Long]

    When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.

  24. val qualifier: Option[String]

    index catalog (may be null); null when TYPE is tableIndexStatistic

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

    Definition Classes
    AnyRef

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped