Liquibase 4.26.0 · liquibase.change.core.CreateProcedureChange

Modifier and Type	Field and Description
private String	catalogName
private String	comments
private String	dbms
private String	encoding
private String	path
private String	procedureName
private String	procedureText
private final String	procedureTextDescription
private Boolean	relativeToChangelogFile
private Boolean	replaceIfExists
private String	schemaName

Access	Constructor and Description
public	CreateProcedureChange()

Modifier and Type	Method 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.
protected Map<String, Object>	createExampleValueMetaData(String parameterName, DatabaseChangeProperty changePropertyAnnotation) Overrides liquibase.change.AbstractChange.createExampleValueMetaData. Create the `ChangeParameterMetaData` "example" value.
private static boolean	databaseSupportsReplaceIfExists(Database database)
public CheckSum	generateCheckSum() Overrides liquibase.change.AbstractChange.generateCheckSum. Implements liquibase.change.Change.generateCheckSum. Calculates the checksum based on the contained SQL.
protected CheckSum	generateCheckSumLatest(String sqlText)
private CheckSum	generateCheckSumV8() Deprecated
public boolean	generateRollbackStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateRollbackStatementsVolatile. Implements liquibase.change.Change.generateRollbackStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateRollbackStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements` If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.
public SqlStatement[]	generateStatements(Database database) Implements liquibase.change.Change.generateStatements. Generates the `SqlStatement` objects required to run the change for the given database.
protected SqlStatement[]	generateStatements(String logicText, String endDelimiter, Database database)
public boolean	generateStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateStatementsVolatile. Implements liquibase.change.Change.generateStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements`.
public String	getCatalogName()
public String	getComments()
public String	getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed.
public String	getDbms() Implements liquibase.change.DbmsTargetedChange.getDbms.
public String	getEncoding()
public String[]	getExcludedFieldFilters(ChecksumVersion version) Overrides liquibase.change.AbstractChange.getExcludedFieldFilters. Listing SQL content fields (for example procedureText, triggerBody, etc.) we don't want to include as part of the checksum computes, because have a separate part that computes that checksum for that part doing the "normalizing" logic, so it is not impacted by the reformatting of the SQL.
public String	getPath()
public String	getProcedureBody()
public String	getProcedureName()
public String	getProcedureText()
public Boolean	getReplaceIfExists()
public String	getSchemaName()
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public Boolean	isRelativeToChangelogFile()
public InputStream	openSqlStream()
public void	setCatalogName(String catalogName)
public void	setComments(String comments)
public void	setDbms(final String dbms) Implements liquibase.change.DbmsTargetedChange.setDbms.
public void	setEncoding(String encoding)
public void	setPath(String path)
public void	setProcedureBody(String procedureText) Deprecated Use setProcedureText() instead
public void	setProcedureName(String procedureName)
public void	setProcedureText(String procedureText)
public void	setRelativeToChangelogFile(Boolean relativeToChangelogFile)
public void	setReplaceIfExists(Boolean replaceIfExists) Implements liquibase.change.ReplaceIfExists.setReplaceIfExists.
public void	setSchemaName(String schemaName)
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`.

catalogName	back to summary
private String catalogName

comments	back to summary
private String comments

dbms	back to summary
private String dbms

encoding	back to summary
private String encoding

path	back to summary
private String path

procedureName	back to summary
private String procedureName

procedureText	back to summary
private String procedureText

procedureTextDescription	back to summary
private final String procedureTextDescription

relativeToChangelogFile	back to summary
private Boolean relativeToChangelogFile

replaceIfExists	back to summary
private Boolean replaceIfExists

schemaName	back to summary
private String schemaName

CreateProcedureChange	back to summary
public CreateProcedureChange()

Method Detail

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

checkStatus

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

createExampleValueMetaData back to summary

protected Map<String, Object> createExampleValueMetaData(String parameterName, DatabaseChangeProperty changePropertyAnnotation)

Overrides liquibase.change.AbstractChange.createExampleValueMetaData.

Doc from liquibase.change.AbstractChange.createExampleValueMetaData.

Create the ChangeParameterMetaData "example" value. Uses the value on the DatabaseChangeProperty annotation or returns null as a default. Returns map with key=database short name, value=example. Use short-name "all" as the fallback.

Annotations

@SuppressWarnings:java:S2095
@Override

databaseSupportsReplaceIfExists	back to summary
private static boolean databaseSupportsReplaceIfExists(Database database)

generateCheckSum back to summary

generateCheckSum	back to summary
public CheckSum generateCheckSum() Overrides liquibase.change.AbstractChange.generateCheckSum. Implements liquibase.change.Change.generateCheckSum. Calculates the checksum based on the contained SQL. Annotations @Override See Also `Change#generateCheckSum()`

