Liquibase 4.26.0 · liquibase.change.core.CreateViewChange

Modifier and Type	Field and Description
private String	catalogName
private String	encoding
private Boolean	fullDefinition
private String	path
private Boolean	relativeToChangelogFile
private String	remarks
private Boolean	replaceIfExists
private String	schemaName
private String	selectQuery
private String	viewName

Access	Constructor and Description
public	CreateViewChange()

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 Change[]	createInverses() Overrides liquibase.change.AbstractChange.createInverses. Create inverse changes that can roll back this change.
protected CreateViewStatement	createViewStatement(String catalogName, String schemaName, String viewName, String selectQuery, boolean replaceIfExists)
protected void	customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Overrides liquibase.change.AbstractChange.customLoadLogic.
public CheckSum	generateCheckSum() Overrides liquibase.change.AbstractChange.generateCheckSum. Implements liquibase.change.Change.generateCheckSum. Calculates the checksum based on the contained SQL.
private CheckSum	generateCheckSumLatest(ChecksumVersion version)
private CheckSum	generateCheckSumV8() Deprecated
public SqlStatement[]	generateStatements(Database database) Implements liquibase.change.Change.generateStatements. Generates the `SqlStatement` objects required to run the change for the given 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	getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed.
public String	getEncoding()
public String[]	getExcludedFieldFilters(ChecksumVersion version) Overrides liquibase.change.AbstractChange.getExcludedFieldFilters.
public Boolean	getFullDefinition()
public String	getPath()
public Boolean	getRelativeToChangelogFile()
public String	getRemarks()
public Boolean	getReplaceIfExists()
public String	getSchemaName()
public String	getSelectQuery()
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public String	getViewName()
protected InputStream	openSqlStream()
public void	setCatalogName(String catalogName)
public void	setEncoding(String encoding)
public void	setFullDefinition(Boolean fullDefinition)
public void	setPath(String path)
public void	setRelativeToChangelogFile(Boolean relativeToChangelogFile)
public void	setRemarks(String remarks)
public void	setReplaceIfExists(Boolean replaceIfExists) Implements liquibase.change.ReplaceIfExists.setReplaceIfExists.
public void	setSchemaName(String schemaName)
public void	setSelectQuery(String selectQuery)
public void	setViewName(String viewName)
private boolean	supportsReplaceIfExistsOption(Database database)
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

encoding	back to summary
private String encoding

fullDefinition	back to summary
private Boolean fullDefinition

path	back to summary
private String path

relativeToChangelogFile	back to summary
private Boolean relativeToChangelogFile

remarks	back to summary
private String remarks

replaceIfExists	back to summary
private Boolean replaceIfExists

schemaName	back to summary
private String schemaName

selectQuery	back to summary
private String selectQuery

viewName	back to summary
private String viewName

CreateViewChange	back to summary
public CreateViewChange()

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

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

createViewStatement	back to summary
protected CreateViewStatement createViewStatement(String catalogName, String schemaName, String viewName, String selectQuery, boolean replaceIfExists)

customLoadLogic	back to summary
protected void customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException Overrides liquibase.change.AbstractChange.customLoadLogic. Annotations @Override

customLoadLogic

back to summary

protected void customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException

Overrides liquibase.change.AbstractChange.customLoadLogic.

Annotations

@Override

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(ChecksumVersion)`

public CheckSum generateCheckSum()

Overrides liquibase.change.AbstractChange.generateCheckSum.

Implements liquibase.change.Change.generateCheckSum.

Calculates the checksum based on the contained SQL.

Annotations

@Override

generateCheckSumLatest	back to summary
private CheckSum generateCheckSumLatest(ChecksumVersion version)

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

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

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 since:3.0 description:Name of the database catalog

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

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

getExcludedFieldFilters	back to summary
public String[] getExcludedFieldFilters(ChecksumVersion version) Overrides liquibase.change.AbstractChange.getExcludedFieldFilters. Annotations @Override

getExcludedFieldFilters

back to summary

public String[] getExcludedFieldFilters(ChecksumVersion version)

Overrides liquibase.change.AbstractChange.getExcludedFieldFilters.

Annotations

@Override

getFullDefinition	back to summary
public Boolean getFullDefinition() Annotations @DatabaseChangeProperty since:3.3 description:Set to true if selectQuery is the entire view definition. Set to false if the CREATE VIEW header should be added

getPath	back to summary
public String getPath() Annotations @DatabaseChangeProperty description:Path to the file containing the view definition. Specifying \'path\' is an alternative to selectQuery. since:3.6

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

getRemarks	back to summary
public String getRemarks() Annotations @DatabaseChangeProperty description:A brief descriptive comment stored in the view metadata

getReplaceIfExists	back to summary
public Boolean getReplaceIfExists() Annotations @DatabaseChangeProperty description:Use \'CREATE OR REPLACE\' syntax since:1.5

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

getSelectQuery	back to summary
public String getSelectQuery() Annotations @DatabaseChangeProperty serializationType:DIRECT_VALUE description:SQL for generating the view exampleValue:SELECT id, name FROM person WHERE id > 10

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

getViewName	back to summary
public String getViewName() Annotations @DatabaseChangeProperty description:Name of the view to create

openSqlStream	back to summary
protected InputStream openSqlStream() throws IOException

setCatalogName	back to summary
public void setCatalogName(String catalogName)

setEncoding	back to summary
public void setEncoding(String encoding)

setFullDefinition	back to summary
public void setFullDefinition(Boolean fullDefinition)

setPath	back to summary
public void setPath(String path)

setRelativeToChangelogFile	back to summary
public void setRelativeToChangelogFile(Boolean relativeToChangelogFile)

setRemarks	back to summary
public void setRemarks(String remarks)

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)

setSelectQuery	back to summary
public void setSelectQuery(String selectQuery)

setViewName	back to summary
public void setViewName(String viewName)

supportsReplaceIfExistsOption	back to summary
private boolean supportsReplaceIfExistsOption(Database database)

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 CreateViewChange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail