Access数据库转换为sdf数据库及SqlCeHelper类
在做Mobile项目时遇到一个问题，我们的Mobile项目需要使用SqlCe数据库，而客户提供的带有原始数据的数据库是Access格式的，所以我们面临的第一个问题是将Access数据库（*.mdb）转换成SqlCe数据库（*.sdf）。网上搜索的很多资料是关于如何将SqlServer 2005与SqlCe数据进行同步，主要是通过发布订阅及RDA编程来实现，可以参考的资料有：
用 SQL Server Management Studio 管理 SQL Server Compact Edition 数据库
SQL CE 和 SQL Server 的同步
Step by Step: Program Microsoft SQL Server CE 2.0 Merge Replication Using .NET Compact Framework
后来找到一个工具Data Port Wizard可以直接将其他数据库转换为SqlCe数据库，省了不少事。只是转换过程中遇到一个小小的问题，在客户提供的Access数据库的关系里设置了很多表与表之间的关系，但所有的表都没有设置主键，所以转换时就抛出异常。为了省事，我将Access表的关系全部删除，这样就顺利的将Access数据库转换成SqlCe 3.5版本的sdf数据库了。
至于操作SqlCe的数据层的类，在网上找到一个SqlCeHelper.cs，转贴如下：
using System;
using System.Data;
using System.Data.SqlServerCe;
using System.Configuration;
using System.Collections;
namespace SbuxMobile.DAL
{
///
/// The SqlCeHelper class is intended to encapsulate high performance, scalable best practices for
/// common uses of SqlClient
///
public sealed partial class SqlCeHelper
{
#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 SqlCeHelper()"
private SqlCeHelper() { }
///
/// This method is used to attach array of SqlCeParameters to a SqlCeCommand.
///
/// 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 SqlCeParameters to be added to command
private static void AttachParameters(SqlCeCommand command, SqlCeParameter[] commandParameters)
{
if (command == null) throw new ArgumentNullException("command");
if (commandParameters != null)
{
foreach (SqlCeParameter 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 SqlCeParameters
///
/// Array of SqlCeParameters to be assigned values
/// The dataRow used to hold the stored procedure's parameter values
private static void AssignParameterValues(SqlCeParameter[] commandParameters, DataRow dataRow)
{
if ((commandParameters == null) || (dataRow == null))
{
// Do nothing if we get no data
return;
}
int i = 0;
// Set the parameters values
foreach (SqlCeParameter 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 SqlCeParameters
///
/// Array of SqlCeParameters to be assigned values
/// Array of objects holding the values to be assigned
private static void AssignParameterValues(SqlCeParameter[] 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 SqlCeParameters, 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 SqlCeCommand to be prepared
/// A valid SqlCeConnection, on which to execute this command
/// A valid SqlCeTransaction, or 'null'
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// An array of SqlCeParameters 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(SqlCeCommand command, SqlCeConnection connection, SqlCeTransaction transaction, CommandType commandType, string commandText, SqlCeParameter[] 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 SqlCeCommand (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 SqlCeConnection
/// 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 SqlCeParameters
return ExecuteNonQuery(connectionString, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (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 SqlCeParameter("@prodid", 24));
///
/// A valid connection string for a SqlCeConnection
/// 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 SqlCeParameter[] commandParameters)
{
if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString");
// Create & open a SqlCeConnection, and dispose of it after we are done
using (SqlCeConnection connection = new SqlCeConnection(connectionString))
{
connection.Open();
// Call the overload that takes a connection in place of the connection string
return ExecuteNonQuery(connection, commandType, commandText, commandParameters);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (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 SqlCeConnection
/// 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
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 SqlCeCommand (that returns no resultset and takes no parameters) against the provided SqlCeConnection.
///
///
/// e.g.:
/// int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders");
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection connection, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteNonQuery(connection, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns no resultset) against the specified SqlCeConnection
/// using the provided parameters.
///
///
/// e.g.:
/// int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection connection, CommandType commandType, string commandText, params SqlCeParameter[] commandParameters)
{
if (connection == null) throw new ArgumentNullException("connection");
// Create a command and prepare it for execution
SqlCeCommand cmd = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(cmd, connection, (SqlCeTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection);
// Finally, execute the command
int retval = cmd.ExecuteNonQuery();
// Detach the SqlCeParameters 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 SqlCeCommand (that returns no resultset) against the specified SqlCeConnection
/// 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 SqlCeConnection
/// 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(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
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 SqlCeCommand (that returns no resultset and takes no parameters) against the provided SqlCeTransaction.
///
///
/// e.g.:
/// int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders");
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction transaction, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteNonQuery(transaction, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns no resultset) against the specified SqlCeTransaction
/// using the provided parameters.
///
///
/// e.g.:
/// int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction transaction, CommandType commandType, string commandText, params SqlCeParameter[] 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
SqlCeCommand cmd = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(cmd, (SqlCeConnection)transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection);
// Finally, execute the command
int retval = cmd.ExecuteNonQuery();
// Detach the SqlCeParameters from the command object, so they can be used again
cmd.Parameters.Clear();
return retval;
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns no resultset) against the specified
/// SqlCeTransaction 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 SqlCeTransaction
/// 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(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)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 SqlCeParameters
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 ExecuteDatatable
///
/// Execute a SqlCeCommand (that returns a resultset and takes no parameters) against the database specified in
/// the connection string.
///
///
/// e.g.:
/// DataTable dtb = ExecuteDataTable(connString, CommandType.StoredProcedure, "GetOrders");
///
/// A valid connection string for a SqlCeConnection
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(string connectionString, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteDataTable(connectionString, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the database specified in the connection string
/// using the provided parameters.
///
///
/// e.g.:
/// DataTable dtb = ExecuteDataTable(connString, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid connection string for a SqlCeConnection
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// An array of SqlParamters used to execute the command
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(string connectionString, CommandType commandType, string commandText, params SqlCeParameter[] commandParameters)
{
if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString");
// Create & open a SqlCeConnection, and dispose of it after we are done
using (SqlCeConnection connection = new SqlCeConnection(connectionString))
{
connection.Open();
// Call the overload that takes a connection in place of the connection string
return ExecuteDataTable(connection, commandType, commandText, commandParameters);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (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.:
/// DataTable dtb = ExecuteDataTable(connString, "GetOrders", 24, 36);
///
/// A valid connection string for a SqlCeConnection
/// The name of the stored procedure
/// An array of objects to be assigned as the input values of the stored procedure
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
return ExecuteDataTable(connectionString, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
// Otherwise we can just call the SP without params
return ExecuteDataTable(connectionString, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a SqlCeCommand (that returns a resultset and takes no parameters) against the provided SqlCeConnection.
///
///
/// e.g.:
/// DataTable dtb = ExecuteDataTable(conn, CommandType.StoredProcedure, "GetOrders");
///
/// A valid SqlCeConnection
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(SqlCeConnection connection, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteDataTable(connection, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// using the provided parameters.
///
///
/// e.g.:
/// DataTable dtb = ExecuteDataTable(conn, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeConnection
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// An array of SqlParamters used to execute the command
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(SqlCeConnection connection, CommandType commandType, string commandText, params SqlCeParameter[] commandParameters)
{
if (connection == null) throw new ArgumentNullException("connection");
// Create a command and prepare it for execution
SqlCeCommand cmd = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(cmd, connection, (SqlCeTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection);
// Create the DataAdapter & DataTable
using (SqlCeDataAdapter da = new SqlCeDataAdapter(cmd))
{
DataTable dtb = new DataTable();
dtb.Clear();
// Fill the DataTable using default values for DataTable names, etc
da.Fill(dtb);
// Detach the SqlCeParameters from the command object, so they can be used again
cmd.Parameters.Clear();
if (mustCloseConnection)
connection.Close();
// Return the DataTable
return dtb;
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// 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.:
/// DataTable dtb = ExecuteDataTable(conn, "GetOrders", 24, 36);
///
/// A valid SqlCeConnection
/// The name of the stored procedure
/// An array of objects to be assigned as the input values of the stored procedure
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
return ExecuteDataTable(connection, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
// Otherwise we can just call the SP without params
return ExecuteDataTable(connection, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a SqlCeCommand (that returns a resultset and takes no parameters) against the provided SqlCeTransaction.
///
///
/// e.g.:
/// DataTable dtb = ExecuteDataTable(trans, CommandType.StoredProcedure, "GetOrders");
///
/// A valid SqlCeTransaction
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(SqlCeTransaction transaction, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteDataTable(transaction, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the specified SqlCeTransaction
/// using the provided parameters.
///
///
/// e.g.:
/// DataTable dtb = ExecuteDataTable(trans, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeTransaction
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// An array of SqlParamters used to execute the command
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(SqlCeTransaction transaction, CommandType commandType, string commandText, params SqlCeParameter[] 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
SqlCeCommand cmd = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(cmd, (SqlCeConnection)transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection);
// Create the DataAdapter & DataTable
using (SqlCeDataAdapter da = new SqlCeDataAdapter(cmd))
{
DataTable dtb = new DataTable();
// Fill the DataTable using default values for DataTable names, etc
da.Fill(dtb);
// Detach the SqlCeParameters from the command object, so they can be used again
cmd.Parameters.Clear();
// Return the DataTable
return dtb;
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified
/// SqlCeTransaction 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.:
/// DataTable dtb = ExecuteDataTable(trans, "GetOrders", 24, 36);
///
/// A valid SqlCeTransaction
/// The name of the stored procedure
/// An array of objects to be assigned as the input values of the stored procedure
/// A DataTable containing the resultset generated by the command
public static DataTable ExecuteDataTable(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)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 SqlCeParameters
return ExecuteDataTable(transaction, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
// Otherwise we can just call the SP without params
return ExecuteDataTable(transaction, CommandType.StoredProcedure, spName);
}
}
#endregion ExecuteDataTable
#region ExecuteDataset
///
/// Execute a SqlCeCommand (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 SqlCeConnection
/// 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 SqlCeParameters
return ExecuteDataset(connectionString, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (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 SqlCeParameter("@prodid", 24));
///
/// A valid connection string for a SqlCeConnection
/// 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 SqlCeParameter[] commandParameters)
{
if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString");
// Create & open a SqlCeConnection, and dispose of it after we are done
using (SqlCeConnection connection = new SqlCeConnection(connectionString))
{
connection.Open();
// Call the overload that takes a connection in place of the connection string
return ExecuteDataset(connection, commandType, commandText, commandParameters);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (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 SqlCeConnection
/// 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
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 SqlCeCommand (that returns a resultset and takes no parameters) against the provided SqlCeConnection.
///
///
/// e.g.:
/// DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders");
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection connection, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteDataset(connection, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// using the provided parameters.
///
///
/// e.g.:
/// DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection connection, CommandType commandType, string commandText, params SqlCeParameter[] commandParameters)
{
if (connection == null) throw new ArgumentNullException("connection");
// Create a command and prepare it for execution
SqlCeCommand cmd = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(cmd, connection, (SqlCeTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection);
// Create the DataAdapter & DataSet
using (SqlCeDataAdapter da = new SqlCeDataAdapter(cmd))
{
DataSet ds = new DataSet();
// Fill the DataSet using default values for DataTable names, etc
da.Fill(ds);
// Detach the SqlCeParameters 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 SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// 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 SqlCeConnection
/// 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(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
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 SqlCeCommand (that returns a resultset and takes no parameters) against the provided SqlCeTransaction.
///
///
/// e.g.:
/// DataSet ds = ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders");
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction transaction, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteDataset(transaction, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the specified SqlCeTransaction
/// using the provided parameters.
///
///
/// e.g.:
/// DataSet ds = ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction transaction, CommandType commandType, string commandText, params SqlCeParameter[] 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
SqlCeCommand cmd = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(cmd, (SqlCeConnection)transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection);
// Create the DataAdapter & DataSet
using (SqlCeDataAdapter da = new SqlCeDataAdapter(cmd))
{
DataSet ds = new DataSet();
// Fill the DataSet using default values for DataTable names, etc
da.Fill(ds);
// Detach the SqlCeParameters from the command object, so they can be used again
cmd.Parameters.Clear();
// Return the dataset
return ds;
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified
/// SqlCeTransaction 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 SqlCeTransaction
/// 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(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)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 SqlCeParameters
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 SqlCeHelper, so that
/// we can set the appropriate CommandBehavior when calling ExecuteReader()
///
private enum SqlCeConnectionOwnership
{
/// Connection is owned and managed by SqlCeHelper
Internal,
/// Connection is owned and managed by the caller
External
}
///
/// Create and prepare a SqlCeCommand, 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 SqlCeConnection, on which to execute this command
/// A valid SqlCeTransaction, or 'null'
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// An array of SqlCeParameters 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 SqlCeHelper
/// SqlCeDataReader containing the results of the command
private static SqlCeDataReader ExecuteReader(SqlCeConnection connection, SqlCeTransaction transaction, CommandType commandType, string commandText, SqlCeParameter[] commandParameters, SqlCeConnectionOwnership connectionOwnership)
{
if (connection == null) throw new ArgumentNullException("connection");
bool mustCloseConnection = false;
// Create a command and prepare it for execution
SqlCeCommand cmd = new SqlCeCommand();
try
{
PrepareCommand(cmd, connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection);
// Create a reader
SqlCeDataReader dataReader;
// Call ExecuteReader with the appropriate CommandBehavior
if (connectionOwnership == SqlCeConnectionOwnership.External)
{
dataReader = cmd.ExecuteReader();
}
else
{
dataReader = cmd.ExecuteReader(CommandBehavior.CloseConnection);
}
// Detach the SqlCeParameters 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磘 set its values.
// When this happen, the parameters can磘 be used again in other command.
bool canClear = true;
foreach (SqlCeParameter 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 SqlCeCommand (that returns a resultset and takes no parameters) against the database specified in
/// the connection string.
///
///
/// e.g.:
/// SqlCeDataReader dr = ExecuteReader(connString, CommandType.StoredProcedure, "GetOrders");
///
/// A valid connection string for a SqlCeConnection
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReader(string connectionString, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteReader(connectionString, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the database specified in the connection string
/// using the provided parameters.
///
///
/// e.g.:
/// SqlCeDataReader dr = ExecuteReader(connString, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid connection string for a SqlCeConnection
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// An array of SqlParamters used to execute the command
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReader(string connectionString, CommandType commandType, string commandText, params SqlCeParameter[] commandParameters)
{
if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString");
SqlCeConnection connection = null;
try
{
connection = new SqlCeConnection(connectionString);
connection.Open();
// Call the private overload that takes an internally owned connection in place of the connection string
return ExecuteReader(connection, null, commandType, commandText, commandParameters, SqlCeConnectionOwnership.Internal);
}
catch
{
// If we fail to return the SqlDatReader, we need to close the connection ourselves
if (connection != null) connection.Close();
throw;
}
}
///
/// Execute a stored procedure via a SqlCeCommand (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.:
/// SqlCeDataReader dr = ExecuteReader(connString, "GetOrders", 24, 36);
///
/// A valid connection string for a SqlCeConnection
/// The name of the stored procedure
/// An array of objects to be assigned as the input values of the stored procedure
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader 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))
{
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeCommand (that returns a resultset and takes no parameters) against the provided SqlCeConnection.
///
///
/// e.g.:
/// SqlCeDataReader dr = ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders");
///
/// A valid SqlCeConnection
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReader(SqlCeConnection connection, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteReader(connection, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// using the provided parameters.
///
///
/// e.g.:
/// SqlCeDataReader dr = ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeConnection
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// An array of SqlParamters used to execute the command
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReader(SqlCeConnection connection, CommandType commandType, string commandText, params SqlCeParameter[] commandParameters)
{
// Pass through the call to the private overload using a null transaction value and an externally owned connection
return ExecuteReader(connection, (SqlCeTransaction)null, commandType, commandText, commandParameters, SqlCeConnectionOwnership.External);
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// 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.:
/// SqlCeDataReader dr = ExecuteReader(conn, "GetOrders", 24, 36);
///
/// A valid SqlCeConnection
/// The name of the stored procedure
/// An array of objects to be assigned as the input values of the stored procedure
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReader(SqlCeConnection 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))
{
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeCommand (that returns a resultset and takes no parameters) against the provided SqlCeTransaction.
///
///
/// e.g.:
/// SqlCeDataReader dr = ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders");
///
/// A valid SqlCeTransaction
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReader(SqlCeTransaction transaction, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteReader(transaction, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the specified SqlCeTransaction
/// using the provided parameters.
///
///
/// e.g.:
/// SqlCeDataReader dr = ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeTransaction
/// The CommandType (stored procedure, text, etc.)
/// The stored procedure name or T-SQL command
/// An array of SqlParamters used to execute the command
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReader(SqlCeTransaction transaction, CommandType commandType, string commandText, params SqlCeParameter[] 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((SqlCeConnection)transaction.Connection, transaction, commandType, commandText, commandParameters, SqlCeConnectionOwnership.External);
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified
/// SqlCeTransaction 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.:
/// SqlCeDataReader dr = ExecuteReader(trans, "GetOrders", 24, 36);
///
/// A valid SqlCeTransaction
/// The name of the stored procedure
/// An array of objects to be assigned as the input values of the stored procedure
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReader(SqlCeTransaction 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))
{
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)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 SqlCeCommand (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 SqlCeConnection
/// 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 SqlCeParameters
return ExecuteScalar(connectionString, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (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 SqlCeParameter("@prodid", 24));
///
/// A valid connection string for a SqlCeConnection
/// 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 SqlCeParameter[] commandParameters)
{
if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString");
// Create & open a SqlCeConnection, and dispose of it after we are done
using (SqlCeConnection connection = new SqlCeConnection(connectionString))
{
connection.Open();
// Call the overload that takes a connection in place of the connection string
return ExecuteScalar(connection, commandType, commandText, commandParameters);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (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 SqlCeConnection
/// 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
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 SqlCeCommand (that returns a 1x1 resultset and takes no parameters) against the provided SqlCeConnection.
///
///
/// e.g.:
/// int orderCount = (int)ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount");
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection connection, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteScalar(connection, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a 1x1 resultset) against the specified SqlCeConnection
/// using the provided parameters.
///
///
/// e.g.:
/// int orderCount = (int)ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection connection, CommandType commandType, string commandText, params SqlCeParameter[] commandParameters)
{
if (connection == null) throw new ArgumentNullException("connection");
// Create a command and prepare it for execution
SqlCeCommand cmd = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(cmd, connection, (SqlCeTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection);
// Execute the command & return the results
object retval = cmd.ExecuteScalar();
// Detach the SqlCeParameters 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 SqlCeCommand (that returns a 1x1 resultset) against the specified SqlCeConnection
/// 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 SqlCeConnection
/// 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(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
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 SqlCeCommand (that returns a 1x1 resultset and takes no parameters) against the provided SqlCeTransaction.
///
///
/// e.g.:
/// int orderCount = (int)ExecuteScalar(trans, CommandType.StoredProcedure, "GetOrderCount");
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction transaction, CommandType commandType, string commandText)
{
// Pass through the call providing null for the set of SqlCeParameters
return ExecuteScalar(transaction, commandType, commandText, (SqlCeParameter[])null);
}
///
/// Execute a SqlCeCommand (that returns a 1x1 resultset) against the specified SqlCeTransaction
/// using the provided parameters.
///
///
/// e.g.:
/// int orderCount = (int)ExecuteScalar(trans, CommandType.StoredProcedure, "GetOrderCount", new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction transaction, CommandType commandType, string commandText, params SqlCeParameter[] 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
SqlCeCommand cmd = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(cmd, (SqlCeConnection)transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection);
// Execute the command & return the results
object retval = cmd.ExecuteScalar();
// Detach the SqlCeParameters from the command object, so they can be used again
cmd.Parameters.Clear();
return retval;
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a 1x1 resultset) against the specified
/// SqlCeTransaction 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 SqlCeTransaction
/// 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(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)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 SqlCeParameters
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 FillDataset
///
/// Execute a SqlCeCommand (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 SqlCeConnection
/// 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 SqlCeConnection, and dispose of it after we are done
using (SqlCeConnection connection = new SqlCeConnection(connectionString))
{
connection.Open();
// Call the overload that takes a connection in place of the connection string
FillDataset(connection, commandType, commandText, dataSet, tableNames);
}
}
///
/// Execute a SqlCeCommand (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 SqlCeParameter("@prodid", 24));
///
/// A valid connection string for a SqlCeConnection
/// 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 SqlCeParameter[] commandParameters)
{
if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString");
if (dataSet == null) throw new ArgumentNullException("dataSet");
// Create & open a SqlCeConnection, and dispose of it after we are done
using (SqlCeConnection connection = new SqlCeConnection(connectionString))
{
connection.Open();
// Call the overload that takes a connection in place of the connection string
FillDataset(connection, commandType, commandText, dataSet, tableNames, commandParameters);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (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.:
/// FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, 24);
///
/// A valid connection string for a SqlCeConnection
/// 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 SqlCeConnection, and dispose of it after we are done
using (SqlCeConnection connection = new SqlCeConnection(connectionString))
{
connection.Open();
// Call the overload that takes a connection in place of the connection string
FillDataset(connection, spName, dataSet, tableNames, parameterValues);
}
}
///
/// Execute a SqlCeCommand (that returns a resultset and takes no parameters) against the provided SqlCeConnection.
///
///
/// e.g.:
/// FillDataset(conn, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"});
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection connection, CommandType commandType,
string commandText, DataSet dataSet, string[] tableNames)
{
FillDataset(connection, commandType, commandText, dataSet, tableNames, null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// using the provided parameters.
///
///
/// e.g.:
/// FillDataset(conn, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection connection, CommandType commandType,
string commandText, DataSet dataSet, string[] tableNames,
params SqlCeParameter[] commandParameters)
{
FillDataset(connection, null, commandType, commandText, dataSet, tableNames, commandParameters);
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// 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.:
/// FillDataset(conn, "GetOrders", ds, new string[] {"orders"}, 24, 36);
///
/// A valid SqlCeConnection
/// 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(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeParameters
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 SqlCeCommand (that returns a resultset and takes no parameters) against the provided SqlCeTransaction.
///
///
/// e.g.:
/// FillDataset(trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"});
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction transaction, CommandType commandType,
string commandText,
DataSet dataSet, string[] tableNames)
{
FillDataset(transaction, commandType, commandText, dataSet, tableNames, null);
}
///
/// Execute a SqlCeCommand (that returns a resultset) against the specified SqlCeTransaction
/// using the provided parameters.
///
///
/// e.g.:
/// FillDataset(trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction transaction, CommandType commandType,
string commandText, DataSet dataSet, string[] tableNames,
params SqlCeParameter[] commandParameters)
{
FillDataset((SqlCeConnection)transaction.Connection, transaction, commandType, commandText, dataSet, tableNames, commandParameters);
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified
/// SqlCeTransaction 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.:
/// FillDataset(trans, "GetOrders", ds, new string[]{"orders"}, 24, 36);
///
/// A valid SqlCeTransaction
/// 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(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)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 SqlCeParameters
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 SqlCeCommand (that returns a resultset) against the specified SqlCeTransaction and SqlCeConnection
/// using the provided parameters.
///
///
/// e.g.:
/// FillDataset(conn, trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new SqlCeParameter("@prodid", 24));
///
/// A valid SqlCeConnection
/// A valid SqlCeTransaction
/// 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(SqlCeConnection connection, SqlCeTransaction transaction, CommandType commandType,
string commandText, DataSet dataSet, string[] tableNames,
params SqlCeParameter[] commandParameters)
{
if (connection == null) throw new ArgumentNullException("connection");
if (dataSet == null) throw new ArgumentNullException("dataSet");
// Create a command and prepare it for execution
SqlCeCommand command = new SqlCeCommand();
bool mustCloseConnection = false;
PrepareCommand(command, connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection);
// Create the DataAdapter & DataSet
using (SqlCeDataAdapter dataAdapter = new SqlCeDataAdapter(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 SqlCeParameters 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(SqlCeCommand insertCommand, SqlCeCommand deleteCommand, SqlCeCommand 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 SqlCeDataAdapter, and dispose of it after we are done
using (SqlCeDataAdapter dataAdapter = new SqlCeDataAdapter())
{
// 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.:
/// SqlCeCommand command = CreateCommand(conn, "AddCustomer", "CustomerID", "CustomerName");
///
/// A valid SqlCeConnection 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 SqlCeCommand object
public static SqlCeCommand CreateCommand(SqlCeConnection 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 SqlCeCommand
SqlCeCommand cmd = new SqlCeCommand(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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.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 SqlCeCommand object
AttachParameters(cmd, commandParameters);
}
return cmd;
}
#endregion
#region ExecuteNonQueryTypedParams
///
/// Execute a stored procedure via a SqlCeCommand (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 SqlCeConnection
/// 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet(connectionString, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns no resultset) against the specified SqlCeConnection
/// 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 SqlCeConnection 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(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet(connection, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteNonQuery(connection, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteNonQuery(connection, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns no resultset) against the specified
/// SqlCeTransaction 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 SqlCeTransaction 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(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)transaction.Connection, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName);
}
}
#endregion
#region ExecuteDatasetTypedParams
///
/// Execute a stored procedure via a SqlCeCommand (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 SqlCeConnection
/// 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet(connectionString, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteDataset(connectionString, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteDataset(connectionString, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// 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 SqlCeConnection 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(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet(connection, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteDataset(connection, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteDataset(connection, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified SqlCeTransaction
/// 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 SqlCeTransaction 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(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)transaction.Connection, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteDataset(transaction, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteDataset(transaction, CommandType.StoredProcedure, spName);
}
}
#endregion
#region ExecuteReaderTypedParams
///
/// Execute a stored procedure via a SqlCeCommand (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 parameter order.
///
/// A valid connection string for a SqlCeConnection
/// The name of the stored procedure
/// The dataRow used to hold the stored procedure's parameter values.
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet(connectionString, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteReader(connectionString, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteReader(connectionString, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified SqlCeConnection
/// 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 SqlCeConnection object
/// The name of the stored procedure
/// The dataRow used to hold the stored procedure's parameter values.
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReaderTypedParams(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet(connection, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteReader(connection, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteReader(connection, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a resultset) against the specified SqlCeTransaction
/// 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 SqlCeTransaction object
/// The name of the stored procedure
/// The dataRow used to hold the stored procedure's parameter values.
/// A SqlCeDataReader containing the resultset generated by the command
public static SqlCeDataReader ExecuteReaderTypedParams(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)transaction.Connection, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteReader(transaction, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteReader(transaction, CommandType.StoredProcedure, spName);
}
}
#endregion
#region ExecuteScalarTypedParams
///
/// Execute a stored procedure via a SqlCeCommand (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 SqlCeConnection
/// 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet(connectionString, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteScalar(connectionString, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteScalar(connectionString, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a 1x1 resultset) against the specified SqlCeConnection
/// 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 SqlCeConnection 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(SqlCeConnection 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet(connection, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteScalar(connection, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteScalar(connection, CommandType.StoredProcedure, spName);
}
}
///
/// Execute a stored procedure via a SqlCeCommand (that returns a 1x1 resultset) against the specified SqlCeTransaction
/// 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 SqlCeTransaction 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(SqlCeTransaction 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)
SqlCeParameter[] commandParameters = SqlCeHelperParameterCache.GetSpParameterSet((SqlCeConnection)transaction.Connection, spName);
// Set the parameters values
AssignParameterValues(commandParameters, dataRow);
return SqlCeHelper.ExecuteScalar(transaction, CommandType.StoredProcedure, spName, commandParameters);
}
else
{
return SqlCeHelper.ExecuteScalar(transaction, CommandType.StoredProcedure, spName);
}
}
#endregion
}
///
/// SqlCeHelperParameterCache 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 SqlCeHelperParameterCache
{
#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 SqlCeHelperParameterCache()"
private SqlCeHelperParameterCache() { }
private static Hashtable paramCache = Hashtable.Synchronized(new Hashtable());
///
/// Resolve at run time the appropriate set of SqlCeParameters for a stored procedure
///
/// A valid SqlCeConnection object
/// The name of the stored procedure
/// Whether or not to include their return value parameter
/// The parameter array discovered.
private static SqlCeParameter[] DiscoverSpParameterSet(SqlCeConnection connection, string spName, bool includeReturnValueParameter)
{
if (connection == null) throw new ArgumentNullException("connection");
if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName");
SqlCeCommand cmd = new SqlCeCommand(spName, connection);
cmd.CommandType = CommandType.StoredProcedure;
connection.Open();
//SqlCeCommandBuilder.DeriveParameters(cmd);
connection.Close();
if (!includeReturnValueParameter)
{
cmd.Parameters.RemoveAt(0);
}
SqlCeParameter[] discoveredParameters = new SqlCeParameter[cmd.Parameters.Count];
cmd.Parameters.CopyTo(discoveredParameters, 0);
// Init the parameters with a DBNull value
foreach (SqlCeParameter discoveredParameter in discoveredParameters)
{
discoveredParameter.Value = DBNull.Value;
}
return discoveredParameters;
}
///
/// Deep copy of cached SqlCeParameter array
///
///
///
private static SqlCeParameter[] CloneParameters(SqlCeParameter[] originalParameters)
{
SqlCeParameter[] clonedParameters = new SqlCeParameter[originalParameters.Length];
for (int i = 0, j = originalParameters.Length; i < j; i++)
{
clonedParameters[i] = (SqlCeParameter)((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 SqlCeConnection
/// The stored procedure name or T-SQL command
/// An array of SqlParamters to be cached
public static void CacheParameterSet(string connectionString, string commandText, params SqlCeParameter[] 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 SqlCeConnection
/// The stored procedure name or T-SQL command
/// An array of SqlParamters
public static SqlCeParameter[] 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;
SqlCeParameter[] cachedParameters = paramCache[hashKey] as SqlCeParameter[];
if (cachedParameters == null)
{
return null;
}
else
{
return CloneParameters(cachedParameters);
}
}
#endregion caching functions
#region Parameter Discovery Functions
///
/// Retrieves the set of SqlCeParameters appropriate for the stored procedure
///
///
/// This method will query the database for this information, and then store it in a cache for future requests.
///
/// A valid connection string for a SqlCeConnection
/// The name of the stored procedure
/// An array of SqlCeParameters
public static SqlCeParameter[] GetSpParameterSet(string connectionString, string spName)
{
return GetSpParameterSet(connectionString, spName, false);
}
///
/// Retrieves the set of SqlCeParameters appropriate for the stored procedure
///
///
/// This method will query the database for this information, and then store it in a cache for future requests.
///
/// A valid connection string for a SqlCeConnection
/// The name of the stored procedure
/// A bool value indicating whether the return value parameter should be included in the results
/// An array of SqlCeParameters
public static SqlCeParameter[] GetSpParameterSet(string connectionString, string spName, bool includeReturnValueParameter)
{
if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString");
if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName");
using (SqlCeConnection connection = new SqlCeConnection(connectionString))
{
return GetSpParameterSetInternal(connection, spName, includeReturnValueParameter);
}
}
///
/// Retrieves the set of SqlCeParameters appropriate for the stored procedure
///
///
/// This method will query the database for this information, and then store it in a cache for future requests.
///
/// A valid SqlCeConnection object
/// The name of the stored procedure
/// An array of SqlCeParameters
internal static SqlCeParameter[] GetSpParameterSet(SqlCeConnection connection, string spName)
{
return GetSpParameterSet(connection, spName, false);
}
///
/// Retrieves the set of SqlCeParameters appropriate for the stored procedure
///
///
/// This method will query the database for this information, and then store it in a cache for future requests.
///
/// A valid SqlCeConnection object
/// The name of the stored procedure
/// A bool value indicating whether the return value parameter should be included in the results
/// An array of SqlCeParameters
internal static SqlCeParameter[] GetSpParameterSet(SqlCeConnection connection, string spName, bool includeReturnValueParameter)
{
if (connection == null) throw new ArgumentNullException("connection");
using (SqlCeConnection clonedConnection = connection)
{
return GetSpParameterSetInternal(clonedConnection, spName, includeReturnValueParameter);
}
}
///
/// Retrieves the set of SqlCeParameters appropriate for the stored procedure
///
/// A valid SqlCeConnection object
/// The name of the stored procedure
/// A bool value indicating whether the return value parameter should be included in the results
/// An array of SqlCeParameters
private static SqlCeParameter[] GetSpParameterSetInternal(SqlCeConnection connection, string spName, bool includeReturnValueParameter)
{
if (connection == null) throw new ArgumentNullException("connection");
if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName");
string hashKey = connection.ConnectionString + ":" + spName + (includeReturnValueParameter ? ":include ReturnValue Parameter" : "");
SqlCeParameter[] cachedParameters;
cachedParameters = paramCache[hashKey] as SqlCeParameter[];
if (cachedParameters == null)
{
SqlCeParameter[] spParameters = DiscoverSpParameterSet(connection, spName, includeReturnValueParameter);
paramCache[hashKey] = spParameters;
cachedParameters = spParameters;
}
return CloneParameters(cachedParameters);
}
#endregion Parameter Discovery Functions
}
}