Top Description Fields Constructors Methods
liquibase.change.core

public Class DropForeignKeyConstraintChange

extends AbstractChange
Class Inheritance
Annotations
@DatabaseChange
name:dropForeignKeyConstraint
description:Drops an existing foreign key
priority:1
appliesTo:foreignKey
Imports
liquibase.change.*, liquibase.database.Database, liquibase.snapshot.SnapshotGeneratorFactory, liquibase.statement.SqlStatement, liquibase.statement.core.DropForeignKeyConstraintStatement, liquibase.structure.core.ForeignKey
Drops an existing foreign key constraint.

Field Summary

Modifier and TypeField and Description
private String
baseTableCatalogName

private String
baseTableName

private String
baseTableSchemaName

private String
constraintName

Inherited from liquibase.change.AbstractChange:
NODENAME_COLUMN

Constructor Summary

AccessConstructor and Description
public
DropForeignKeyConstraintChange()

Method Summary

Modifier and TypeMethod and Description
public ChangeStatus
checkStatus(Database database)

Overrides liquibase.change.AbstractChange.checkStatus.

Implements liquibase.change.Change.checkStatus.

Validate that this change executed successfully against the given database.

public SqlStatement[]
generateStatements(Database database)

Implements liquibase.change.Change.generateStatements.

Generates the SqlStatement objects required to run the change for the given database.

public String
getBaseTableCatalogName()

public String
getBaseTableName()

public String
getBaseTableSchemaName()

public String
getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Confirmation message to be displayed after the change is executed.

public String
getConstraintName()

public String
getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

public void
setBaseTableCatalogName(String baseTableCatalogName)

public void
setBaseTableName(String baseTableName)

public void
setBaseTableSchemaName(String baseTableSchemaName)

public void
setConstraintName(String constraintName)

Inherited from liquibase.change.AbstractChange:
createChangeMetaDatacreateChangeParameterMetadatacreateDescriptionMetaDatacreateEmptyColumnConfigcreateExampleValueMetaDatacreateInversescreateMustEqualExistingMetaDatacreateRequiredDatabasesMetaDatacreateSerializationTypeMetaDatacreateSinceMetaDatacreateSupportedDatabasesMetaDatacustomLoadLogicequalsfinishInitializationgenerateCheckSumgenerateRollbackStatementsgenerateRollbackStatementsVolatilegenerateStatementsVolatilegetAffectedDatabaseObjectsgetChangeSetgetDescriptiongetExcludedFieldFiltersgetResourceAccessorgetSerializableFieldNamespacegetSerializableFieldsgetSerializableFieldTypegetSerializableFieldValuegetSerializedObjectNamehashCodeisInvalidPropertyloadmodifyserializeserializeValuesetChangeSetsetResourceAccessorshouldExecuteChangesupportssupportsRollbacktoStringvalidatewarn

Field Detail

baseTableCatalogNameback to summary
private String baseTableCatalogName
baseTableNameback to summary
private String baseTableName
baseTableSchemaNameback to summary
private String baseTableSchemaName
constraintNameback to summary
private String constraintName

Constructor Detail

DropForeignKeyConstraintChangeback to summary
public DropForeignKeyConstraintChange()

Method Detail

checkStatusback to summary
public ChangeStatus checkStatus(Database database)

Overrides liquibase.change.AbstractChange.checkStatus.

Implements liquibase.change.Change.checkStatus.

Doc from liquibase.change.Change.checkStatus.

Validate that this change executed successfully against the given database. This will check that the update completed at a high level plus check details of the change. For example, a change to add a column will check that the column exists plus data type, default values, etc.

Annotations
@Override
generateStatementsback to summary
public SqlStatement[] generateStatements(Database database)

Implements liquibase.change.Change.generateStatements.

Doc from liquibase.change.Change.generateStatements.

Generates the SqlStatement objects required to run the change for the given database.

NOTE: This method may be called multiple times throughout the changelog execution process and may be called in documentation generation and other integration points as well.

If this method reads from the current database state or uses any other logic that will be affected by whether previous changeSets have ran or not, you must return true from generateStatementsVolatile.
Annotations
@Override
getBaseTableCatalogNameback to summary
public String getBaseTableCatalogName()
Annotations
@DatabaseChangeProperty
mustEqualExisting:foreignKey.table.catalog
since:3.0
description:Name of the database catalog of the base table
getBaseTableNameback to summary
public String getBaseTableName()
Annotations
@DatabaseChangeProperty
mustEqualExisting:foreignKey.table
description:Name of the table containing the column constrained by the foreign key
getBaseTableSchemaNameback to summary
public String getBaseTableSchemaName()
Annotations
@DatabaseChangeProperty
mustEqualExisting:foreignKey.table.schema
description:Name of the database schema of the base table
getConfirmationMessageback to summary
public String getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Doc from liquibase.change.Change.getConfirmationMessage.

Confirmation message to be displayed after the change is executed. Should include relevant configuration settings to make it as helpful as possible. This method may be called outside the changelog execution process, such as in documentation generation.

Annotations
@Override
getConstraintNameback to summary
public String getConstraintName()
Annotations
@DatabaseChangeProperty
mustEqualExisting:foreignKey
description:Name of the foreign key constraint to drop
exampleValue:fk_address_person
getSerializedObjectNamespaceback to summary
public String getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations
@Override
setBaseTableCatalogNameback to summary
public void setBaseTableCatalogName(String baseTableCatalogName)
setBaseTableNameback to summary
public void setBaseTableName(String baseTableName)
setBaseTableSchemaNameback to summary
public void setBaseTableSchemaName(String baseTableSchemaName)
setConstraintNameback to summary
public void setConstraintName(String constraintName)