schemacrawler.schema

Interface ForeignKey

All Superinterfaces:

AttributedObject, Comparable<NamedObject>, ContainedObject<Table>, DatabaseObject, DefinedObject, DependantObject<Table>, DescribedObject, Iterable<ColumnReference>, NamedObject, Serializable, TableConstraint, TableReference, TypedObject<TableConstraintType>

public interface ForeignKey
extends TableReference

Represents a foreign-key mapping to a primary key in another table.

Method Summary

Modifier and Type	Method and Description
ForeignKeyDeferrability	getDeferrability() Gets the deferrability.
ForeignKeyUpdateRule	getDeleteRule() Gets the delete rule.
default String	getSpecificName() Deprecated.
ForeignKeyUpdateRule	getUpdateRule() Gets the update rule.

Methods inherited from interface schemacrawler.schema.TableReference

getColumnReferences, getForeignKeyTable, getPrimaryKeyTable, getReferencedTable, getReferencingTable

Methods inherited from interface schemacrawler.schema.TableConstraint

getColumns, getConstrainedColumns, isDeferrable, isInitiallyDeferred

Methods inherited from interface schemacrawler.schema.DependantObject

getShortName, isParentPartial

Methods inherited from interface schemacrawler.schema.DatabaseObject

getSchema

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.DefinedObject

getDefinition, hasDefinition

Methods inherited from interface schemacrawler.schema.TypedObject

getType

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getDeferrability

ForeignKeyDeferrability getDeferrability()

Gets the deferrability.

Returns:

Deferrability

getDeleteRule

ForeignKeyUpdateRule getDeleteRule()

Gets the delete rule.

Returns:

Delete rule

getSpecificName

@Deprecated
default String getSpecificName()

Deprecated.

Gets a generated specific name for databases that support non-unique foreign key names.

Returns:

Specific name of a foreign key

getUpdateRule

ForeignKeyUpdateRule getUpdateRule()

Gets the update rule.

Returns:

Update rule