sf.database.support

Interface MetadataEventListener

public interface MetadataEventListener

表结构变更时，整个操作过程进度的事件监听器(可以干涉修改表的过程)

按事件的时间顺序如下
1. 变更表之前 （可以控制是否继续刷新操作）
2. 如果表不存在，创建表之前（可以控制是否建表）
3. 如果表存在，在比较表之前（可以控制是否继续刷新操作）
4. 数据库中的表和元数据比较完成后
5. 比较完成并生成SQL后，在操作表之前
6. 在每句SQL执行成功后
7. 在任何一句SQL执行失败后
8. 在所有SQL都执行完成后

Author:

Method Summary

Modifier and Type	Method and Description
default void	beforeAlterTable(String tablename, TableMapping meta, Connection conn, List<String> sql) 框架根据表对比结果，生成SQL语句后触发此事件，用户事件中可以获得所有的SQL语句。
default boolean	beforeTableRefresh(TableMapping meta, String table) 当开始变更一张表时执行
default void	onAlterSqlFinished(String tablename, String sql, List<String> sqls, int n, long cost) 每一句SQL语句执行完成后
default boolean	onColumnsCompared(String tablename, TableMapping meta, Set<ColumnMapping> insert, List<ColumnMapping> changed, List<String> delete) 表结构比较完成后出发，提供了表的对比结果供用户判断。 在这个方法中，实现类可以直接修改传入的比较结果，让后续的程序按修改后的比较结果执行ALTER TABLE语句。
default boolean	onCompareColumns(String tablename, List<ColumnInfo> columns, Map<DBField,ColumnMapping> defined) 开始进行表结构的比较
default boolean	onSqlExecuteError(Exception e, String tablename, String sql, List<String> sqls, int n) 当某句SQL语句执行失败后触发
default boolean	onTableCreate(TableMapping meta, String tablename) 表不存在，将会创建表
default void	onTableFinished(TableMapping meta, String tablename) 表变更完成

Method Detail

beforeTableRefresh

default boolean beforeTableRefresh(TableMapping meta,
                                   String table)

当开始变更一张表时执行

Parameters:

meta - 表的元数据

table - 数据库中的表名

Returns:

false，则放弃变更此表

onTableCreate

default boolean onTableCreate(TableMapping meta,
                              String tablename)

表不存在，将会创建表

Parameters:

meta - 表的元数据

tablename - 数据库中的表名

Returns:

false，则放弃创建此表

onColumnsCompared

default boolean onColumnsCompared(String tablename,
                                  TableMapping meta,
                                  Set<ColumnMapping> insert,
                                  List<ColumnMapping> changed,
                                  List<String> delete)

表结构比较完成后出发，提供了表的对比结果供用户判断。
在这个方法中，实现类可以直接修改传入的比较结果，让后续的程序按修改后的比较结果执行ALTER TABLE语句。

Parameters:

tablename - 表名

meta - 表的元数据

insert - 将要增加的数据库列(列名、数据类型)

changed - 数据格式发生了变更的列

delete - 将要删除的列

Returns:

false则放弃变更此表

beforeAlterTable

default void beforeAlterTable(String tablename,
                              TableMapping meta,
                              Connection conn,
                              List<String> sql)

框架根据表对比结果，生成SQL语句后触发此事件，用户事件中可以获得所有的SQL语句。

Parameters:

tablename - 表名

meta - 元数据

conn - 数据库连接

sql - 所有的SQL语句

onAlterSqlFinished

default void onAlterSqlFinished(String tablename,
                                String sql,
                                List<String> sqls,
                                int n,
                                long cost)

每一句SQL语句执行完成后

Parameters:

tablename - 表名

sql - 刚完成的SQL语句

sqls - 所有SQL语句

n - 序号，第几句SQL，编号从0开始

cost - 刚才的SQL语句耗时(ms)

onSqlExecuteError

default boolean onSqlExecuteError(Exception e,
                                  String tablename,
                                  String sql,
                                  List<String> sqls,
                                  int n)

当某句SQL语句执行失败后触发

Parameters:

e - 异常

tablename - 表名

sql - 出错的SQL语句

sqls - 所有SQL语句

n - 出错的SQL语句序号

Returns:

如果返回true，表示继续执行后续的语句，如果返回false表示不再向后执行

onTableFinished

default void onTableFinished(TableMapping meta,
                             String tablename)

表变更完成

Parameters:

meta - 表元数据

tablename - 表名

onCompareColumns

default boolean onCompareColumns(String tablename,
                                 List<ColumnInfo> columns,
                                 Map<DBField,ColumnMapping> defined)

开始进行表结构的比较

Parameters:

tablename - 表名

columns - 数据库中的所有列

defined - 表模型中的所有列

Returns:

是否继续比较这张表