public CheckSum generateCheckSum()

Overrides liquibase.change.AbstractChange.generateCheckSum.

Implements liquibase.change.Change.generateCheckSum.

Calculates the checksum based on the contained SQL.

Annotations

@Override

See Also

Change#generateCheckSum()

generateCheckSumLatest	back to summary
protected CheckSum generateCheckSumLatest(String sqlText)

generateCheckSumV8	back to summary
private CheckSum generateCheckSumV8() Deprecated Annotations @Deprecated

generateRollbackStatementsVolatile back to summary

generateRollbackStatementsVolatile	back to summary
public boolean generateRollbackStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateRollbackStatementsVolatile. Implements liquibase.change.Change.generateRollbackStatementsVolatile. Doc from liquibase.change.AbstractChange.generateRollbackStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateRollbackStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements` If no or null SqlStatements are returned by generateRollbackStatements then this method returns false. Annotations @Override

public boolean generateRollbackStatementsVolatile(Database database)

Overrides liquibase.change.AbstractChange.generateRollbackStatementsVolatile.

Implements liquibase.change.Change.generateRollbackStatementsVolatile.

Doc from liquibase.change.AbstractChange.generateRollbackStatementsVolatile.

Implementation delegates logic to the liquibase.sqlgenerator.SqlGenerator#generateRollbackStatementsIsVolatile(Database) method on the SqlStatement objects returned by generateStatements If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.

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

generateStatements	back to summary
protected SqlStatement[] generateStatements(String logicText, String endDelimiter, Database database)

generateStatementsVolatile back to summary

generateStatementsVolatile	back to summary
public boolean generateStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateStatementsVolatile. Implements liquibase.change.Change.generateStatementsVolatile. Doc from liquibase.change.AbstractChange.generateStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements`. If zero or null SqlStatements are returned by generateStatements then this method returns false. Annotations @Override

public boolean generateStatementsVolatile(Database database)

Overrides liquibase.change.AbstractChange.generateStatementsVolatile.

Implements liquibase.change.Change.generateStatementsVolatile.

Doc from liquibase.change.AbstractChange.generateStatementsVolatile.

Implementation delegates logic to the liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database) method on the SqlStatement objects returned by generateStatements. If zero or null SqlStatements are returned by generateStatements then this method returns false.

Annotations

@Override

getCatalogName	back to summary
public String getCatalogName() Annotations @DatabaseChangeProperty description:Name of the database catalog

getComments	back to summary
public String getComments() Annotations @DatabaseChangeProperty description:Inline comments generated by update-sql. Not applied to the database

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

getDbms	back to summary
public String getDbms() Implements liquibase.change.DbmsTargetedChange.getDbms. Returns:String Doc from liquibase.change.DbmsTargetedChange.getDbms. A comma separated list of dbms' that this change will be run for. Will run for all dbms' if empty or null. Annotations @Override @DatabaseChangeProperty exampleValue:h2, oracle since:3.1 description:Specifies which database type(s) a changeset is to be used for. See valid database type names on Supported Databases docs page. Separate multiple databases with commas. Specify that a changeset is not applicable to a particular database type by prefixing with !. The keywords \'all\' and \'none\' are also available.

getDbms

back to summary

public String getDbms()

Implements liquibase.change.DbmsTargetedChange.getDbms.

Returns:String

Doc from liquibase.change.DbmsTargetedChange.getDbms.

A comma separated list of dbms' that this change will be run for. Will run for all dbms' if empty or null.

Annotations

@Override
@DatabaseChangeProperty
exampleValue:h2, oracle
since:3.1
description:Specifies which database type(s) a changeset is to be used for. See valid database type names on Supported Databases docs page. Separate multiple databases with commas. Specify that a changeset is not applicable to a particular database type by prefixing with !. The keywords \'all\' and \'none\' are also available.

getEncoding	back to summary
public String getEncoding() Annotations @DatabaseChangeProperty exampleValue:utf8 description:Encoding used in the file you specify in \'path\'

getExcludedFieldFilters	back to summary
public String[] getExcludedFieldFilters(ChecksumVersion version) Overrides liquibase.change.AbstractChange.getExcludedFieldFilters. Listing SQL content fields (for example procedureText, triggerBody, etc.) we don't want to include as part of the checksum computes, because have a separate part that computes that checksum for that part doing the "normalizing" logic, so it is not impacted by the reformatting of the SQL. We are also excluding fields from the checksum generation which does not have a direct impact on the DB, such as dbms, path, comments, etc. Besides it has an impact on the DB, we have decided to do not add replaceIfExists as part of this list of fields as we are already avoiding the recalculation of the checksum by listing the main content fields of the different change types. Annotations @Override

