///*************************************************************************/
///*
///* 文件名    ：IGenerateDbCommand.cs    
///*
///* 程序说明  : SQL生成器接口
///* 原创作者  ：孙中吕 
///* 
///* Copyright 2006-2021 C/S框架网 www.csframework.com
///*
///**************************************************************************/

using System.Collections;
using System.Data.Common;

namespace CSFrameworkV5.Core
{
    /// <summary>
    /// SQL命令生成器通用接口
    /// </summary>
    public interface IGenerateSqlCommand
    {
        /// <summary>
        /// 生成插入记录的SQL命令
        /// </summary>
        /// <param name="tran">事务</param>
        /// <returns></returns>
        DbCommand GetInsertCommand(DbTransaction tran);

        /// <summary>
        /// 生成更新记录的SQL命令
        /// </summary>
        /// <param name="tran"></param>
        /// <returns></returns>
        DbCommand GetUpdateCommand(DbTransaction tran);

        /// <summary>
        /// 生成删除记录的SQL命令
        /// </summary>
        /// <param name="tran"></param>
        /// <returns></returns>
        DbCommand GetDeleteCommand(DbTransaction tran);

        /// <summary>
        /// 生成插入记录用SQL语句
        /// </summary>
        /// <param name="tableName">表名</param>
        /// <param name="keyName">主键</param>
        /// <param name="field">字段列表</param>
        /// <returns></returns>
        string GenerateInsertSql(string tableName, string keyName, IList field);

        /// <summary>
        /// 生成更新记录用SQL语句
        /// </summary>
        /// <param name="tableName">表名</param>
        /// <param name="keyName">主键</param>
        /// <param name="field">字段列表</param>
        /// <returns></returns>
        string GenerateUpdateSql(string tableName, string keyName, IList field);

        /// <summary>
        /// 生成删除记录用SQL语句
        /// </summary>
        /// <param name="tableName">表名</param>
        /// <param name="keyName">主键</param>
        /// <param name="field">字段列表</param>
        /// <returns></returns>
        string GenerateDeleteSql(string tableName, string keyName);

        /// <summary>
        /// 单据号码
        /// </summary>
        /// <returns></returns>
        string GetDocNoFieldName();

        /// <summary>
        /// 主键
        /// </summary>
        /// <returns></returns>
        string GetPrimaryFieldName();

        /// <summary>
        /// 外键
        /// </summary>
        /// <returns></returns>
        string GetForeignFieldName();

        /// <summary>
        /// 是否主表
        /// </summary>
        /// <returns></returns>
        bool IsSummary();
    }
}