Index

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

Instance Constructors

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

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
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
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.
def clone(): AnyRef

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

target column names (collection of COLUMN_NAME without null values: column name; null when TYPE is tableIndexStatistic)
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val filterCondition: Option[String]

Filter condition, if any.
Filter condition, if any. (may be null)
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val indexType: IndexType

index type: tableIndexStatistic, tableIndexClustered, tableIndexHashed, tableIndexOther
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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)
val name: String

name index name; null when TYPE is tableIndexStatistic
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val ordinalPosition: Option[Short]

column sequence number within index; zero when TYPE is tableIndexStatistic
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.
val qualifier: Option[String]

index catalog (may be null); null when TYPE is tableIndexStatistic
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package metadata

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

Instance Constructors

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])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val ascOrDesc: Option[String]

val cardinality: Option[Long]

def clone(): AnyRef

val columnNames: List[String]

final def eq(arg0: AnyRef): Boolean

val filterCondition: Option[String]

def finalize(): Unit

final def getClass(): Class[_]

val indexType: IndexType

final def isInstanceOf[T0]: Boolean

val isUnique: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ordinalPosition: Option[Short]

val pages: Option[Long]

val qualifier: Option[String]

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped