scalikejdbc-core
API
Generated with
scalikejdbc-core/scalikejdbc/scalikejdbc.metadata

scalikejdbc.metadata

package scalikejdbc.metadata

Members list

Type members

Classlikes

case class Column(name: String, typeCode: Int, typeName: String, size: Int, isRequired: Boolean, isPrimaryKey: Boolean, isAutoIncrement: Boolean, description: String, defaultValue: String)

Column meta data

Column meta data

Value parameters

defaultValue

default value

description

comment

isAutoIncrement

auto increment

isPrimaryKey

primary key

isRequired

not null

name

name

size

size

typeCode

type code(int)

typeName

type name

Attributes

Source
Column.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ForeignKey(name: String, foreignColumnName: String, foreignTableName: String)

Foreign key meta data

Foreign key meta data

Value parameters

foreignColumnName

column name on the foreign table

foreignTableName

foreign table name

name

column name

Attributes

Source
ForeignKey.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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])

Index meta data.

Index meta data.

Value parameters

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.

columnNames

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

filterCondition

Filter condition, if any. (may be null)

indexType

index type: tableIndexStatistic, tableIndexClustered, tableIndexHashed, tableIndexOther

isUnique

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

name

name index name; null when TYPE is tableIndexStatistic

ordinalPosition

column sequence number within index; zero when TYPE is tableIndexStatistic

pages

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

qualifier

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

Attributes

Source
Index.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait IndexType extends Product, Serializable

Index type.

Index type.

Attributes

See also
Companion
object
Source
IndexType.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object tableIndexClustered.type
object tableIndexHashed.type
object tableIndexOther.type
object tableIndexStatistic.type
object IndexType

Attributes

Companion
trait
Source
IndexType.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
IndexType.type
case class Table(name: String, schema: String, description: String, columns: List[Column], foreignKeys: List[ForeignKey], indices: List[Index])

Table meta data

Table meta data

Value parameters

columns

columns

description

description

foreignKeys

foreign keys

indices

indices

name

name

schema

schema

Attributes

Source
Table.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with