Liquibase 4.26.0 · liquibase.change.core.OutputChange

Modifier and Type	Field and Description
private String	message
private String	target

Modifier and Type

Field and Description

private String

message

private String

target

Access	Constructor and Description
public	OutputChange()

Access

Constructor and Description

public

OutputChange()

Modifier and Type	Method and Description
protected Change[]	createInverses() Overrides liquibase.change.AbstractChange.createInverses. Create inverse changes that can roll back this change.
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	getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed.
public String	getMessage()
public Object	getSerializableFieldValue(String field) Overrides liquibase.change.AbstractChange.getSerializableFieldValue. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public String	getTarget()
public void	setMessage(String message)
public void	setTarget(String target)
public ValidationErrors	validate(Database database) Overrides liquibase.change.AbstractChange.validate. Implements liquibase.change.Change.validate. Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the `liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)` method on the `SqlStatement` objects returned by `generateStatements`.

Modifier and Type

Method and Description

protected Change[]

createInverses()

Overrides liquibase.change.AbstractChange.createInverses.

Create inverse changes that can roll back this change.

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

getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Confirmation message to be displayed after the change is executed.

public String

getMessage()

public Object

getSerializableFieldValue(String field)

Overrides liquibase.change.AbstractChange.getSerializableFieldValue.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.

public String

getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

public String

getTarget()

public void

setMessage(String message)

public void

setTarget(String target)

public ValidationErrors

validate(Database database)

Overrides liquibase.change.AbstractChange.validate.

Implements liquibase.change.Change.validate.

message	back to summary
private String message

message

back to summary

private String message

target	back to summary
private String target

target

back to summary

private String target

OutputChange	back to summary
public OutputChange()

OutputChange

back to summary

public OutputChange()

Method Detail

createInverses back to summary

createInverses	back to summary
protected Change[] createInverses() Overrides liquibase.change.AbstractChange.createInverses. Doc from liquibase.change.AbstractChange.createInverses. Create inverse changes that can roll back this change. This method is intended to be overridden by Change implementations that have a logical inverse operation. Default implementation returns null. If `generateRollbackStatements(liquibase.database.Database)` is overridden, this method may not be called. Returns:Change[] Return null if there is no corresponding inverse and therefore automatic rollback is not possible. Return an empty array to have a no-op rollback. Annotations @Override

protected Change[] createInverses()

Overrides liquibase.change.AbstractChange.createInverses.

Doc from liquibase.change.AbstractChange.createInverses.

Create inverse changes that can roll back this change. This method is intended to be overridden by Change implementations that have a logical inverse operation. Default implementation returns null.

If generateRollbackStatements(liquibase.database.Database) is overridden, this method may not be called.

Returns:Change[]

Return null if there is no corresponding inverse and therefore automatic rollback is not possible. Return an empty array to have a no-op rollback.

Annotations

@Override

generateStatements back to summary

generateStatements	back 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

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

getConfirmationMessage	back 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

getConfirmationMessage

back 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

getMessage	back to summary
public String getMessage() Annotations @DatabaseChangeProperty description:Message to send to output exampleValue:Make sure you feed the cat serializationType:DIRECT_VALUE

getSerializableFieldValue	back to summary
public Object getSerializableFieldValue(String field) Overrides liquibase.change.AbstractChange.getSerializableFieldValue. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue. Annotations @Override

getSerializableFieldValue

back to summary

public Object getSerializableFieldValue(String field)

Overrides liquibase.change.AbstractChange.getSerializableFieldValue.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.

Annotations

@Override

getSerializedObjectNamespace	back to summary
public String getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace. Annotations @Override

getSerializedObjectNamespace

back to summary

public String getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations

@Override

getTarget	back to summary
public String getTarget() Annotations @DatabaseChangeProperty description:Target for message. Possible values: STDOUT, STDERR, FATAL, WARN, INFO, DEBUG. Default: STDERR exampleValue:STDERR

setMessage	back to summary
public void setMessage(String message)

setTarget	back to summary
public void setTarget(String target)

validate back to summary

validate	back to summary
public ValidationErrors validate(Database database) Overrides liquibase.change.AbstractChange.validate. Implements liquibase.change.Change.validate. Doc from liquibase.change.AbstractChange.validate. Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the `liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)` method on the `SqlStatement` objects returned by `generateStatements`. If no or null SqlStatements are returned by generateStatements then this method returns no errors. If there are no parameters than this method returns no errors Annotations @Override

public ValidationErrors validate(Database database)

Overrides liquibase.change.AbstractChange.validate.

Implements liquibase.change.Change.validate.

Doc from liquibase.change.AbstractChange.validate.

Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by generateStatements. If no or null SqlStatements are returned by generateStatements then this method returns no errors. If there are no parameters than this method returns no errors

Annotations

@Override

public Class OutputChange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail