DbSchema/com.wisecoders.dbs.schema/Index

Index

class Index @JvmOverloads constructor(table: AbstractTable, name: String, isVirtual: Boolean = false) : AbstractUnit, DbUnit

Represent an index on columns

Constructors

@JvmOverloads

constructor(table: AbstractTable, name: String, isVirtual: Boolean = false)

Types

object Companion

Properties

open override val children: List<TreeUnit>

val columns: Folder<Column>

open override var comment: String?

val commentNotNull: String

open override var commentTags: Map<String, String>

isMarkedForDeletion

open override val isMarkedForDeletion: Boolean

val isUnique: Boolean

open override var isVirtual: Boolean

open var key: String

open override var mutatedAt: Long

open override var name: String

open override val parent: TreeUnit

var priorName: String?

open override val symbolicName: String

open var syncFolders: List<List<AbstractUnit>>

var type: IndexType

Functions

fun addColumn(col: Column?)

areColumnsMandatory

fun areColumnsMandatory(): Boolean

clearAttributes

fun clearAttributes()

open operator override fun compareTo(other: AbstractUnit): Int

open override fun getByName(name: String): TreeUnit?

getColumnOptions

fun getColumnOptions(): Map<Column, String>?

fun getColumnOptions(column: Column): String?

fun getColumns(): List<Column>

open override fun getDbId(): String

open override fun getDisplayName(diagram: Diagram): String

fun getEntity(): AbstractTable

open override fun getIcon(): ERROR CLASS: Symbol not found for Icon

fun getOptions(): String?

getPropertyAddOnFolder

fun getPropertyAddOnFolder(name: String?): PropertyAddOnFolder?

open override fun getSchema(): Schema

getSpecificationOptions

fun getSpecificationOptions(): String?

hasColumnOption

fun hasColumnOption(column: Column, option: String): Boolean

markForDeletion

open override fun markForDeletion()

Call this method to mark a unit (table, column) to be deleted. It can be called from any thread. The effective deletion is done by calling project.refresh() or schema.refresh() on JavaFX GUI thread.

fun matches(unit: AbstractUnit?): Boolean

fun mergeFrom(source: Index)

open override fun ref(): String

open override fun refresh()

fun rename(newName: String): Boolean

fun sameAs(unit: AbstractUnit): Boolean

open override fun sameAs(unit: AbstractUnit, considerRenaming: Boolean): Boolean

setColumnOptions

fun setColumnOptions(column: Column, propertyValue: String?)

open override fun setCommentTag(key: String, value: String?)

fun setOptions(options: String?)

setSpecificationOptions

fun setSpecificationOptions(options: String?)

open override fun toString(): String