org.tinygroup.database.DatabaseDocumentGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.tinygroup.database Show documentation
The newest version!
/**
 * Copyright (c) 2012-2016, www.tinygroup.org ([email protected]).
 *
 *  Licensed under the GPL, Version 3.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *       http://www.gnu.org/licenses/gpl.html
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.tinygroup.database;

/**
 * 数据库文档生成器
 *
 * @author luoguo
 */
public interface DatabaseDocumentGenerator {

    void generateCustomSql(Document document, String dialectName,
                           String packgeName, String customSqlName);

    /**
     * 返回建表语句
     *
     * @param dialectName
     * @param packgeName
     * @param tableName
     * @return
     */
    void generateCreateTableSql(Document document, String dialectName,
                                String packgeName, String tableName);

    /**
     * 返回视图创建SQL语句
     *
     * @param dialectName
     * @param packgeName
     * @param viewName
     * @return
     */
    void generateCreateViewSql(Document document, String dialectName,
                               String packgeName, String viewName);

    /**
     * 返回索引SQL
     *
     * @param dialectName
     * @param packgeName
     * @param indexName
     * @return
     */
    void generateCreateIndexSql(Document document, String dialectName,
                                String packgeName, String tableName, String indexName);

    /**
     * 返回创建存储过程SQL
     *
     * @param dialectName
     * @param packgeName
     * @param procedureName
     * @return
     */
    void generateCreateProcedureSql(Document document, String dialectName,
                                    String packgeName, String procedureName);

    /**
     * 返回初始化脚本
     *
     * @param dialectName
     * @param tableName
     * @return
     */
    void generateInitDataSql(Document document, String dialectName,
                             String tableName);

}