schemacrawler.schema

Interface Index

All Superinterfaces:

AttributedObject, Comparable<NamedObject>, ContainedObject<Table>, DatabaseObject, DefinedObject, DependantObject<Table>, DescribedObject, Iterable<IndexColumn>, NamedObject, Serializable, TypedObject<IndexType>

public interface Index
extends DependantObject<Table>, TypedObject<IndexType>, DefinedObject, Iterable<IndexColumn>

Represents an index on a database table.

Method Summary

Modifier and Type	Method and Description
long	getCardinality() Gets the cardinality.
List<IndexColumn>	getColumns() Gets the list of columns in ordinal order.
IndexType	getIndexType() Gets the index type.
long	getPages() Gets the pages.
boolean	isUnique() If the index is unique.
<C extends IndexColumn> Optional<C>	lookupColumn(String name) Gets a column by unqualified name.

Methods inherited from interface schemacrawler.schema.DependantObject

getShortName, isParentPartial

Methods inherited from interface schemacrawler.schema.DatabaseObject

getSchema, withQuoting

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getName, key

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.AttributedObject

getAttribute, getAttribute, getAttributes, hasAttribute, lookupAttribute, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.DescribedObject

getRemarks, hasRemarks, setRemarks

Methods inherited from interface schemacrawler.schema.ContainedObject

getParent

Methods inherited from interface schemacrawler.schema.TypedObject

getType

Methods inherited from interface schemacrawler.schema.DefinedObject

getDefinition, hasDefinition

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getCardinality

long getCardinality()

Gets the cardinality. When the index type is statistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.

Returns:

Cardinality

getColumns

List<IndexColumn> getColumns()

Gets the list of columns in ordinal order.

Returns:

Columns of the index.

getIndexType

IndexType getIndexType()

Gets the index type.

Returns:

Index type.

getPages

long getPages()

Gets the pages. When the index type is statistic, then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.

Returns:

Pages

isUnique

boolean isUnique()

If the index is unique.

Returns:

If the index is unique

lookupColumn

<C extends IndexColumn> Optional<C> lookupColumn(String name)

Gets a column by unqualified name.

Parameters:

name - Unqualified name

Returns:

Column.