using System; using System.Xml; using System.Data; using System.Data.OleDb ; using System.Collections; namespace Payroll.BO { #region SQL Helper #region Syntax Enum public enum SQLSyntax { Access = 1, SQL, Oracle } #endregion #region SQL Helper ///

/// SQLHelper.cs /// This file contains the implementations of the SqlHelper /// and SqlHelperParameterCache classes. /// The SqlHelper class is intended to encapsulate high performance, /// scalable best practices for common uses of OleDb ///

public sealed class SQLHelper:DABase { #region private utility methods & constructors // Since this class provides only static methods, make the default constructor private to prevent // instances from being created with "new SqlHelper()" private SQLHelper() {} ///

/// This method is used to attach array of OleDbParameters to a OleDbCommand. /// /// This method will assign a value of DbNull to any parameter with a direction of /// InputOutput and a value of null. /// /// This behavior will prevent default values from being used, but /// this will be the less common case than an intended pure output parameter (derived as InputOutput) /// where the user provided no input value. ///

/// The command to which the parameters will be added /// An array of OleDbParameters to be added to command private static void AttachParameters(OleDbCommand command, OleDbParameter[] commandParameters) { if( command == null ) throw new ArgumentNullException( "command" ); if( commandParameters != null ) { foreach (OleDbParameter p in commandParameters) { if( p != null ) { // Check for derived output value with no value assigned if ( ( p.Direction == ParameterDirection.InputOutput || p.Direction == ParameterDirection.Input ) && (p.Value == null)) { p.Value = DBNull.Value; } command.Parameters.Add(p); } } } } ///

/// This method assigns dataRow column values to an array of OleDbParameters ///

/// Array of OleDbParameters to be assigned values /// The dataRow used to hold the stored procedure's parameter values private static void AssignParameterValues(OleDbParameter[] commandParameters, DataRow dataRow) { if ((commandParameters == null) || (dataRow == null)) { // Do nothing if we get no data return; } int i = 0; // Set the parameters values foreach(OleDbParameter commandParameter in commandParameters) { // Check the parameter name if( commandParameter.ParameterName == null || commandParameter.ParameterName.Length <= 1 ) throw new Exception( string.Format( "Please provide a valid parameter name on the parameter #{0}, the ParameterName property has the following value: '{1}'.", i, commandParameter.ParameterName ) ); if (dataRow.Table.Columns.IndexOf(commandParameter.ParameterName.Substring(1)) != -1) commandParameter.Value = dataRow[commandParameter.ParameterName.Substring(1)]; i++; } } ///

/// This method assigns an array of values to an array of OleDbParameters ///

/// Array of OleDbParameters to be assigned values /// Array of objects holding the values to be assigned private static void AssignParameterValues(OleDbParameter[] commandParameters, object[] parameterValues) { if ((commandParameters == null) || (parameterValues == null)) { // Do nothing if we get no data return; } // We must have the same number of values as we pave parameters to put them in if (commandParameters.Length != parameterValues.Length) { throw new ArgumentException("Parameter count does not match Parameter Value count."); } // Iterate through the OleDbParameters, assigning the values from the corresponding position in the // value array for (int i = 0, j = commandParameters.Length; i < j; i++) { // If the current array value derives from IDbDataParameter, then assign its Value property if (parameterValues[i] is IDbDataParameter) { IDbDataParameter paramInstance = (IDbDataParameter)parameterValues[i]; if( paramInstance.Value == null ) { commandParameters[i].Value = DBNull.Value; } else { commandParameters[i].Value = paramInstance.Value; } } else if (parameterValues[i] == null) { commandParameters[i].Value = DBNull.Value; } else { commandParameters[i].Value = parameterValues[i]; } } } ///

/// This method opens (if necessary) and assigns a connection, transaction, command type and parameters /// to the provided command ///

/// The OleDbCommand to be prepared /// A valid OleDbConnection, on which to execute this command /// A valid OleDbTransaction, or 'null' /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of OleDbParameters to be associated with the command or 'null' if no parameters are required /// true if the connection was opened by the method, otherwose is false. private static void PrepareCommand(OleDbCommand command, OleDbConnection connection, OleDbTransaction transaction, CommandType commandType, string commandText, OleDbParameter[] commandParameters, out bool mustCloseConnection ) { if( command == null ) throw new ArgumentNullException( "command" ); if( commandText == null || commandText.Length == 0 ) throw new ArgumentNullException( "commandText" ); // If the provided connection is not open, we will open it if (connection.State != ConnectionState.Open) { mustCloseConnection = true; connection.Open(); } else { mustCloseConnection = false; } // Associate the connection with the command command.Connection = connection; // Set the command text (stored procedure name or SQL statement) command.CommandText = commandText; // If we were provided a transaction, assign it if (transaction != null) { if( transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); command.Transaction = transaction; } // Set the command type command.CommandType = commandType; // Attach the command parameters if they are provided if (commandParameters != null) { AttachParameters(command, commandParameters); } return; } #endregion private utility methods & constructors #region ExecuteNonQuery ///

/// Execute a OleDbCommand (that returns no resultset and takes no parameters) against the database specified in /// the connection string ///

/// /// e.g.: /// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders"); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(string connectionString, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteNonQuery(connectionString, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns no resultset) against the database specified in the connection string /// using the provided parameters ///

/// /// e.g.: /// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new OleDbParameter("@prodid", 24)); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(string connectionString, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); // Create & open a OleDbConnection, and dispose of it after we are done if(OleDbConnection==null) { OleDbConnection= new OleDbConnection(connectionString); } if(OleDbConnection.State==ConnectionState.Closed) { OleDbConnection.Open(); } return ExecuteNonQuery(OleDbConnection, commandType, commandText, commandParameters); } ///

/// Execute a stored procedure via a OleDbCommand (that returns no resultset) against the database specified in /// the connection string using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// int result = ExecuteNonQuery(connString, "PublishOrders", 24, 36); /// /// A valid connection string for a OleDbConnection /// The name of the stored prcedure /// An array of objects to be assigned as the input values of the stored procedure /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(string connectionString, string spName, params object[] parameterValues) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connectionString, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName); } } ///

/// Execute a OleDbCommand (that returns no resultset and takes no parameters) against the provided OleDbConnection. ///

/// /// e.g.: /// int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders"); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(OleDbConnection connection, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteNonQuery(connection, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns no resultset) against the specified OleDbConnection /// using the provided parameters. ///

/// /// e.g.: /// int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(OleDbConnection connection, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( connection == null ) throw new ArgumentNullException( "connection" ); // Create a command and prepare it for execution OleDbCommand cmd = new OleDbCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, connection, (OleDbTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection ); // Finally, execute the command int retval = cmd.ExecuteNonQuery(); // Detach the OleDbParameters from the command object, so they can be used again cmd.Parameters.Clear(); if( mustCloseConnection ) connection.Close(); return retval; } ///

/// Execute a stored procedure via a OleDbCommand (that returns no resultset) against the specified OleDbConnection /// using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// int result = ExecuteNonQuery(conn, "PublishOrders", 24, 36); /// /// A valid OleDbConnection /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(OleDbConnection connection, string spName, params object[] parameterValues) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteNonQuery(connection, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteNonQuery(connection, CommandType.StoredProcedure, spName); } } ///

/// Execute a OleDbCommand (that returns no resultset and takes no parameters) against the provided OleDbTransaction. ///

/// /// e.g.: /// int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders"); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(OleDbTransaction transaction, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteNonQuery(transaction, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns no resultset) against the specified OleDbTransaction /// using the provided parameters. ///

/// /// e.g.: /// int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(OleDbTransaction transaction, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); // Create a command and prepare it for execution OleDbCommand cmd = new OleDbCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection ); // Finally, execute the command int retval = cmd.ExecuteNonQuery(); // Detach the OleDbParameters from the command object, so they can be used again cmd.Parameters.Clear(); return retval; } ///

/// Execute a stored procedure via a OleDbCommand (that returns no resultset) against the specified /// OleDbTransaction using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// int result = ExecuteNonQuery(conn, trans, "PublishOrders", 24, 36); /// /// A valid OleDbTransaction /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// An int representing the number of rows affected by the command public static int ExecuteNonQuery(OleDbTransaction transaction, string spName, params object[] parameterValues) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteNonQuery #region ExecuteDataset ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the database specified in /// the connection string. ///

/// /// e.g.: /// DataSet ds = ExecuteDataset(connString, CommandType.StoredProcedure, "GetOrders"); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(string connectionString, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteDataset(connectionString, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a resultset) against the database specified in the connection string /// using the provided parameters. ///

/// /// e.g.: /// DataSet ds = ExecuteDataset(connString, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(string connectionString, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); // Create & open a OleDbConnection, and dispose of it after we are done if(OleDbConnection==null) { OleDbConnection= new OleDbConnection(connectionString); } if(OleDbConnection.State==ConnectionState.Closed) { OleDbConnection.Open(); } // Call the overload that takes a connection in place of the connection string return ExecuteDataset(OleDbConnection, commandType, commandText, commandParameters); } ///

/// Execute a stored procedure via a OleDbCommand (that returns a resultset) against the database specified in /// the connection string using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// DataSet ds = ExecuteDataset(connString, "GetOrders", 24, 36); /// /// A valid connection string for a OleDbConnection /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(string connectionString, string spName, params object[] parameterValues) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connectionString, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteDataset(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteDataset(connectionString, CommandType.StoredProcedure, spName); } } ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the provided OleDbConnection. ///

/// /// e.g.: /// DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders"); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(OleDbConnection connection, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteDataset(connection, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a resultset) against the specified OleDbConnection /// using the provided parameters. ///

/// /// e.g.: /// DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(OleDbConnection connection, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( connection == null ) throw new ArgumentNullException( "connection" ); // Create a command and prepare it for execution OleDbCommand cmd = new OleDbCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, connection, (OleDbTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection ); // Create the DataAdapter & DataSet using( OleDbDataAdapter da = new OleDbDataAdapter(cmd) ) { DataSet ds = new DataSet(); // Fill the DataSet using default values for DataTable names, etc da.Fill(ds); // Detach the OleDbParameters from the command object, so they can be used again cmd.Parameters.Clear(); if( mustCloseConnection ) connection.Close(); // Return the dataset return ds; } } ///

/// Execute a stored procedure via a OleDbCommand (that returns a resultset) against the specified OleDbConnection /// using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// DataSet ds = ExecuteDataset(conn, "GetOrders", 24, 36); /// /// A valid OleDbConnection /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(OleDbConnection connection, string spName, params object[] parameterValues) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteDataset(connection, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteDataset(connection, CommandType.StoredProcedure, spName); } } ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the provided OleDbTransaction. ///

/// /// e.g.: /// DataSet ds = ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders"); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(OleDbTransaction transaction, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteDataset(transaction, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a resultset) against the specified OleDbTransaction /// using the provided parameters. ///

/// /// e.g.: /// DataSet ds = ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(OleDbTransaction transaction, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); // Create a command and prepare it for execution OleDbCommand cmd = new OleDbCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection ); // Create the DataAdapter & DataSet using( OleDbDataAdapter da = new OleDbDataAdapter(cmd) ) { DataSet ds = new DataSet(); // Fill the DataSet using default values for DataTable names, etc da.Fill(ds); // Detach the OleDbParameters from the command object, so they can be used again cmd.Parameters.Clear(); // Return the dataset return ds; } } ///

/// Execute a stored procedure via a OleDbCommand (that returns a resultset) against the specified /// OleDbTransaction using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// DataSet ds = ExecuteDataset(trans, "GetOrders", 24, 36); /// /// A valid OleDbTransaction /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// A dataset containing the resultset generated by the command public static DataSet ExecuteDataset(OleDbTransaction transaction, string spName, params object[] parameterValues) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteDataset(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteDataset(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteDataset #region ExecuteReader ///

/// This enum is used to indicate whether the connection was provided by the caller, or created by SqlHelper, so that /// we can set the appropriate CommandBehavior when calling ExecuteReader() ///

private enum OleDbConnectionOwnership { ///

Connection is owned and managed by SqlHelper

Internal, ///

Connection is owned and managed by the caller

External } ///

/// Create and prepare a OleDbCommand, and call ExecuteReader with the appropriate CommandBehavior. ///

/// /// If we created and opened the connection, we want the connection to be closed when the DataReader is closed. /// /// If the caller provided the connection, we want to leave it to them to manage. /// /// A valid OleDbConnection, on which to execute this command /// A valid OleDbTransaction, or 'null' /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of OleDbParameters to be associated with the command or 'null' if no parameters are required /// Indicates whether the connection parameter was provided by the caller, or created by SqlHelper /// OleDbDataReader containing the results of the command private static OleDbDataReader ExecuteReader(OleDbConnection connection, OleDbTransaction transaction, CommandType commandType, string commandText, OleDbParameter[] commandParameters, OleDbConnectionOwnership connectionOwnership) { if( connection == null ) throw new ArgumentNullException( "connection" ); bool mustCloseConnection = false; // Create a command and prepare it for execution OleDbCommand cmd = new OleDbCommand(); try { PrepareCommand(cmd, connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection ); // Create a reader OleDbDataReader dataReader; // Call ExecuteReader with the appropriate CommandBehavior if (connectionOwnership == OleDbConnectionOwnership.External) { dataReader = cmd.ExecuteReader(); } else { dataReader = cmd.ExecuteReader(CommandBehavior.CloseConnection); } // Detach the OleDbParameters from the command object, so they can be used again. // HACK: There is a problem here, the output parameter values are fletched // when the reader is closed, so if the parameters are detached from the command // then the SqlReader can�t set its values. // When this happen, the parameters can�t be used again in other command. bool canClear = true; foreach(OleDbParameter commandParameter in cmd.Parameters) { if (commandParameter.Direction != ParameterDirection.Input) canClear = false; } if (canClear) { cmd.Parameters.Clear(); } return dataReader; } catch { if( mustCloseConnection ) connection.Close(); throw; } } ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the database specified in /// the connection string. ///

/// /// e.g.: /// OleDbDataReader dr = ExecuteReader(connString, CommandType.StoredProcedure, "GetOrders"); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(string connectionString, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteReader(connectionString, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a resultset) against the database specified in the connection string /// using the provided parameters. ///

/// /// e.g.: /// OleDbDataReader dr = ExecuteReader(connString, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(string connectionString, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); try { if(OleDbConnection==null) { OleDbConnection= new OleDbConnection(connectionString); } if(OleDbConnection.State==ConnectionState.Closed) { OleDbConnection.Open(); } // Call the private overload that takes an internally owned connection in place of the connection string return ExecuteReader(OleDbConnection, null, commandType, commandText, commandParameters,OleDbConnectionOwnership.Internal); } catch { // If we fail to return the SqlDatReader, we need to close the connection ourselves if( OleDbConnection != null ) OleDbConnection.Close(); throw; } } ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// OleDbDataReader dr = ExecuteReader(connString, "GetOrders", 24, 36); /// /// A valid connection string for a OleDbConnection /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(string connectionString, string spName, params object[] parameterValues) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connectionString, spName); AssignParameterValues(commandParameters, parameterValues); return ExecuteReader(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteReader(connectionString, CommandType.StoredProcedure, spName); } } ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the provided OleDbConnection. ///

/// /// e.g.: /// OleDbDataReader dr = ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders"); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(OleDbConnection connection, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteReader(connection, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a resultset) against the specified OleDbConnection /// using the provided parameters. ///

/// /// e.g.: /// OleDbDataReader dr = ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(OleDbConnection connection, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { // Pass through the call to the private overload using a null transaction value and an externally owned connection return ExecuteReader(connection, (OleDbTransaction)null, commandType, commandText, commandParameters, OleDbConnectionOwnership.External); } ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// OleDbDataReader dr = ExecuteReader(conn, "GetOrders", 24, 36); /// /// A valid OleDbConnection /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(OleDbConnection connection, string spName, params object[] parameterValues) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); AssignParameterValues(commandParameters, parameterValues); return ExecuteReader(connection, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteReader(connection, CommandType.StoredProcedure, spName); } } ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the provided OleDbTransaction. ///

/// /// e.g.: /// OleDbDataReader dr = ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders"); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(OleDbTransaction transaction, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteReader(transaction, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a resultset) against the specified OleDbTransaction /// using the provided parameters. ///

/// /// e.g.: /// OleDbDataReader dr = ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(OleDbTransaction transaction, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); // Pass through to private overload, indicating that the connection is owned by the caller return ExecuteReader(transaction.Connection, transaction, commandType, commandText, commandParameters, OleDbConnectionOwnership.External); } ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// OleDbDataReader dr = ExecuteReader(trans, "GetOrders", 24, 36); /// /// A valid OleDbTransaction /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReader(OleDbTransaction transaction, string spName, params object[] parameterValues) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); AssignParameterValues(commandParameters, parameterValues); return ExecuteReader(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteReader(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteReader #region ExecuteScalar ///

/// Execute a OleDbCommand (that returns a 1x1 resultset and takes no parameters) against the database specified in /// the connection string. ///

/// /// e.g.: /// int orderCount = (int)ExecuteScalar(connString, CommandType.StoredProcedure, "GetOrderCount"); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(string connectionString, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteScalar(connectionString, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a 1x1 resultset) against the database specified in the connection string /// using the provided parameters. ///

/// /// e.g.: /// int orderCount = (int)ExecuteScalar(connString, CommandType.StoredProcedure, "GetOrderCount", new OleDbParameter("@prodid", 24)); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(string connectionString, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); // Create & open a OleDbConnection, and dispose of it after we are done if(OleDbConnection==null) { OleDbConnection= new OleDbConnection(connectionString); } if(OleDbConnection.State==ConnectionState.Closed) { OleDbConnection.Open(); } // Call the overload that takes a connection in place of the connection string return ExecuteScalar(OleDbConnection, commandType, commandText, commandParameters); } ///

/// Execute a stored procedure via a OleDbCommand (that returns a 1x1 resultset) against the database specified in /// the connection string using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// int orderCount = (int)ExecuteScalar(connString, "GetOrderCount", 24, 36); /// /// A valid connection string for a OleDbConnection /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(string connectionString, string spName, params object[] parameterValues) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connectionString, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteScalar(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteScalar(connectionString, CommandType.StoredProcedure, spName); } } ///

/// Execute a OleDbCommand (that returns a 1x1 resultset and takes no parameters) against the provided OleDbConnection. ///

/// /// e.g.: /// int orderCount = (int)ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount"); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(OleDbConnection connection, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteScalar(connection, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a 1x1 resultset) against the specified OleDbConnection /// using the provided parameters. ///

/// /// e.g.: /// int orderCount = (int)ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(OleDbConnection connection, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( connection == null ) throw new ArgumentNullException( "connection" ); // Create a command and prepare it for execution OleDbCommand cmd = new OleDbCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, connection, (OleDbTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection ); // Execute the command & return the results object retval = cmd.ExecuteScalar(); // Detach the OleDbParameters from the command object, so they can be used again cmd.Parameters.Clear(); if( mustCloseConnection ) connection.Close(); return retval; } ///

/// Execute a stored procedure via a OleDbCommand (that returns a 1x1 resultset) against the specified OleDbConnection /// using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// int orderCount = (int)ExecuteScalar(conn, "GetOrderCount", 24, 36); /// /// A valid OleDbConnection /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(OleDbConnection connection, string spName, params object[] parameterValues) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteScalar(connection, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteScalar(connection, CommandType.StoredProcedure, spName); } } ///

/// Execute a OleDbCommand (that returns a 1x1 resultset and takes no parameters) against the provided OleDbTransaction. ///

/// /// e.g.: /// int orderCount = (int)ExecuteScalar(trans, CommandType.StoredProcedure, "GetOrderCount"); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(OleDbTransaction transaction, CommandType commandType, string commandText) { // Pass through the call providing null for the set of OleDbParameters return ExecuteScalar(transaction, commandType, commandText, (OleDbParameter[])null); } ///

/// Execute a OleDbCommand (that returns a 1x1 resultset) against the specified OleDbTransaction /// using the provided parameters. ///

/// /// e.g.: /// int orderCount = (int)ExecuteScalar(trans, CommandType.StoredProcedure, "GetOrderCount", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(OleDbTransaction transaction, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); // Create a command and prepare it for execution OleDbCommand cmd = new OleDbCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection ); // Execute the command & return the results object retval = cmd.ExecuteScalar(); // Detach the OleDbParameters from the command object, so they can be used again cmd.Parameters.Clear(); return retval; } ///

/// Execute a stored procedure via a OleDbCommand (that returns a 1x1 resultset) against the specified /// OleDbTransaction using the provided parameter values. This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// int orderCount = (int)ExecuteScalar(trans, "GetOrderCount", 24, 36); /// /// A valid OleDbTransaction /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalar(OleDbTransaction transaction, string spName, params object[] parameterValues) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // PPull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters return ExecuteScalar(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { // Otherwise we can just call the SP without params return ExecuteScalar(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteScalar #region Duplicate Code public static bool IsDuplicate(string sTableName,string sFieldName,string sValue,string sSQLClause) { bool bIsDuplicate=false; if (sSQLClause=="") { sSQLClause=SQL.MakeSQL( " WHERE %q =%q",sFieldName,sValue); } else { sSQLClause=SQL.MakeSQL( " WHERE %q =%q",sFieldName,sValue) + sSQLClause; } object nCount= ExecuteScalar(OleDbTransaction,CommandType.Text,SQL.MakeSQL("SELECT COUNT(%q)" + "FROM %q %q",sFieldName,sTableName,sSQLClause)); if (Convert.ToInt32(nCount)==0) { bIsDuplicate=false; } else { bIsDuplicate=true; } return bIsDuplicate; } #endregion #region Generate ID public static int GenerateID(string sTableName,string sFieldName,string sSQLClause) { object nMaxID= ExecuteScalar(OleDbTransaction,CommandType.Text,SQL.MakeSQL("SELECT MAX(%q)" + "FROM %q %q",sFieldName,sTableName,sSQLClause)); if (nMaxID==DBNull.Value ) { nMaxID= 1; } else { nMaxID=Convert.ToInt32(nMaxID) +1 ; if ((int)nMaxID<=0) { nMaxID= 1; } } return (int)nMaxID; } public static int GenerateID(string sTableName,string sFieldName) { return GenerateID(sTableName,sFieldName,""); } public static int GenerateID(string sTableName,string sFieldName,string sSQLClause,string sConString) { object nMaxID= ExecuteScalar(sConString,CommandType.Text,SQL.MakeSQL("SELECT MAX(%q)" + "FROM %q %q",sFieldName,sTableName,sSQLClause)); if (nMaxID==DBNull.Value ) { nMaxID= 1; } else { nMaxID=Convert.ToInt32(nMaxID) +1 ; if ((int)nMaxID<=0) { nMaxID= 1; } } return (int)nMaxID; } #endregion #region Get Stored Procedure parameter public static OleDbParameter GetParameter(ParameterDirection pdirection,DbType datatype,object pValue) { OleDbParameter parameter=new OleDbParameter(); parameter.Direction=pdirection ; parameter.DbType =datatype ; if(datatype==DbType.AnsiString) {parameter.Size=20; } parameter.Value=pValue ; return parameter; } #endregion // #region ExecuteXmlReader ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the provided OleDbConnection. ///

/// /// e.g.: /// XmlReader r = ExecuteXmlReader(conn, CommandType.StoredProcedure, "GetOrders"); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command using "FOR XML AUTO" /// An XmlReader containing the resultset generated by the command // public static XmlReader ExecuteXmlReader(OleDbConnection connection, CommandType commandType, string commandText) // { // // Pass through the call providing null for the set of OleDbParameters // return ExecuteXmlReader(connection, commandType, commandText, (OleDbParameter[])null); // } ///

/// Execute a OleDbCommand (that returns a resultset) against the specified OleDbConnection /// using the provided parameters. ///

/// /// e.g.: /// XmlReader r = ExecuteXmlReader(conn, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command using "FOR XML AUTO" /// An array of SqlParamters used to execute the command /// An XmlReader containing the resultset generated by the command // public static XmlReader ExecuteXmlReader(OleDbConnection connection, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) // { // if( connection == null ) throw new ArgumentNullException( "connection" ); // // bool mustCloseConnection = false; // // Create a command and prepare it for execution // OleDbCommand cmd = new OleDbCommand(); // try // { // PrepareCommand(cmd, connection, (OleDbTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection ); // // // Create the DataAdapter & DataSet // XmlReader retval = cmd.ExecuteXmlReader(); // // // Detach the OleDbParameters from the command object, so they can be used again // cmd.Parameters.Clear(); // // return retval; // } // catch // { // if( mustCloseConnection ) // connection.Close(); // throw; // } // } ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// XmlReader r = ExecuteXmlReader(conn, "GetOrders", 24, 36); /// /// A valid OleDbConnection /// The name of the stored procedure using "FOR XML AUTO" /// An array of objects to be assigned as the input values of the stored procedure /// An XmlReader containing the resultset generated by the command // public static XmlReader ExecuteXmlReader(OleDbConnection connection, string spName, params object[] parameterValues) // { // if( connection == null ) throw new ArgumentNullException( "connection" ); // if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // // // If we receive parameter values, we need to figure out where they go // if ((parameterValues != null) && (parameterValues.Length > 0)) // { // // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) // OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // // // Assign the provided values to these parameters based on parameter order // AssignParameterValues(commandParameters, parameterValues); // // // Call the overload that takes an array of OleDbParameters // return ExecuteXmlReader(connection, CommandType.StoredProcedure, spName, commandParameters); // } // else // { // // Otherwise we can just call the SP without params // return ExecuteXmlReader(connection, CommandType.StoredProcedure, spName); // } // } ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the provided OleDbTransaction. ///

/// /// e.g.: /// XmlReader r = ExecuteXmlReader(trans, CommandType.StoredProcedure, "GetOrders"); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command using "FOR XML AUTO" /// An XmlReader containing the resultset generated by the command // public static XmlReader ExecuteXmlReader(OleDbTransaction transaction, CommandType commandType, string commandText) // { // // Pass through the call providing null for the set of OleDbParameters // return ExecuteXmlReader(transaction, commandType, commandText, (OleDbParameter[])null); // } ///

/// Execute a OleDbCommand (that returns a resultset) against the specified OleDbTransaction /// using the provided parameters. ///

/// /// e.g.: /// XmlReader r = ExecuteXmlReader(trans, CommandType.StoredProcedure, "GetOrders", new OleDbParameter("@prodid", 24)); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command using "FOR XML AUTO" /// An array of SqlParamters used to execute the command /// An XmlReader containing the resultset generated by the command // public static XmlReader ExecuteXmlReader(OleDbTransaction transaction, CommandType commandType, string commandText, params OleDbParameter[] commandParameters) // { // if( transaction == null ) throw new ArgumentNullException( "transaction" ); // if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); // // // Create a command and prepare it for execution // OleDbCommand cmd = new OleDbCommand(); // bool mustCloseConnection = false; // PrepareCommand(cmd, transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection ); // // // Create the DataAdapter & DataSet // XmlReader retval = cmd.ExecuteXmlReader(); // // // Detach the OleDbParameters from the command object, so they can be used again // cmd.Parameters.Clear(); // return retval; // } ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// XmlReader r = ExecuteXmlReader(trans, "GetOrders", 24, 36); /// /// A valid OleDbTransaction /// The name of the stored procedure /// An array of objects to be assigned as the input values of the stored procedure /// A dataset containing the resultset generated by the command // public static XmlReader ExecuteXmlReader(OleDbTransaction transaction, string spName, params object[] parameterValues) // { // if( transaction == null ) throw new ArgumentNullException( "transaction" ); // if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); // if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // // // If we receive parameter values, we need to figure out where they go // if ((parameterValues != null) && (parameterValues.Length > 0)) // { // // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) // OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // // // Assign the provided values to these parameters based on parameter order // AssignParameterValues(commandParameters, parameterValues); // // // Call the overload that takes an array of OleDbParameters // return ExecuteXmlReader(transaction, CommandType.StoredProcedure, spName, commandParameters); // } // else // { // // Otherwise we can just call the SP without params // return ExecuteXmlReader(transaction, CommandType.StoredProcedure, spName); // } // } // // #endregion ExecuteXmlReader #region FillDataset ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the database specified in /// the connection string. ///

/// /// e.g.: /// FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) public static void FillDataset(string connectionString, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( dataSet == null ) throw new ArgumentNullException( "dataSet" ); // Create & open a OleDbConnection, and dispose of it after we are done if(OleDbConnection==null) { OleDbConnection= new OleDbConnection(connectionString); } if(OleDbConnection.State==ConnectionState.Closed) { OleDbConnection.Open(); } // Call the overload that takes a connection in place of the connection string FillDataset(OleDbConnection, commandType, commandText, dataSet, tableNames); } ///

/// Execute a OleDbCommand (that returns a resultset) against the database specified in the connection string /// using the provided parameters. ///

/// /// e.g.: /// FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new OleDbParameter("@prodid", 24)); /// /// A valid connection string for a OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// An array of SqlParamters used to execute the command /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// public static void FillDataset(string connectionString, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames, params OleDbParameter[] commandParameters) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( dataSet == null ) throw new ArgumentNullException( "dataSet" ); // Create & open a OleDbConnection, and dispose of it after we are done if(OleDbConnection==null) { OleDbConnection= new OleDbConnection(connectionString); } if(OleDbConnection.State==ConnectionState.Closed) { OleDbConnection.Open(); } // Call the overload that takes a connection in place of the connection string FillDataset(OleDbConnection, commandType, commandText, dataSet, tableNames, commandParameters); } ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, 24); /// /// A valid connection string for a OleDbConnection /// The name of the stored procedure /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// /// An array of objects to be assigned as the input values of the stored procedure public static void FillDataset(string connectionString, string spName, DataSet dataSet, string[] tableNames, params object[] parameterValues) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( dataSet == null ) throw new ArgumentNullException( "dataSet" ); // Create & open a OleDbConnection, and dispose of it after we are done if(OleDbConnection==null) { OleDbConnection= new OleDbConnection(connectionString); } if(OleDbConnection.State==ConnectionState.Closed) { OleDbConnection.Open(); } // Call the overload that takes a connection in place of the connection string FillDataset (OleDbConnection, spName, dataSet, tableNames, parameterValues); } ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the provided OleDbConnection. ///

/// /// e.g.: /// FillDataset(conn, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// public static void FillDataset(OleDbConnection connection, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames) { FillDataset(connection, commandType, commandText, dataSet, tableNames, null); } ///

/// Execute a OleDbCommand (that returns a resultset) against the specified OleDbConnection /// using the provided parameters. ///

/// /// e.g.: /// FillDataset(conn, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new OleDbParameter("@prodid", 24)); /// /// A valid OleDbConnection /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// /// An array of SqlParamters used to execute the command public static void FillDataset(OleDbConnection connection, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames, params OleDbParameter[] commandParameters) { FillDataset(connection, null, commandType, commandText, dataSet, tableNames, commandParameters); } ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// FillDataset(conn, "GetOrders", ds, new string[] {"orders"}, 24, 36); /// /// A valid OleDbConnection /// The name of the stored procedure /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// /// An array of objects to be assigned as the input values of the stored procedure public static void FillDataset(OleDbConnection connection, string spName, DataSet dataSet, string[] tableNames, params object[] parameterValues) { if ( connection == null ) throw new ArgumentNullException( "connection" ); if (dataSet == null ) throw new ArgumentNullException( "dataSet" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters FillDataset(connection, CommandType.StoredProcedure, spName, dataSet, tableNames, commandParameters); } else { // Otherwise we can just call the SP without params FillDataset(connection, CommandType.StoredProcedure, spName, dataSet, tableNames); } } ///

/// Execute a OleDbCommand (that returns a resultset and takes no parameters) against the provided OleDbTransaction. ///

/// /// e.g.: /// FillDataset(trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// public static void FillDataset(OleDbTransaction transaction, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames) { FillDataset (transaction, commandType, commandText, dataSet, tableNames, null); } ///

/// Execute a OleDbCommand (that returns a resultset) against the specified OleDbTransaction /// using the provided parameters. ///

/// /// e.g.: /// FillDataset(trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new OleDbParameter("@prodid", 24)); /// /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// /// An array of SqlParamters used to execute the command public static void FillDataset(OleDbTransaction transaction, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames, params OleDbParameter[] commandParameters) { FillDataset(transaction.Connection, transaction, commandType, commandText, dataSet, tableNames, commandParameters); } ///

/// /// This method provides no access to output parameters or the stored procedure's return value parameter. /// /// e.g.: /// FillDataset(trans, "GetOrders", ds, new string[]{"orders"}, 24, 36); /// /// A valid OleDbTransaction /// The name of the stored procedure /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// /// An array of objects to be assigned as the input values of the stored procedure public static void FillDataset(OleDbTransaction transaction, string spName, DataSet dataSet, string[] tableNames, params object[] parameterValues) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( dataSet == null ) throw new ArgumentNullException( "dataSet" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If we receive parameter values, we need to figure out where they go if ((parameterValues != null) && (parameterValues.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // Assign the provided values to these parameters based on parameter order AssignParameterValues(commandParameters, parameterValues); // Call the overload that takes an array of OleDbParameters FillDataset(transaction, CommandType.StoredProcedure, spName, dataSet, tableNames, commandParameters); } else { // Otherwise we can just call the SP without params FillDataset(transaction, CommandType.StoredProcedure, spName, dataSet, tableNames); } } ///

/// Private helper method that execute a OleDbCommand (that returns a resultset) against the specified OleDbTransaction and OleDbConnection /// using the provided parameters. ///

/// /// e.g.: /// FillDataset(conn, trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new OleDbParameter("@prodid", 24)); /// /// A valid OleDbConnection /// A valid OleDbTransaction /// The CommandType (stored procedure, text, etc.) /// The stored procedure name or T-SQL command /// A dataset wich will contain the resultset generated by the command /// This array will be used to create table mappings allowing the DataTables to be referenced /// by a user defined name (probably the actual table name) /// /// An array of SqlParamters used to execute the command private static void FillDataset(OleDbConnection connection, OleDbTransaction transaction, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames, params OleDbParameter[] commandParameters) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( dataSet == null ) throw new ArgumentNullException( "dataSet" ); // Create a command and prepare it for execution OleDbCommand command = new OleDbCommand(); bool mustCloseConnection = false; PrepareCommand(command, connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection ); // Create the DataAdapter & DataSet using( OleDbDataAdapter dataAdapter = new OleDbDataAdapter(command) ) { // Add the table mappings specified by the user if (tableNames != null && tableNames.Length > 0) { string tableName = "Table"; for (int index=0; index < tableNames.Length; index++) { if( tableNames[index] == null || tableNames[index].Length == 0 ) throw new ArgumentException( "The tableNames parameter must contain a list of tables, a value was provided as null or empty string.", "tableNames" ); dataAdapter.TableMappings.Add(tableName, tableNames[index]); tableName += (index + 1).ToString(); } } // Fill the DataSet using default values for DataTable names, etc dataAdapter.Fill(dataSet); // Detach the OleDbParameters from the command object, so they can be used again command.Parameters.Clear(); } if( mustCloseConnection ) connection.Close(); } #endregion #region UpdateDataset ///

/// Executes the respective command for each inserted, updated, or deleted row in the DataSet. ///

/// /// e.g.: /// UpdateDataset(conn, insertCommand, deleteCommand, updateCommand, dataSet, "Order"); /// /// A valid transact-SQL statement or stored procedure to insert new records into the data source /// A valid transact-SQL statement or stored procedure to delete records from the data source /// A valid transact-SQL statement or stored procedure used to update records in the data source /// The DataSet used to update the data source /// The DataTable used to update the data source. public static void UpdateDataset(OleDbCommand insertCommand, OleDbCommand deleteCommand, OleDbCommand updateCommand, DataSet dataSet, string tableName) { if( insertCommand == null ) throw new ArgumentNullException( "insertCommand" ); if( deleteCommand == null ) throw new ArgumentNullException( "deleteCommand" ); if( updateCommand == null ) throw new ArgumentNullException( "updateCommand" ); if( tableName == null || tableName.Length == 0 ) throw new ArgumentNullException( "tableName" ); // Create a OleDbDataAdapter, and dispose of it after we are done using (OleDbDataAdapter dataAdapter = new OleDbDataAdapter()) { // Set the data adapter commands dataAdapter.UpdateCommand = updateCommand; dataAdapter.InsertCommand = insertCommand; dataAdapter.DeleteCommand = deleteCommand; // Update the dataset changes in the data source dataAdapter.Update (dataSet, tableName); // Commit all the changes made to the DataSet dataSet.AcceptChanges(); } } #endregion #region CreateCommand ///

/// Simplify the creation of a Sql command object by allowing /// a stored procedure and optional parameters to be provided ///

/// /// e.g.: /// OleDbCommand command = CreateCommand(conn, "AddCustomer", "CustomerID", "CustomerName"); /// /// A valid OleDbConnection object /// The name of the stored procedure /// An array of string to be assigned as the source columns of the stored procedure parameters /// A valid OleDbCommand object public static OleDbCommand CreateCommand(OleDbConnection connection, string spName, params string[] sourceColumns) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // Create a OleDbCommand OleDbCommand cmd = new OleDbCommand( spName, connection ); cmd.CommandType = CommandType.StoredProcedure; // If we receive parameter values, we need to figure out where they go if ((sourceColumns != null) && (sourceColumns.Length > 0)) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Assign the provided source columns to these parameters based on parameter order for (int index=0; index < sourceColumns.Length; index++) commandParameters[index].SourceColumn = sourceColumns[index]; // Attach the discovered parameters to the OleDbCommand object AttachParameters (cmd, commandParameters); } return cmd; } #endregion #region ExecuteNonQueryTypedParams ///

/// Execute a stored procedure via a OleDbCommand (that returns no resultset) against the database specified in /// the connection string using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on row values. ///

/// A valid connection string for a OleDbConnection /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// An int representing the number of rows affected by the command public static int ExecuteNonQueryTypedParams(String connectionString, String spName, DataRow dataRow) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if (dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connectionString, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName); } } ///

/// Execute a stored procedure via a OleDbCommand (that returns no resultset) against the specified OleDbConnection /// using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on row values. ///

/// A valid OleDbConnection object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// An int representing the number of rows affected by the command public static int ExecuteNonQueryTypedParams(OleDbConnection connection, String spName, DataRow dataRow) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if (dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteNonQuery(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteNonQuery(connection, CommandType.StoredProcedure, spName); } } ///

/// Execute a stored procedure via a OleDbCommand (that returns no resultset) against the specified /// OleDbTransaction using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on row values. ///

/// A valid OleDbTransaction object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// An int representing the number of rows affected by the command public static int ExecuteNonQueryTypedParams(OleDbTransaction transaction, String spName, DataRow dataRow) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // Sf the row has values, the store procedure parameters must be initialized if (dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName); } } #endregion #region ExecuteDatasetTypedParams ///

/// Execute a stored procedure via a OleDbCommand (that returns a resultset) against the database specified in /// the connection string using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on row values. ///

/// A valid connection string for a OleDbConnection /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// A dataset containing the resultset generated by the command public static DataSet ExecuteDatasetTypedParams(string connectionString, String spName, DataRow dataRow) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); //If the row has values, the store procedure parameters must be initialized if ( dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connectionString, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteDataset(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteDataset(connectionString, CommandType.StoredProcedure, spName); } } ///

/// Execute a stored procedure via a OleDbCommand (that returns a resultset) against the specified OleDbConnection /// using the dataRow column values as the store procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on row values. ///

/// A valid OleDbConnection object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// A dataset containing the resultset generated by the command public static DataSet ExecuteDatasetTypedParams(OleDbConnection connection, String spName, DataRow dataRow) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if( dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteDataset(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteDataset(connection, CommandType.StoredProcedure, spName); } } ///

/// Execute a stored procedure via a OleDbCommand (that returns a resultset) against the specified OleDbTransaction /// using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on row values. ///

/// A valid OleDbTransaction object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// A dataset containing the resultset generated by the command public static DataSet ExecuteDatasetTypedParams(OleDbTransaction transaction, String spName, DataRow dataRow) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if( dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteDataset(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteDataset(transaction, CommandType.StoredProcedure, spName); } } #endregion #region ExecuteReaderTypedParams ///

/// A valid connection string for a OleDbConnection /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReaderTypedParams(String connectionString, String spName, DataRow dataRow) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if ( dataRow != null && dataRow.ItemArray.Length > 0 ) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connectionString, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteReader(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteReader(connectionString, CommandType.StoredProcedure, spName); } } ///

/// Execute a stored procedure via a OleDbCommand (that returns a resultset) against the specified OleDbConnection /// using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// A valid OleDbConnection object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReaderTypedParams(OleDbConnection connection, String spName, DataRow dataRow) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if( dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteReader(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteReader(connection, CommandType.StoredProcedure, spName); } } ///

/// A valid OleDbTransaction object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// A OleDbDataReader containing the resultset generated by the command public static OleDbDataReader ExecuteReaderTypedParams(OleDbTransaction transaction, String spName, DataRow dataRow) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if( dataRow != null && dataRow.ItemArray.Length > 0 ) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteReader(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteReader(transaction, CommandType.StoredProcedure, spName); } } #endregion #region ExecuteScalarTypedParams ///

/// Execute a stored procedure via a OleDbCommand (that returns a 1x1 resultset) against the database specified in /// the connection string using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// A valid connection string for a OleDbConnection /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalarTypedParams(String connectionString, String spName, DataRow dataRow) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if( dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connectionString, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteScalar(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteScalar(connectionString, CommandType.StoredProcedure, spName); } } ///

/// Execute a stored procedure via a OleDbCommand (that returns a 1x1 resultset) against the specified OleDbConnection /// using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// A valid OleDbConnection object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalarTypedParams(OleDbConnection connection, String spName, DataRow dataRow) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if( dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteScalar(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteScalar(connection, CommandType.StoredProcedure, spName); } } ///

/// Execute a stored procedure via a OleDbCommand (that returns a 1x1 resultset) against the specified OleDbTransaction /// using the dataRow column values as the stored procedure's parameters values. /// This method will query the database to discover the parameters for the /// stored procedure (the first time each stored procedure is called), and assign the values based on parameter order. ///

/// A valid OleDbTransaction object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// An object containing the value in the 1x1 resultset generated by the command public static object ExecuteScalarTypedParams(OleDbTransaction transaction, String spName, DataRow dataRow) { if( transaction == null ) throw new ArgumentNullException( "transaction" ); if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // If the row has values, the store procedure parameters must be initialized if( dataRow != null && dataRow.ItemArray.Length > 0) { // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // Set the parameters values AssignParameterValues(commandParameters, dataRow); return SQLHelper.ExecuteScalar(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SQLHelper.ExecuteScalar(transaction, CommandType.StoredProcedure, spName); } } #endregion // #region ExecuteXmlReaderTypedParams ///

/// A valid OleDbConnection object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// An XmlReader containing the resultset generated by the command // public static XmlReader ExecuteXmlReaderTypedParams(OleDbConnection connection, String spName, DataRow dataRow) // { // if( connection == null ) throw new ArgumentNullException( "connection" ); // if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // // // If the row has values, the store procedure parameters must be initialized // if( dataRow != null && dataRow.ItemArray.Length > 0) // { // // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) // OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(connection, spName); // // // Set the parameters values // AssignParameterValues(commandParameters, dataRow); // // return SQLHelper.ExecuteXmlReader(connection, CommandType.StoredProcedure, spName, commandParameters); // } // else // { // return SQLHelper.ExecuteXmlReader(connection, CommandType.StoredProcedure, spName); // } // } ///

/// A valid OleDbTransaction object /// The name of the stored procedure /// The dataRow used to hold the stored procedure's parameter values. /// An XmlReader containing the resultset generated by the command // public static XmlReader ExecuteXmlReaderTypedParams(OleDbTransaction transaction, String spName, DataRow dataRow) // { // if( transaction == null ) throw new ArgumentNullException( "transaction" ); // if( transaction != null && transaction.Connection == null ) throw new ArgumentException( "The transaction was rollbacked or commited, please provide an open transaction.", "transaction" ); // if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); // // // If the row has values, the store procedure parameters must be initialized // if( dataRow != null && dataRow.ItemArray.Length > 0) // { // // Pull the parameters for this stored procedure from the parameter cache (or discover them & populate the cache) // OleDbParameter[] commandParameters = SQLHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // // // Set the parameters values // AssignParameterValues(commandParameters, dataRow); // // return SQLHelper.ExecuteXmlReader(transaction, CommandType.StoredProcedure, spName, commandParameters); // } // else // { // return SQLHelper.ExecuteXmlReader(transaction, CommandType.StoredProcedure, spName); // } // } // #endregion #region Transaction related private static void PrepareConnectiion() { if(OleDbConnection==null) throw new Exception("Cannot connect to SQL server"); // If the provided connection is not open, we will open it if (OleDbConnection.State!=ConnectionState.Open) { OleDbConnection.Open(); } } private static void PrepareOracleConnectiion() { if(OracleConnection==null) { if(DABase.OracleStaticConnectionString !="") { OracleConnection=new System.Data.OracleClient.OracleConnection(DABase.OracleStaticConnectionString); if(OracleConnection ==null) throw new Exception("Cannot connect to ORACLE server"); } else throw new Exception("Cannot connect to ORACLE server"); } // If the provided connection is not open, we will open it if (OracleConnection.State!=ConnectionState.Open) { OracleConnection.Open(); } } public static void BeginTran() { PrepareConnectiion(); OleDbTransaction=OleDbConnection.BeginTransaction(); } public static void BeginOracleTran() { PrepareOracleConnectiion(); OracleTransaction=OracleConnection.BeginTransaction(); } public static void ChangeConnection(string sConnectionString, SQLSyntax syntex) { OleDbConnection=new OleDbConnection(sConnectionString); SQL.SQLSyntax=syntex; } public static void CommitTran() { if(OleDbTransaction!=null) { OleDbTransaction.Commit(); OleDbTransaction=null; } if(OleDbConnection!=null) { if (OleDbConnection.State==ConnectionState.Open) { OleDbConnection.Close(); } } } public static void CommitOracleTran() { if(OracleTransaction!=null) { OracleTransaction.Commit(); OracleTransaction=null; } if(OracleConnection!=null) { if (OracleConnection.State==ConnectionState.Open) { OracleConnection.Close(); } } } public static void RollbackTran() { if(OleDbTransaction!=null) { OleDbTransaction.Rollback(); OleDbTransaction=null; } if(OleDbConnection!=null) { if (OleDbConnection.State==ConnectionState.Open) { OleDbConnection.Close(); } } } public static void RollbackOracleTran() { if(OracleTransaction!=null) { OracleTransaction.Rollback(); OracleTransaction=null; } if(OracleConnection!=null) { if (OracleConnection.State==ConnectionState.Open) { OracleConnection.Close(); } } } public static void CloseConnection() { OleDbTransaction=null; OleDbConnection.Close(); OleDbConnection.Dispose(); OleDbConnection=null; } #endregion } #endregion #region Parameter Cache ///

/// SqlHelperParameterCache provides functions to leverage a static cache of procedure parameters, and the /// ability to discover parameters for stored procedures at run-time. ///

public sealed class SQLHelperParameterCache:DABase { #region private methods, variables, and constructors //Since this class provides only static methods, make the default constructor private to prevent //instances from being created with "new SqlHelperParameterCache()" private SQLHelperParameterCache() {} private static Hashtable paramCache = Hashtable.Synchronized(new Hashtable()); ///

/// Resolve at run time the appropriate set of OleDbParameters for a stored procedure ///

/// A valid OleDbConnection object /// The name of the stored procedure /// Whether or not to include their return value parameter /// The parameter array discovered. private static OleDbParameter[] DiscoverSpParameterSet(OleDbConnection connection, string spName, bool includeReturnValueParameter) { if( connection == null ) throw new ArgumentNullException( "connection" ); if( spName == null || spName.Length == 0 ) throw new ArgumentNullException( "spName" ); OleDbCommand cmd = new OleDbCommand(spName, connection); cmd.CommandType = CommandType.StoredProcedure; connection.Open(); OleDbCommandBuilder.DeriveParameters(cmd); connection.Close(); if (!includeReturnValueParameter) { cmd.Parameters.RemoveAt(0); } OleDbParameter[] discoveredParameters = new OleDbParameter[cmd.Parameters.Count]; cmd.Parameters.CopyTo(discoveredParameters, 0); // Init the parameters with a DBNull value foreach (OleDbParameter discoveredParameter in discoveredParameters) { discoveredParameter.Value = DBNull.Value; } return discoveredParameters; } ///

/// Deep copy of cached OleDbParameter array ///

/// /// private static OleDbParameter[] CloneParameters(OleDbParameter[] originalParameters) { OleDbParameter[] clonedParameters = new OleDbParameter[originalParameters.Length]; for (int i = 0, j = originalParameters.Length; i < j; i++) { clonedParameters[i] = (OleDbParameter)((ICloneable)originalParameters[i]).Clone(); } return clonedParameters; } #endregion private methods, variables, and constructors #region caching functions ///

/// Add parameter array to the cache ///

/// A valid connection string for a OleDbConnection /// The stored procedure name or T-SQL command /// An array of SqlParamters to be cached public static void CacheParameterSet(string connectionString, string commandText, params OleDbParameter[] commandParameters) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( commandText == null || commandText.Length == 0 ) throw new ArgumentNullException( "commandText" ); string hashKey = connectionString + ":" + commandText; paramCache[hashKey] = commandParameters; } ///

/// Retrieve a parameter array from the cache ///

/// A valid connection string for a OleDbConnection /// The stored procedure name or T-SQL command /// An array of SqlParamters public static OleDbParameter[] GetCachedParameterSet(string connectionString, string commandText) { if( connectionString == null || connectionString.Length == 0 ) throw new ArgumentNullException( "connectionString" ); if( commandText == null || commandText.Length == 0 ) throw new ArgumentNullException( "commandText" ); string hashKey = connectionString + ":" + commandText; OleDbParameter[] cachedParameters = paramCache[hashKey] as OleDbParameter[]; if (cachedParameters == null) { return null; } else { return CloneParameters(cachedParameters); } } #endregion caching functions #region Parameter Discovery Functions ///