exposed-core/org.jetbrains.exposed.sql/Index

Index

data class Index(val columns: List<Column<*>>, val unique: Boolean, val customName: String? = null, val indexType: String? = null, val filterCondition: Op<Boolean>? = null, val functions: List<ExpressionWithColumnType<*>>? = null, val functionsTable: Table? = null) : DdlAware

Represents an index.

Constructors

constructor(columns: List<Column<*>>, unique: Boolean, customName: String? = null, indexType: String? = null, filterCondition: Op<Boolean>? = null, functions: List<ExpressionWithColumnType<*>>? = null, functionsTable: Table? = null)

Properties

val columns: List<Column<*>>

Columns that are part of the index.

val customName: String? = null

Optional custom name for the index.

open val ddl: List<String>

Returns the list of DDL statements that create this DdlAware instance.

filterCondition

val filterCondition: Op<Boolean>? = null

Partial index filter condition

val functions: List<ExpressionWithColumnType<*>>? = null

Functions that are part of the index.

val functionsTable: Table? = null

Table where the functional index should be defined.

val indexName: String

Name of the index.

val indexType: String? = null

Optional custom index type (e.g, BTREE or HASH)

val table: Table

Table where the index is defined.

val unique: Boolean

Whether the index in unique or not.

Functions

createStatement

open override fun createStatement(): List<String>

Returns the list of DDL statements that create this object.

open override fun dropStatement(): List<String>

Returns the list of DDL statements that drops this object.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

modifyStatement

open override fun modifyStatement(): List<String>

Returns the list of DDL statements that modify this object.

fun onlyNameDiffer(other: Index): Boolean

Returns true if the other index has the same columns and uniqueness as this index, but a different name, false otherwise

open override fun toString(): String