Microsoft.ApplicationBlocks.Data

The SqlHelper class is intended to encapsulate high performance, scalable best practices for common uses of SqlClient.

This method is used to attach array of SqlParameters to a SqlCommand. 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 SqlParameters tho be added to command

This method assigns an array of values to an array of SqlParameters.

array of SqlParameters to be assigned values array of objects holding the values to be assigned

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

the SqlCommand to be prepared a valid SqlConnection, on which to execute this command a valid SqlTransaction, or 'null' the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command an array of SqlParameters to be associated with the command or 'null' if no parameters are required

Execute a SqlCommand (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 SqlConnection 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

Execute a SqlCommand (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 SqlParameter("@prodid", 24)); a valid connection string for a SqlConnection 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

Execute a stored procedure via a SqlCommand (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 SqlConnection 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

Execute a SqlCommand (that returns no resultset and takes no parameters) against the provided SqlConnection.

e.g.: int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders"); a valid SqlConnection 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

Execute a SqlCommand (that returns no resultset) against the specified SqlConnection using the provided parameters.

e.g.: int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24)); a valid SqlConnection 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

Execute a stored procedure via a SqlCommand (that returns no resultset) against the specified SqlConnection 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 SqlConnection 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

Execute a SqlCommand (that returns no resultset and takes no parameters) against the provided SqlTransaction.

e.g.: int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders"); a valid SqlTransaction 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

Execute a SqlCommand (that returns no resultset) against the specified SqlTransaction using the provided parameters.

e.g.: int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); a valid SqlTransaction 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

Execute a stored procedure via a SqlCommand (that returns no resultset) against the specified SqlTransaction 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 SqlTransaction 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

Execute a SqlCommand (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 SqlConnection the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command a dataset containing the resultset generated by the command

Execute a SqlCommand (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 SqlParameter("@prodid", 24)); a valid connection string for a SqlConnection 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

Execute a stored procedure via a SqlCommand (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 SqlConnection 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

Execute a SqlCommand (that returns a resultset and takes no parameters) against the provided SqlConnection.

e.g.: DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders"); a valid SqlConnection the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command a dataset containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset) against the specified SqlConnection using the provided parameters.

e.g.: DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); a valid SqlConnection 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

Execute a stored procedure via a SqlCommand (that returns a resultset) against the specified SqlConnection 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 SqlConnection 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

Execute a SqlCommand (that returns a resultset and takes no parameters) against the provided SqlTransaction.

e.g.: DataSet ds = ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders"); a valid SqlTransaction the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command a dataset containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset) against the specified SqlTransaction using the provided parameters.

e.g.: DataSet ds = ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); a valid SqlTransaction 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

Execute a stored procedure via a SqlCommand (that returns a resultset) against the specified SqlTransaction 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 SqlTransaction 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

Create and prepare a SqlCommand, 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 SqlConnection, on which to execute this command a valid SqlTransaction, or 'null' the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command an array of SqlParameters to be associated with the command or 'null' if no parameters are required indicates whether the connection parameter was provided by the caller, or created by SqlHelper SqlDataReader containing the results of the command

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

e.g.: SqlDataReader dr = ExecuteReader(connString, CommandType.StoredProcedure, "GetOrders"); a valid connection string for a SqlConnection the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command a SqlDataReader containing the resultset generated by the command

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

e.g.: SqlDataReader dr = ExecuteReader(connString, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); a valid connection string for a SqlConnection the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command an array of SqlParamters used to execute the command a SqlDataReader containing the resultset generated by the command

This method provides no access to output parameters or the stored procedure's return value parameter. e.g.: SqlDataReader dr = ExecuteReader(connString, "GetOrders", 24, 36); a valid connection string for a SqlConnection the name of the stored procedure an array of objects to be assigned as the input values of the stored procedure a SqlDataReader containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset and takes no parameters) against the provided SqlConnection.

e.g.: SqlDataReader dr = ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders"); a valid SqlConnection the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command a SqlDataReader containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset) against the specified SqlConnection using the provided parameters.

e.g.: SqlDataReader dr = ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); a valid SqlConnection the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command an array of SqlParamters used to execute the command a SqlDataReader containing the resultset generated by the command

This method provides no access to output parameters or the stored procedure's return value parameter. e.g.: SqlDataReader dr = ExecuteReader(conn, "GetOrders", 24, 36); a valid SqlConnection the name of the stored procedure an array of objects to be assigned as the input values of the stored procedure a SqlDataReader containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset and takes no parameters) against the provided SqlTransaction.

