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

Interface IConstraint

All Superinterfaces:

ISearchPath, IStatement, ISubElement

All Known Subinterfaces:

IConstraintFk, IConstraintPk

All Known Implementing Classes:

ChConstraint, MetaConstraint, MsConstraint, MsConstraintCheck, MsConstraintFk, MsConstraintPk, PgConstraint, PgConstraintCheck, PgConstraintExclude, PgConstraintFk, PgConstraintNotNull, PgConstraintPk

public interface IConstraint
extends ISubElement

Interface for database table constraints. Provides common functionality for all constraint types including primary keys, foreign keys, unique constraints, and check constraints.

Method Summary

Modifier and Type	Method	Description
boolean	containsColumn(String name)	Checks if this constraint involves the specified column.
Collection<String>	getColumns()	Gets the columns involved in this constraint.
String	getDefinition()	Gets the SQL definition of this constraint.
default DbObjType	getStatementType()	Gets the type of this database object.
String	getTableName()	Gets the name of the table this constraint belongs to.
default boolean	isPrimaryKey()	Checks if this constraint is a primary key constraint.

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

getDatabase, getSchemaName

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, toObjectReference

Method Details

isPrimaryKey

default boolean isPrimaryKey()

Checks if this constraint is a primary key constraint.

Returns:

true if this is a primary key constraint

getDefinition

String getDefinition()

Gets the SQL definition of this constraint.

Returns:

the constraint definition

getColumns

Collection<String> getColumns()

Gets the columns involved in this constraint.

Returns:

a collection of column names

containsColumn

boolean containsColumn(String name)

Checks if this constraint involves the specified column.

Parameters:

name - the column name to check

Returns:

true if the column is part of this constraint

getTableName

String getTableName()

Gets the name of the table this constraint belongs to.

Returns:

the table name

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