Package

scalikejdbc

metadata

Permalink

package metadata

Visibility
  1. Public
  2. All

Type Members

  1. case class Column(name: String, typeCode: Int, typeName: String, size: Int = 0, isRequired: Boolean = false, isPrimaryKey: Boolean = false, isAutoIncrement: Boolean = false, description: String = null, defaultValue: String = null) extends Product with Serializable

    Permalink

    Column meta data

    Column meta data

    name

    name

    typeCode

    type code(int)

    typeName

    type name

    size

    size

    isRequired

    not null

    isPrimaryKey

    primary key

    isAutoIncrement

    auto increment

    description

    comment

    defaultValue

    default value

  2. case class ForeignKey(name: String, foreignColumnName: String, foreignTableName: String) extends Product with Serializable

    Permalink

    Foreign key meta data

    Foreign key meta data

    name

    column name

    foreignColumnName

    column name on the foreign table

    foreignTableName

    foreign table name

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

    Permalink

    Index meta data.

    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)

  4. sealed trait IndexType extends AnyRef

    Permalink

    Index type.

  5. case class Table(name: String, schema: String = null, description: String = null, columns: List[Column] = List(), foreignKeys: List[ForeignKey] = List(), indices: List[Index] = List()) extends Product with Serializable

    Permalink

    Table meta data

    Table meta data

    name

    name

    schema

    schema

    description

    description

    columns

    columns

    foreignKeys

    foreign keys

    indices

    indices

Value Members

  1. object IndexType

    Permalink

Ungrouped