GrailsUpdaterClass (Bropen Toolkit 4.8.1 API)

bropen.toolkit.updater.GrailsUpdaterClass

All Superinterfaces:

grails.core.support.GrailsApplicationAware, org.springframework.beans.factory.Aware

Represents a updater class in Grails.

Methods Summary

Methods
Type	Name and description
`void`	`afterBootStrap()` BootStrap 后
`void`	`beforeBootStrap()` BootStrap 前
`void`	`beforeDbUpdate(groovy.sql.Sql sqlInst, String dsName, String dbName, String dbSchema)` 更新数据库表结构前
`String`	`formatVersion(String ver)` 格式化一个版本号，返回格式同 getVersion 的字符串，以便比较
`String`	`getDescription()` 升级说明
`String`	`getLastVersion()` 上次成功升级的版本号，判断依据为 afterBootStrap 执行成功；格式同 getVersion
`String`	`getLastVersion(String event)` 上次成功升级的版本号
`String`	`getOriginalVersion()` 升级器中定义的版本号（不受方法 setVersion 的影响）
`String`	`getPluginName()` 所属插件，默认为 app_应用名，即不属于任何插件
`String`	`getVersion()` 版本号
`boolean`	`isInitiator()` 是否是初始化版本：每个插件只能有一个
`void`	`setLastVersions(Map<String, String> lastVers)` 设置上次成功升级的版本号
`void`	`setVersion(String version)` 设置版本号，设为 -1 则禁用

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface grails.core.GrailsClass`	grails.core.GrailsClass#getMetaClass(), grails.core.GrailsClass#getPluginName(), grails.core.GrailsClass#getNaturalName(), grails.core.GrailsClass#getFullName(), grails.core.GrailsClass#getGrailsApplication(), grails.core.GrailsClass#getClazz(), grails.core.GrailsClass#getApplication(), grails.core.GrailsClass#getReferenceInstance(), grails.core.GrailsClass#getLogicalPropertyName(), grails.core.GrailsClass#getShortName(), grails.core.GrailsClass#getReference(), grails.core.GrailsClass#getPropertyName(), grails.core.GrailsClass#getPropertyValue(String), grails.core.GrailsClass#getPropertyValue(String, Class), grails.core.GrailsClass#hasProperty(String), grails.core.GrailsClass#getName(), grails.core.GrailsClass#newInstance(), grails.core.GrailsClass#isAbstract(), grails.core.GrailsClass#getPackageName(), grails.core.GrailsClass#setGrailsApplication(grails.core.GrailsApplication)
`class Object`	`Object#wait(long, int), Object#wait(long), Object#wait(), Object#equals(Object), Object#toString(), Object#hashCode(), Object#getClass(), Object#notify(), Object#notifyAll()`

- Method Detail
  - public void afterBootStrap()
    
    BootStrap 后
  - public void beforeBootStrap()
    
    BootStrap 前
  - public void beforeDbUpdate(groovy.sql.Sql sqlInst, String dsName, String dbName, String dbSchema)
    
    更新数据库表结构前
    在更新器实例中，事件方法不包含 dsName 参数，但是可以包含多个 beforeDbUpdate 方法，通过后缀来区分是执行那个数据源，如： beforeDbUpdate 表示更新默认数据源、beforeDbUpdate_xyz 表示更新名为 xyz 的数据源。
    
    Parameters:
    sqlInst - 已初始化的数据库连接，可用来执行sql
    dsName - 数据源名称，注意此时对应的 spring bean 还未注册
    dbName - 数据库名称，如 oracle
    dbSchema - 数据库名，用于拼sql，如表名前缀：select * from schema.abc
  - public String formatVersion(String ver)
    
    格式化一个版本号，返回格式同 getVersion 的字符串，以便比较
    Returns:
    格式化的版本号
    Parameters:
    ver - 版本号
  - public String getDescription()
    
    升级说明
    Returns:
    升级器中定义的升级说明
  - public String getLastVersion()
    
    上次成功升级的版本号，判断依据为 afterBootStrap 执行成功；格式同 getVersion
    Returns:
    版本号
  - public String getLastVersion(String event)
    
    上次成功升级的版本号
    Returns:
    版本号
    Parameters:
    event - 事件名：beforeDbUpdate、beforeBootStrap、afterBootStrap
  - public String getOriginalVersion()
    
    升级器中定义的版本号（不受方法 setVersion 的影响）
    Returns:
    版本号
  - @Overridede public public String getPluginName()
    
    所属插件，默认为 app_应用名，即不属于任何插件
    Returns:
    插件名
  - public String getVersion()
    
    版本号
    Returns:
    不超过四段的数字，如 w.x.y.z、x.y，前三段每段最多3个字符、最后一段最多10个字符，共22个字符
  - public boolean isInitiator()
    
    是否是初始化版本：每个插件只能有一个
    Returns:
    true/false
  - public void setLastVersions(Map<String, String> lastVers)
    
    设置上次成功升级的版本号
    Parameters:
    lastVers - 版本号，其中 key 为事件名
  - public void setVersion(String version)
    
    设置版本号，设为 -1 则禁用
    Parameters:
    version - 版本号

Summary:
Nested
Field
Method

| Detail:
Field
Method

BROPEN Documentation, 2020-04-21 10:53

[Java] Interface GrailsUpdaterClass

Methods Summary

Inherited Methods Summary

Method Detail

public void afterBootStrap()

public void beforeBootStrap()

public void beforeDbUpdate(groovy.sql.Sql sqlInst, String dsName, String dbName, String dbSchema)

public String formatVersion(String ver)

public String getDescription()

public String getLastVersion()

public String getLastVersion(String event)

public String getOriginalVersion()

@Overridede public public String getPluginName()

public String getVersion()

public boolean isInitiator()

public void setLastVersions(Map<String, String> lastVers)

public void setVersion(String version)