e.g.: SqlDataReader dr = ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders"); a valid SqlTransaction the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command a SqlDataReader containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset) against the specified SqlTransaction using the provided parameters.

e.g.: SqlDataReader dr = ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); a valid SqlTransaction the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command an array of SqlParamters used to execute the command a SqlDataReader containing the resultset generated by the command

This method provides no access to output parameters or the stored procedure's return value parameter. e.g.: SqlDataReader dr = ExecuteReader(trans, "GetOrders", 24, 36); a valid SqlTransaction the name of the stored procedure an array of objects to be assigned as the input values of the stored procedure a SqlDataReader containing the resultset generated by the command

Execute a SqlCommand (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 SqlConnection 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

Execute a SqlCommand (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 SqlParameter("@prodid", 24)); a valid connection string for a SqlConnection 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

Execute a stored procedure via a SqlCommand (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 SqlConnection 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

Execute a SqlCommand (that returns a 1x1 resultset and takes no parameters) against the provided SqlConnection.

e.g.: int orderCount = (int)ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount"); a valid SqlConnection 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

Execute a SqlCommand (that returns a 1x1 resultset) against the specified SqlConnection using the provided parameters.

e.g.: int orderCount = (int)ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount", new SqlParameter("@prodid", 24)); a valid SqlConnection 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

Execute a stored procedure via a SqlCommand (that returns a 1x1 resultset) against the specified SqlConnection 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 SqlConnection 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

Execute a SqlCommand (that returns a 1x1 resultset and takes no parameters) against the provided SqlTransaction.

e.g.: int orderCount = (int)ExecuteScalar(trans, CommandType.StoredProcedure, "GetOrderCount"); a valid SqlTransaction 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

Execute a SqlCommand (that returns a 1x1 resultset) against the specified SqlTransaction using the provided parameters.

e.g.: int orderCount = (int)ExecuteScalar(trans, CommandType.StoredProcedure, "GetOrderCount", new SqlParameter("@prodid", 24)); a valid SqlTransaction 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

Execute a stored procedure via a SqlCommand (that returns a 1x1 resultset) against the specified SqlTransaction 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 SqlTransaction 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

Execute a SqlCommand (that returns a resultset and takes no parameters) against the provided SqlConnection.

e.g.: XmlReader r = ExecuteXmlReader(conn, CommandType.StoredProcedure, "GetOrders"); a valid SqlConnection the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command using "FOR XML AUTO" an XmlReader containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset) against the specified SqlConnection using the provided parameters.

e.g.: XmlReader r = ExecuteXmlReader(conn, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); a valid SqlConnection the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command using "FOR XML AUTO" an array of SqlParamters used to execute the command an XmlReader containing the resultset generated by the command

This method provides no access to output parameters or the stored procedure's return value parameter. e.g.: XmlReader r = ExecuteXmlReader(conn, "GetOrders", 24, 36); a valid SqlConnection the name of the stored procedure using "FOR XML AUTO" an array of objects to be assigned as the input values of the stored procedure an XmlReader containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset and takes no parameters) against the provided SqlTransaction.

e.g.: XmlReader r = ExecuteXmlReader(trans, CommandType.StoredProcedure, "GetOrders"); a valid SqlTransaction the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command using "FOR XML AUTO" an XmlReader containing the resultset generated by the command

Execute a SqlCommand (that returns a resultset) against the specified SqlTransaction using the provided parameters.

e.g.: XmlReader r = ExecuteXmlReader(trans, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); a valid SqlTransaction the CommandType (stored procedure, text, etc.) the stored procedure name or T-SQL command using "FOR XML AUTO" an array of SqlParamters used to execute the command an XmlReader containing the resultset generated by the command

This method provides no access to output parameters or the stored procedure's return value parameter. e.g.: XmlReader r = ExecuteXmlReader(trans, "GetOrders", 24, 36); a valid SqlTransaction 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

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

Connection is owned and managed by SqlHelper

Connection is owned and managed by the caller

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

resolve at run time the appropriate set of SqlParameters for a stored procedure

a valid connection string for a SqlConnection the name of the stored procedure whether or not to include their return value parameter

add parameter array to the cache

a valid connection string for a SqlConnection the stored procedure name or T-SQL command an array of SqlParamters to be cached

retrieve a parameter array from the cache

a valid connection string for a SqlConnection the stored procedure name or T-SQL command an array of SqlParamters

Retrieves the set of SqlParameters 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 SqlConnection the name of the stored procedure a bool value indicating whether the return value parameter should be included in the results an array of SqlParameters