Package io.ebeaninternal.dbmigration.model

Class MIndex

java.lang.Object

io.ebeaninternal.dbmigration.model.MIndex

public class MIndex
extends Object

Index as part of the logical model.

Constructor Summary

Constructors

Constructor	Description
MIndex(CreateIndex createIndex)
MIndex(String indexName, String tableName, String columnName)	Create a single column non unique index.
MIndex(String indexName, String tableName, String[] columnNames)	Create a multi column non unique index.
MIndex(String indexName, String tableName, String[] columnNames, String platforms, boolean unique, boolean concurrent, String definition)

Method Summary

Modifier and Type	Method	Description
void	compare(ModelDiff modelDiff, MIndex newIndex)	Compare with an index of the same name.
CreateIndex	createIndex()	Return a CreateIndex migration for this index.
DropIndex	dropIndex()	Create a DropIndex migration for this index.
List<String>	getColumns()	Return the columns in the index (in order).
String	getIndexName()	Return the index name.
String	getKey()
String	getTableName()	Return the table this index is on.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MIndex

public MIndex(String indexName,
              String tableName,
              String columnName)

Create a single column non unique index.

MIndex

public MIndex(String indexName,
              String tableName,
              String[] columnNames)

Create a multi column non unique index.

MIndex

public MIndex(String indexName,
              String tableName,
              String[] columnNames,
              String platforms,
              boolean unique,
              boolean concurrent,
              String definition)

MIndex

public MIndex(CreateIndex createIndex)

Method Detail

getKey

public String getKey()

getIndexName

public String getIndexName()

Return the index name.

getTableName

public String getTableName()

Return the table this index is on.

getColumns

public List<String> getColumns()

Return the columns in the index (in order).

createIndex

public CreateIndex createIndex()

Return a CreateIndex migration for this index.

dropIndex

public DropIndex dropIndex()

Create a DropIndex migration for this index.

compare

public void compare(ModelDiff modelDiff,
                    MIndex newIndex)

Compare with an index of the same name.