Module io.github.mmm.orm

Package io.github.mmm.orm.metadata

Interface DbIndex

All Superinterfaces:

DbObject

All Known Implementing Classes:

DbIndexImpl

public interface DbIndex
extends DbObject

Interface for a foreign key of a DbTable.

Method Summary

Modifier and Type	Method	Description
DbObjectContainer<DbColumn>	getColumns()
io.github.mmm.base.sort.SortOrder	getSortOrder()

Methods inherited from interface io.github.mmm.orm.metadata.DbObject

getName

Method Details

getSortOrder

io.github.mmm.base.sort.SortOrder getSortOrder()

Returns:

the SortOrder or null if undefined (sequence is not supported or index is statistic).

getColumns

DbObjectContainer<DbColumn> getColumns()

Returns:

the container with the indexed columns. A simple index is only indexing a single column. However, an index that indexes multiple columns is quite common.