GroovyChange (GORM for MongoDB

org.grails.plugins.databasemigration.liquibase.GroovyChange

@groovy.transform.CompileStatic
@liquibase.change.DatabaseChange(name: grailsChange, description: Executes groovy code to apply a database change., priority: ChangeMetaData.PRIORITY_DEFAULT)
class GroovyChange
extends liquibase.change.AbstractChange

Custom Groovy-based change.

Authors:: Burt Beckwith; Kazuki YAMAMOTO

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`GroovyChange.1`

Inherited fields
Fields inherited from class	Fields
`class liquibase.change.AbstractChange`	`EMPTY_CHANGE, SHOULD_EXECUTE, STANDARD_CHANGELOG_NAMESPACE, GENERIC_CHANGELOG_EXTENSION_NAMESPACE, STANDARD_SNAPSHOT_NAMESPACE, GENERIC_SNAPSHOT_EXTENSION_NAMESPACE, PRIORITY_NOT_APPLICABLE, PRIORITY_DEFAULT, PRIORITY_SPECIALIZED, PRIORITY_DATABASE`

Properties Summary

Properties
Type	Name and description
`java.util.List`	`allStatements`
`groovy.lang.Closure`	`changeClosure`
`boolean`	`changeClosureCalled`
`java.lang.String`	`checksumString`
`java.lang.String`	`confirmationMessage`
`org.springframework.context.ApplicationContext`	`ctx`
`java.lang.String`	`dataSourceName`
`liquibase.database.Database`	`database`
`groovy.lang.Closure`	`initClosure`
`boolean`	`initClosureCalled`
`groovy.lang.Closure`	`rollbackClosure`
`groovy.sql.Sql`	`sql`
`groovy.lang.Closure`	`validateClosure`
`boolean`	`validateClosureCalled`
`liquibase.exception.ValidationErrors`	`validationErrors`
`liquibase.exception.Warnings`	`warnings`

Constructor Summary

Constructors
Constructor and description
`GroovyChange()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`confirm(java.lang.String message)` Called by the change or rollback closure.
	`void`	`error(java.lang.String message)` Called by the validate closure.
	`void`	`finishInitialization()`
	`liquibase.change.CheckSum`	`generateCheckSum()`
	`liquibase.statement.SqlStatement[]`	`generateRollbackStatements(liquibase.database.Database database)`
	`liquibase.statement.SqlStatement[]`	`generateStatements(liquibase.database.Database database)`
	`grails.core.GrailsApplication`	`getApplication()` Called from the change or rollback closure.
	`grails.config.Config`	`getConfig()` Called from the change or rollback closure.
	`java.lang.String`	`getConfirmationMessage()`
	`java.sql.Connection`	`getConnection()` Called from the change or rollback closure.
	`liquibase.database.DatabaseConnection`	`getDatabaseConnection()` Called from the change or rollback closure.
	`groovy.sql.Sql`	`getSql()` Called from the change or rollback closure.
	`void`	`load(liquibase.parser.core.ParsedNode parsedNode, liquibase.resource.ResourceAccessor resourceAccessor)`
	`protected boolean`	`shouldRun()` Returns: Whether the database executor is instance of LoggingExecutor
	`void`	`sqlStatement(liquibase.statement.SqlStatement statement)` Called by the change or rollback closure.
	`void`	`sqlStatements(java.util.List statements)` Called by the change or rollback closure.
	`boolean`	`supportsRollback(liquibase.database.Database database)`
	`liquibase.exception.ValidationErrors`	`validate(liquibase.database.Database database)`
	`liquibase.exception.Warnings`	`warn(liquibase.database.Database database)`
	`void`	`warn(java.lang.String warning)` Called by the validate closure.
	`protected void`	`withNewTransaction(groovy.lang.Closure callable)` Executes the grailsChange>change block within the context of a new transaction

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class liquibase.change.AbstractChange`	liquibase.change.AbstractChange#supports(liquibase.database.Database), liquibase.change.AbstractChange#getResourceAccessor(), liquibase.change.AbstractChange#modify(liquibase.change.visitor.ChangeVisitor), liquibase.change.AbstractChange#generateRollbackStatements(liquibase.database.Database), liquibase.change.AbstractChange#finishInitialization(), liquibase.change.AbstractChange#generateRollbackStatementsVolatile(liquibase.database.Database), liquibase.change.AbstractChange#generateCheckSum(), liquibase.change.AbstractChange#supportsRollback(liquibase.database.Database), liquibase.change.AbstractChange#getSerializableFieldValue(java.lang.String), liquibase.change.AbstractChange#getSerializableFieldType(java.lang.String), liquibase.change.AbstractChange#getSerializedObjectNamespace(), liquibase.change.AbstractChange#getSerializableFieldNamespace(java.lang.String), liquibase.change.AbstractChange#generateStatementsVolatile(liquibase.database.Database), liquibase.change.AbstractChange#setResourceAccessor(liquibase.resource.ResourceAccessor), liquibase.change.AbstractChange#setChangeSet(liquibase.changelog.ChangeSet), liquibase.change.AbstractChange#createChangeMetaData(), liquibase.change.AbstractChange#checkStatus(liquibase.database.Database), liquibase.change.AbstractChange#shouldExecuteChange(liquibase.database.Database), liquibase.change.AbstractChange#getExcludedFieldFilters(liquibase.ChecksumVersion), liquibase.change.AbstractChange#getAffectedDatabaseObjects(liquibase.database.Database), liquibase.change.AbstractChange#getSerializedObjectName(), liquibase.change.AbstractChange#getChangeSet(), liquibase.change.AbstractChange#getSerializableFields(), liquibase.change.AbstractChange#equals(java.lang.Object), liquibase.change.AbstractChange#toString(), liquibase.change.AbstractChange#hashCode(), liquibase.change.AbstractChange#load(liquibase.parser.core.ParsedNode, liquibase.resource.ResourceAccessor), liquibase.change.AbstractChange#validate(liquibase.database.Database), liquibase.change.AbstractChange#warn(liquibase.database.Database), liquibase.change.AbstractChange#getDescription(), liquibase.change.AbstractChange#serialize(), liquibase.change.AbstractChange#getObjectMetaData(), liquibase.change.AbstractChange#getValuePath(java.lang.String, java.lang.Class), liquibase.change.AbstractChange#get(java.lang.String, java.lang.Class), liquibase.change.AbstractChange#get(java.lang.String, java.lang.Object), liquibase.change.AbstractChange#clone(), liquibase.change.AbstractChange#set(java.lang.String, java.lang.Object), liquibase.change.AbstractChange#getAttributes(), liquibase.change.AbstractChange#has(java.lang.String), liquibase.change.AbstractChange#describe(), liquibase.change.AbstractChange#wait(long, int), liquibase.change.AbstractChange#wait(), liquibase.change.AbstractChange#wait(long), liquibase.change.AbstractChange#getClass(), liquibase.change.AbstractChange#notify(), liquibase.change.AbstractChange#notifyAll(), liquibase.change.AbstractChange#generateStatements(liquibase.database.Database), liquibase.change.AbstractChange#getConfirmationMessage()

- Property Detail
  - java.util.List allStatements
  - groovy.lang.Closure changeClosure
  - boolean changeClosureCalled
  - java.lang.String checksumString
  - java.lang.String confirmationMessage
  - org.springframework.context.ApplicationContext ctx
  - java.lang.String dataSourceName
  - liquibase.database.Database database
  - groovy.lang.Closure initClosure
  - boolean initClosureCalled
  - groovy.lang.Closure rollbackClosure
  - groovy.sql.Sql sql
  - groovy.lang.Closure validateClosure
  - boolean validateClosureCalled
  - liquibase.exception.ValidationErrors validationErrors
  - liquibase.exception.Warnings warnings
- Constructor Detail
  - GroovyChange()
- Method Detail
  - void confirm(java.lang.String message)
    
    Called by the change or rollback closure. Overrides the confirmation message.
    Parameters:
    message - the confirmation message
  - void error(java.lang.String message)
    
    Called by the validate closure. Adds a validation error.
    Parameters:
    message - the error message
  - @java.lang.Override
    void finishInitialization()
  - @java.lang.Override
    liquibase.change.CheckSum generateCheckSum()
  - @java.lang.Override
    liquibase.statement.SqlStatement[] generateRollbackStatements(liquibase.database.Database database)
  - @java.lang.Override
    liquibase.statement.SqlStatement[] generateStatements(liquibase.database.Database database)
  - grails.core.GrailsApplication getApplication()
    
    Called from the change or rollback closure. Shortcut for the current application.
    Returns:
    the application
  - grails.config.Config getConfig()
    
    Called from the change or rollback closure. Shortcut for the current config.
    Returns:
    the config
  - @java.lang.Override
    java.lang.String getConfirmationMessage()
  - java.sql.Connection getConnection()
    
    Called from the change or rollback closure. Shortcut to get the real database connection.
    Returns:
    the connection or null if the database isn't set yet
  - liquibase.database.DatabaseConnection getDatabaseConnection()
    
    Called from the change or rollback closure. Shortcut to get the (wrapper) database connection.
    Returns:
    the connection or null if the database isn't set yet
  - groovy.sql.Sql getSql()
    
    Called from the change or rollback closure. Creates a Sql instance from the current connection.
    Returns:
    the sql instance
  - @java.lang.Override
    void load(liquibase.parser.core.ParsedNode parsedNode, liquibase.resource.ResourceAccessor resourceAccessor)
  - protected boolean shouldRun()
    
    Returns:
    Whether the database executor is instance of LoggingExecutor
  - void sqlStatement(liquibase.statement.SqlStatement statement)
    
    Called by the change or rollback closure. Adds a statement to be executed.
    Parameters:
    statement - the statement
  - void sqlStatements(java.util.List statements)
    
    Called by the change or rollback closure. Adds multiple statements to be executed.
    Parameters:
    statement - the statement
  - @java.lang.Override
    boolean supportsRollback(liquibase.database.Database database)
  - @java.lang.Override
    liquibase.exception.ValidationErrors validate(liquibase.database.Database database)
  - @java.lang.Override
    liquibase.exception.Warnings warn(liquibase.database.Database database)
  - void warn(java.lang.String warning)
    
    Called by the validate closure. Adds a warning message.
    Parameters:
    warning - the warning message
  - protected void withNewTransaction(groovy.lang.Closure callable)
    
    Executes the grailsChange>change block within the context of a new transaction
    Parameters:
    callable - The changeClosure to call
    Returns:
    The result of the closure execution

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GroovyChange

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.List allStatements

groovy.lang.Closure changeClosure

boolean changeClosureCalled

java.lang.String checksumString

java.lang.String confirmationMessage

org.springframework.context.ApplicationContext ctx

java.lang.String dataSourceName

liquibase.database.Database database

groovy.lang.Closure initClosure

boolean initClosureCalled

groovy.lang.Closure rollbackClosure

groovy.sql.Sql sql

groovy.lang.Closure validateClosure

boolean validateClosureCalled

liquibase.exception.ValidationErrors validationErrors

liquibase.exception.Warnings warnings

Constructor Detail

GroovyChange()

Method Detail

void confirm(java.lang.String message)

void error(java.lang.String message)

@java.lang.Overridevoid finishInitialization()

@java.lang.Overrideliquibase.change.CheckSum generateCheckSum()

@java.lang.Overrideliquibase.statement.SqlStatement[] generateRollbackStatements(liquibase.database.Database database)

@java.lang.Overrideliquibase.statement.SqlStatement[] generateStatements(liquibase.database.Database database)

grails.core.GrailsApplication getApplication()

grails.config.Config getConfig()

@java.lang.Overridejava.lang.String getConfirmationMessage()

java.sql.Connection getConnection()

liquibase.database.DatabaseConnection getDatabaseConnection()

groovy.sql.Sql getSql()

@java.lang.Overridevoid load(liquibase.parser.core.ParsedNode parsedNode, liquibase.resource.ResourceAccessor resourceAccessor)

protected boolean shouldRun()

void sqlStatement(liquibase.statement.SqlStatement statement)

void sqlStatements(java.util.List statements)

@java.lang.Overrideboolean supportsRollback(liquibase.database.Database database)

@java.lang.Overrideliquibase.exception.ValidationErrors validate(liquibase.database.Database database)

@java.lang.Overrideliquibase.exception.Warnings warn(liquibase.database.Database database)

void warn(java.lang.String warning)

protected void withNewTransaction(groovy.lang.Closure callable)

@java.lang.Override
void finishInitialization()

@java.lang.Override
liquibase.change.CheckSum generateCheckSum()

@java.lang.Override
liquibase.statement.SqlStatement[] generateRollbackStatements(liquibase.database.Database database)

@java.lang.Override
liquibase.statement.SqlStatement[] generateStatements(liquibase.database.Database database)

@java.lang.Override
java.lang.String getConfirmationMessage()

@java.lang.Override
void load(liquibase.parser.core.ParsedNode parsedNode, liquibase.resource.ResourceAccessor resourceAccessor)

@java.lang.Override
boolean supportsRollback(liquibase.database.Database database)

@java.lang.Override
liquibase.exception.ValidationErrors validate(liquibase.database.Database database)

@java.lang.Override
liquibase.exception.Warnings warn(liquibase.database.Database database)