SQLHelper

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

using System; using System.Configuration; using System.Data; using System.Data.SqlClient; using System.Collections;   namespace Maticsoft.DBUtility {       /// <summary>     /// The SqlHelper class is intended to encapsulate high performance,     /// scalable best practices for common uses of SqlClient.     /// </summary>     public abstract class SqlHelper     {           //Database connection strings         public static readonly string ConnectionStringLocalTransaction =  ConfigurationManager.AppSettings["SQLConnString1"];         public static readonly string ConnectionStringInventoryDistributedTransaction =  ConfigurationManager.AppSettings["SQLConnString2"];         public static readonly string ConnectionStringOrderDistributedTransaction =  ConfigurationManager.AppSettings["SQLConnString3"];         public static readonly string ConnectionStringProfile =  ConfigurationManager.AppSettings["SQLProfileConnString"];           // Hashtable to store cached parameters         private static Hashtable parmCache = Hashtable.Synchronized(new Hashtable());           /// <summary>         /// Execute a SqlCommand (that returns no resultset) against the database specified in the connection string         /// using the provided parameters.         /// </summary>         /// <remarks>         /// e.g.:          ///  int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));         /// </remarks>         /// <param name="connectionString">a valid connection string for a SqlConnection</param>         /// <param name="commandType">the CommandType (stored procedure, text, etc.)</param>         /// <param name="commandText">the stored procedure name or T-SQL command</param>         /// <param name="commandParameters">an array of SqlParamters used to execute the command</param>         /// <returns>an int representing the number of rows affected by the command</returns>         public static int ExecuteNonQuery(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)         {               SqlCommand cmd = new SqlCommand();               using (SqlConnection conn = new SqlConnection(connectionString))             {                 PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);                 int val = cmd.ExecuteNonQuery();                 cmd.Parameters.Clear();                 return val;             }         }           /// <summary>         /// Execute a SqlCommand (that returns no resultset) against an existing database connection         /// using the provided parameters.         /// </summary>         /// <remarks>         /// e.g.:          ///  int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));         /// </remarks>         /// <param name="conn">an existing database connection</param>         /// <param name="commandType">the CommandType (stored procedure, text, etc.)</param>         /// <param name="commandText">the stored procedure name or T-SQL command</param>         /// <param name="commandParameters">an array of SqlParamters used to execute the command</param>         /// <returns>an int representing the number of rows affected by the command</returns>         public static int ExecuteNonQuery(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)         {               SqlCommand cmd = new SqlCommand();               PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);             int val = cmd.ExecuteNonQuery();             cmd.Parameters.Clear();             return val;         }           /// <summary>         /// Execute a SqlCommand (that returns no resultset) using an existing SQL Transaction         /// using the provided parameters.         /// </summary>         /// <remarks>         /// e.g.:          ///  int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));         /// </remarks>         /// <param name="trans">an existing sql transaction</param>         /// <param name="commandType">the CommandType (stored procedure, text, etc.)</param>         /// <param name="commandText">the stored procedure name or T-SQL command</param>         /// <param name="commandParameters">an array of SqlParamters used to execute the command</param>         /// <returns>an int representing the number of rows affected by the command</returns>         public static int ExecuteNonQuery(SqlTransaction trans, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)         {             SqlCommand cmd = new SqlCommand();             PrepareCommand(cmd, trans.Connection, trans, cmdType, cmdText, commandParameters);             int val = cmd.ExecuteNonQuery();             cmd.Parameters.Clear();             return val;         }           /// <summary>         /// Execute a SqlCommand that returns a resultset against the database specified in the connection string         /// using the provided parameters.         /// </summary>         /// <remarks>         /// e.g.:          ///  SqlDataReader r = ExecuteReader(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));         /// </remarks>         /// <param name="connectionString">a valid connection string for a SqlConnection</param>         /// <param name="commandType">the CommandType (stored procedure, text, etc.)</param>         /// <param name="commandText">the stored procedure name or T-SQL command</param>         /// <param name="commandParameters">an array of SqlParamters used to execute the command</param>         /// <returns>A SqlDataReader containing the results</returns>         public static SqlDataReader ExecuteReader(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)         {             SqlCommand cmd = new SqlCommand();             SqlConnection conn = new SqlConnection(connectionString);               // we use a try/catch here because if the method throws an exception we want to             // close the connection throw code, because no datareader will exist, hence the             // commandBehaviour.CloseConnection will not work             try             {                 PrepareCommand(cmd, conn, null, cmdType, cmdText, commandParameters);                 SqlDataReader rdr = cmd.ExecuteReader(CommandBehavior.CloseConnection);                 cmd.Parameters.Clear();                 return rdr;             }             catch             {                 conn.Close();                 throw;             }         }           /// <summary>         /// Execute a SqlCommand that returns the first column of the first record against the database specified in the connection string         /// using the provided parameters.         /// </summary>         /// <remarks>         /// e.g.:          ///  Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));         /// </remarks>         /// <param name="connectionString">a valid connection string for a SqlConnection</param>         /// <param name="commandType">the CommandType (stored procedure, text, etc.)</param>         /// <param name="commandText">the stored procedure name or T-SQL command</param>         /// <param name="commandParameters">an array of SqlParamters used to execute the command</param>         /// <returns>An object that should be converted to the expected type using Convert.To{Type}</returns>         public static object ExecuteScalar(string connectionString, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)         {             SqlCommand cmd = new SqlCommand();               using (SqlConnection connection = new SqlConnection(connectionString))             {                 PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);                 object val = cmd.ExecuteScalar();                 cmd.Parameters.Clear();                 return val;             }         }           /// <summary>         /// Execute a SqlCommand that returns the first column of the first record against an existing database connection         /// using the provided parameters.         /// </summary>         /// <remarks>         /// e.g.:          ///  Object obj = ExecuteScalar(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));         /// </remarks>         /// <param name="conn">an existing database connection</param>         /// <param name="commandType">the CommandType (stored procedure, text, etc.)</param>         /// <param name="commandText">the stored procedure name or T-SQL command</param>         /// <param name="commandParameters">an array of SqlParamters used to execute the command</param>         /// <returns>An object that should be converted to the expected type using Convert.To{Type}</returns>         public static object ExecuteScalar(SqlConnection connection, CommandType cmdType, string cmdText, params SqlParameter[] commandParameters)         {               SqlCommand cmd = new SqlCommand();               PrepareCommand(cmd, connection, null, cmdType, cmdText, commandParameters);             object val = cmd.ExecuteScalar();             cmd.Parameters.Clear();             return val;         }           /// <summary>         /// add parameter array to the cache         /// </summary>         /// <param name="cacheKey">Key to the parameter cache</param>         /// <param name="cmdParms">an array of SqlParamters to be cached</param>         public static void CacheParameters(string cacheKey, params SqlParameter[] commandParameters)         {             parmCache[cacheKey] = commandParameters;         }           /// <summary>         /// Retrieve cached parameters         /// </summary>         /// <param name="cacheKey">key used to lookup parameters</param>         /// <returns>Cached SqlParamters array</returns>         public static SqlParameter[] GetCachedParameters(string cacheKey)         {             SqlParameter[] cachedParms = (SqlParameter[])parmCache[cacheKey];               if (cachedParms == null)                 return null;               SqlParameter[] clonedParms = new SqlParameter[cachedParms.Length];               for (int i = 0, j = cachedParms.Length; i < j; i++)                 clonedParms[i] = (SqlParameter)((ICloneable)cachedParms[i]).Clone();               return clonedParms;         }           /// <summary>         /// Prepare a command for execution         /// </summary>         /// <param name="cmd">SqlCommand object</param>         /// <param name="conn">SqlConnection object</param>         /// <param name="trans">SqlTransaction object</param>         /// <param name="cmdType">Cmd type e.g. stored procedure or text</param>         /// <param name="cmdText">Command text, e.g. Select * from Products</param>         /// <param name="cmdParms">SqlParameters to use in the command</param>         private static void PrepareCommand(SqlCommand cmd, SqlConnection conn, SqlTransaction trans, CommandType cmdType, string cmdText, SqlParameter[] cmdParms)         {             if (conn.State != ConnectionState.Open)                 conn.Open();               cmd.Connection = conn;             cmd.CommandText = cmdText;               if (trans != null)                 cmd.Transaction = trans;               cmd.CommandType = cmdType;               if (cmdParms != null)             {                 foreach (SqlParameter parm in cmdParms)                     cmd.Parameters.Add(parm);             }         }     } }