namespace DbAPI.Connections
{
    public interface IConnectionDetails
    {
        /// <summary>
        /// Whether NTLM Authentication should be used
        /// </summary>
        bool UseNTLMAuthentication { get; set; }
        /// <summary>
        /// when connecting to a database with a specific user/pwd, what user to use
        /// </summary>
        string DbUser { get; set; }
        /// <summary>
        /// When connecting to a database with a specific user/pwd, what pwd to use
        /// </summary>
        string DbUserPassword { get; set; }
        /// <summary>
        /// When connecting to a LocalDB, what the name of the instance should be
        /// </summary>
        string InstanceName { get; set; }
        /// <summary>
        /// When connecting to a remote DB, what server the DB is on
        /// </summary>
        string DbServer { get; set; }
        /// <summary>
        /// Name of database to connect to
        /// </summary>
        string DbName { get; set; }
        /// <summary>
        /// Whether connecting to a LocalDB or a remote DB
        /// </summary>
        bool UsingCentralizedDb { get; set; }
        /// <summary>
        /// path to db files if using LocalDB
        /// </summary>
        string DbFolderPath { get; set; }
        /// <summary>
        /// path to attach.bat if using LocalDB
        /// </summary>
        string AttachDbsBatPath { get; set; }
        /// <summary>
        /// The path to the SQLCMD.EXE that we want to use
        /// </summary>
        string ODBCToolsPath { get; set; }
        /// <summary>
        /// a string suitable for SqlClient to connect to
        /// </summary>
        /// <returns></returns>
        string GetConnectionString();
        /// <summary>
        /// returns a deep copy of connection details
        /// </summary>
        /// <returns></returns>
        IConnectionDetails Clone();
        /// <summary>
        /// Path to SQL Server when using LocalDB
        /// </summary>
        string SqlDbPath { get; set; }

        /// <summary>
        /// holds the code version of the database, what we would use if available
        /// </summary>
        int ClientDbVersion { get; set; }

        /// <summary>
        /// holds the version of the database, what we will be using
        /// </summary>
        int ConnectionDbVersion { get; set; }
    }
}