Package org.pgcodekeeper.core.database.api.schema

Interface IIndex

All Superinterfaces:

IOptionContainer, ISearchPath, ISimpleColumnContainer, ISimpleOptionContainer, IStatement, ISubElement

All Known Implementing Classes:

ChIndex, MsIndex, PgIndex

public interface IIndex
extends ISubElement, ISimpleOptionContainer, ISimpleColumnContainer

Interface for database index

Method Summary

Modifier and Type	Method	Description
boolean	compareColumns(Collection<String> refs)	Compares the columns of this index with a collection of column references.
default DbObjType	getStatementType()	Gets the type of this database object.
boolean	isUnique()
default ObjectReference	toObjectReference()

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.IOptionContainer

addOption, getOptions

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.ISearchPath

getDatabase, getSchemaName

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.ISimpleColumnContainer

addColumn, addInclude

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.ISimpleOptionContainer

appendOptions, compareOptions

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.IStatement

addDependency, appendAlterSQL, appendOwnerSQL, canDrop, canDropBeforeCreate, clearPrivileges, compare, deepCopy, formatSql, getAuthor, getBareName, getChildren, getComment, getCreationSQL, getDependencies, getDescendants, getDropSQL, getLibName, getLocation, getName, getOwner, getParent, getPrivileges, getQualifiedName, getQuotedName, getQuoter, getRenameCommand, getSeparator, getSQL, getTwin, getTypeName, hasChildren, isLib, isOwned, quote, setComment, setLibName, setLocation, setOwner, shallowCopy

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.ISubElement

getContainingSchema

Method Details

getStatementType

default DbObjType getStatementType()

Description copied from interface: IStatement

Gets the type of this database object.

Specified by:

getStatementType in interface IStatement

Returns:

the database object type

toObjectReference

default ObjectReference toObjectReference()

Specified by:

toObjectReference in interface ISearchPath

Specified by:

toObjectReference in interface IStatement

Specified by:

toObjectReference in interface ISubElement

isUnique

boolean isUnique()

Returns:

true if unique index

compareColumns

boolean compareColumns(Collection<String> refs)

Compares the columns of this index with a collection of column references.

Parameters:

refs - the collection of column references to compare against

Returns:

true if the columns match in order and count