getExcludedFieldFilters

back to summary

public String[] getExcludedFieldFilters(ChecksumVersion version)

Overrides liquibase.change.AbstractChange.getExcludedFieldFilters.

Listing SQL content fields (for example procedureText, triggerBody, etc.) we don't want to include as part of the checksum computes, because have a separate part that computes that checksum for that part doing the "normalizing" logic, so it is not impacted by the reformatting of the SQL. We are also excluding fields from the checksum generation which does not have a direct impact on the DB, such as dbms, path, comments, etc. Besides it has an impact on the DB, we have decided to do not add replaceIfExists as part of this list of fields as we are already avoiding the recalculation of the checksum by listing the main content fields of the different change types.

Annotations

@Override

getPath	back to summary
public String getPath() Annotations @DatabaseChangeProperty description:File containing the procedure text. You must either use this attribute or write inline SQL within the createProcedure definition. exampleValue:com/example/my-logic.sql

getProcedureBody	back to summary
public String getProcedureBody() Annotations @DatabaseChangeProperties:@liquibase.change.DatabaseChangeProperty(serializationType=DIRECT_VALUE, version={V8}), @liquibase.change.DatabaseChangeProperty(isChangeProperty=false)

getProcedureName	back to summary
public String getProcedureName() Annotations @DatabaseChangeProperty exampleValue:new_customer description:Name of the stored procedure to create. Required if replaceIfExists=true

getProcedureText	back to summary
public String getProcedureText() Annotations @DatabaseChangeProperties:@liquibase.change.DatabaseChangeProperty(description="The SQL creating the procedure. You need to define either this attribute or \'path\'. procedureText is not supported in the XML format; however, you can specify the procedure SQL inline within the createProcedure definition.", isChangeProperty=false, version={V8}), @liquibase.change.DatabaseChangeProperty(description="The SQL creating the procedure. You need to define either this attribute or \'path\'. procedureText is not supported in the XML format; however, you can specify the procedure SQL inline within the createProcedure definition.", serializationType=DIRECT_VALUE)

getProcedureText

back to summary

public String getProcedureText()

Annotations

@DatabaseChangeProperties:@liquibase.change.DatabaseChangeProperty(description="The SQL creating the procedure. You need to define either this attribute or \'path\'. procedureText is not supported in the XML format; however, you can specify the procedure SQL inline within the createProcedure definition.", isChangeProperty=false, version={V8}), @liquibase.change.DatabaseChangeProperty(description="The SQL creating the procedure. You need to define either this attribute or \'path\'. procedureText is not supported in the XML format; however, you can specify the procedure SQL inline within the createProcedure definition.", serializationType=DIRECT_VALUE)

getReplaceIfExists	back to summary
public Boolean getReplaceIfExists() Annotations @DatabaseChangeProperty description:If the stored procedure defined by createProcedure already exists, alter it instead of creating it. Default: false

getSchemaName	back to summary
public String getSchemaName() Annotations @DatabaseChangeProperty description:Name of the database schema

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

isRelativeToChangelogFile	back to summary
public Boolean isRelativeToChangelogFile() Annotations @DatabaseChangeProperty description:Specifies whether the file path is relative to the changelog file rather than looked up in the search path. Default: false.

openSqlStream	back to summary
public InputStream openSqlStream() throws IOException

setCatalogName	back to summary
public void setCatalogName(String catalogName)

setComments	back to summary
public void setComments(String comments)

setDbms	back to summary
public void setDbms(final String dbms) Implements liquibase.change.DbmsTargetedChange.setDbms. Annotations @Override

setDbms

back to summary

public void setDbms(final String dbms)

Implements liquibase.change.DbmsTargetedChange.setDbms.

Annotations

@Override

setEncoding	back to summary
public void setEncoding(String encoding)

setPath	back to summary
public void setPath(String path)

setProcedureBody	back to summary
public void setProcedureBody(String procedureText) Deprecated Use setProcedureText() instead Annotations @Deprecated

setProcedureName	back to summary
public void setProcedureName(String procedureName)

setProcedureText	back to summary
public void setProcedureText(String procedureText)

setRelativeToChangelogFile	back to summary
public void setRelativeToChangelogFile(Boolean relativeToChangelogFile)

setReplaceIfExists	back to summary
public void setReplaceIfExists(Boolean replaceIfExists) Implements liquibase.change.ReplaceIfExists.setReplaceIfExists. Annotations @Override

setReplaceIfExists

back to summary

public void setReplaceIfExists(Boolean replaceIfExists)

Implements liquibase.change.ReplaceIfExists.setReplaceIfExists.

Annotations

@Override

setSchemaName	back to summary
public void setSchemaName(String schemaName)

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 Class CreateProcedureChange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail