com.gitee.qdbp.jdbc.plugins.SqlFragmentOptions Maven / Gradle / Ivy

Go to download
package com.gitee.qdbp.jdbc.plugins;

/**
 * SQL片断的选项
 *
 * @author zhaohuihua
 * @version 20201124
 * @since 3.2.10
 */
public interface SqlFragmentOptions {

    /**
     * 是否在系统启动时扫描SQL文件

     * 如果启动时不扫描, 则首次获取SQL模板时会扫描(很慢)

     * 所以, 一般情况下都应该配置为true, 除非系统中未使用到SQL模板
     * 
     * @return 是否在系统启动时扫描SQL文件
     */
    boolean isSqlTemplateScanOnStartup();

    /**
     * 是否允许通过fragmentId获取SQL片断

     * 如果不允许通过fragmentId获取SQL片断, 那么只能通过 fileName:fragmentId 获取SQL片断

     * 例如 GlobalRecursive.sql 中存在 recursiveListChildrenQuery 片断

     * 如果不允许, 那么只能通过 GlobalRecursive:recursiveListChildrenQuery 获取

     * 否则 GlobalRecursive:recursiveListChildrenQuery 和 recursiveListChildrenQuery 都可以
     * 
     * @return 是否允许通过fragmentId获取SQL片断
     */
    boolean isUseFragmentIdQuery();
}