Microsoft.Practices.EnterpriseLibrary.Data.SprocAccessor< TResult > Class Template Reference

Represents a stored procedure call to the database that will return an enumerable of TResult . More...

Inheritance diagram for Microsoft.Practices.EnterpriseLibrary.Data.SprocAccessor< TResult >:

Public Member Functions
	SprocAccessor (Database database, string procedureName, IRowMapper< TResult > rowMapper)
	Creates a new instance of SprocAccessor<TResult> that works for a specific database and uses rowMapper to convert the returned rows to clr type TResult . More...
	SprocAccessor (Database database, string procedureName, IResultSetMapper< TResult > resultSetMapper)
	Creates a new instance of SprocAccessor<TResult> that works for a specific database and uses resultSetMapper to convert the returned set to an enumerable of clr type TResult . More...
	SprocAccessor (Database database, string procedureName, IParameterMapper parameterMapper, IRowMapper< TResult > rowMapper)
	Creates a new instance of SprocAccessor<TResult> that works for a specific database and uses rowMapper to convert the returned rows to clr type TResult . The parameterMapper will be used to interpret the parameters passed to the Execute method. More...
	SprocAccessor (Database database, string procedureName, IParameterMapper parameterMapper, IResultSetMapper< TResult > resultSetMapper)
	Creates a new instance of SprocAccessor<TResult> that works for a specific database and uses resultSetMapper to convert the returned set to an enumerable of clr type TResult . The parameterMapper will be used to interpret the parameters passed to the Execute method. More...
override IEnumerable< TResult >	Execute (params object[] parameterValues)
	Executes the stored procedure and returns an enumerable of TResult . The enumerable returned by this method uses deferred loading to return the results. More...
override IAsyncResult	BeginExecute (AsyncCallback callback, object state, params object[] parameterValues)
	Begin executing the database object asynchronously, returning a IAsyncResult object that can be used to retrieve the result set after the operation completes. More...
override IEnumerable< TResult >	EndExecute (IAsyncResult asyncResult)
	Complete an operation started by DataAccessor<TResult>.BeginExecute. More...

Protected Member Functions
IEnumerable< TResult >	Execute (DbCommand command)
	Executes the command and returns an enumerable of TResult . The enumerable returned by this method uses deferred loading to return the results. More...
IAsyncResult	BeginExecute (DbCommand command, IParameterMapper parameterMapper, AsyncCallback callback, object state, object[] parameterValues)
	Helper method to kick off execution of an asynchronous database operation. This method handles the boilerplate of setting up the parameters and invoking the operation on the database with the right options. More...
void	GuardAsyncAllowed ()
	Checks if the current Database object supports asynchronous operations, and throws InvalidOperationException if not. More...

Properties
Database	Database [get]
	The database object this accessor is wrapped around. More...

Detailed Description

Represents a stored procedure call to the database that will return an enumerable of TResult .

Template Parameters

TResult

The element type that will be used to consume the result set.

Constructor & Destructor Documentation

SprocAccessor() [1/4]

Microsoft.Practices.EnterpriseLibrary.Data.SprocAccessor< TResult >.SprocAccessor	(	Database	database,
		string	procedureName,
		IRowMapper< TResult >	rowMapper
	)

Creates a new instance of SprocAccessor<TResult> that works for a specific database and uses rowMapper to convert the returned rows to clr type TResult .

Parameters

database	The Database used to execute the Transact-SQL.
procedureName	The stored procedure that will be executed.
rowMapper	The IRowMapper<TResult> that will be used to convert the returned data to clr type TResult .

SprocAccessor() [2/4]

Microsoft.Practices.EnterpriseLibrary.Data.SprocAccessor< TResult >.SprocAccessor	(	Database	database,
		string	procedureName,
		IResultSetMapper< TResult >	resultSetMapper
	)

Creates a new instance of SprocAccessor<TResult> that works for a specific database and uses resultSetMapper to convert the returned set to an enumerable of clr type TResult .

Parameters

database	The Database used to execute the Transact-SQL.
procedureName	The stored procedure that will be executed.
resultSetMapper	The IResultSetMapper<TResult> that will be used to convert the returned set to an enumerable of clr type TResult .

SprocAccessor() [3/4]

Microsoft.Practices.EnterpriseLibrary.Data.SprocAccessor< TResult >.SprocAccessor	(	Database	database,
		string	procedureName,
		IParameterMapper	parameterMapper,
		IRowMapper< TResult >	rowMapper
	)

Creates a new instance of SprocAccessor<TResult> that works for a specific database and uses rowMapper to convert the returned rows to clr type TResult . The parameterMapper will be used to interpret the parameters passed to the Execute method.

Parameters

database	The Database used to execute the Transact-SQL.
procedureName	The stored procedure that will be executed.
parameterMapper	The IParameterMapper that will be used to interpret the parameters passed to the Execute method.
rowMapper	The IRowMapper<TResult> that will be used to convert the returned data to CLR type TResult .

Exceptions

ArgumentException	procedureName is null or empty.
ArgumentNullException	parameterMapper is null.

SprocAccessor() [4/4]

Microsoft.Practices.EnterpriseLibrary.Data.SprocAccessor< TResult >.SprocAccessor	(	Database	database,
		string	procedureName,
		IParameterMapper	parameterMapper,
		IResultSetMapper< TResult >	resultSetMapper
	)

Creates a new instance of SprocAccessor<TResult> that works for a specific database and uses resultSetMapper to convert the returned set to an enumerable of clr type TResult . The parameterMapper will be used to interpret the parameters passed to the Execute method.

Parameters

database	The Database used to execute the Transact-SQL.
procedureName	The stored procedure that will be executed.
parameterMapper	The IParameterMapper that will be used to interpret the parameters passed to the Execute method.
resultSetMapper	The IResultSetMapper<TResult> that will be used to convert the returned set to an enumerable of clr type TResult .

Exceptions

ArgumentException	procedureName is null or empty.
ArgumentNullException	parameterMapper is null.

Member Function Documentation

BeginExecute() [1/2]

override IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.SprocAccessor< TResult >.BeginExecute ( AsyncCallback  callback, object  state, params object[]  parameterValues  )

virtual

Begin executing the database object asynchronously, returning a IAsyncResult object that can be used to retrieve the result set after the operation completes.

Parameters

callback	Callback to execute when the operation's results are available. May be null if you don't wish to use a callback.
state	Extra information that will be passed to the callback. May be null.
parameterValues	Parameters to pass to the database.

This operation will throw if the underlying Database object does not support asynchronous operation.

Exceptions

InvalidOperationException

The underlying database does not support asynchronous operation.

Returns

The IAsyncResult representing this operation.

Implements Microsoft.Practices.EnterpriseLibrary.Data.DataAccessor< TResult >.

BeginExecute() [2/2]

IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.CommandAccessor< TResult >.BeginExecute ( DbCommand  command, IParameterMapper  parameterMapper, AsyncCallback  callback, object  state, object[]  parameterValues  )

protectedinherited

Helper method to kick off execution of an asynchronous database operation. This method handles the boilerplate of setting up the parameters and invoking the operation on the database with the right options.

Parameters

command	The DbCommand to execute.
parameterMapper	The IParameterMapper to use to set the parameter values.
callback	Callback to execute when the operation's result is available.
state	State to pass to the callback.
parameterValues	Input parameter values.

Returns

An IAsyncResult object representing the outstanding async request.

EndExecute()

override IEnumerable<TResult> Microsoft.Practices.EnterpriseLibrary.Data.CommandAccessor< TResult >.EndExecute ( IAsyncResult  asyncResult )

virtualinherited

Complete an operation started by DataAccessor<TResult>.BeginExecute.

Returns

The result sequence.

Implements Microsoft.Practices.EnterpriseLibrary.Data.DataAccessor< TResult >.

Execute() [1/2]

IEnumerable<TResult> Microsoft.Practices.EnterpriseLibrary.Data.CommandAccessor< TResult >.Execute ( DbCommand  command )

protectedinherited

Executes the command and returns an enumerable of TResult . The enumerable returned by this method uses deferred loading to return the results.

Parameters

command

The command that will be executed.

Returns

An enumerable of TResult .

Execute() [2/2]

override IEnumerable<TResult> Microsoft.Practices.EnterpriseLibrary.Data.SprocAccessor< TResult >.Execute ( params object[]  parameterValues )

virtual

Executes the stored procedure and returns an enumerable of TResult . The enumerable returned by this method uses deferred loading to return the results.

Parameters

parameterValues

Values that will be interpret by an IParameterMapper and function as parameters to the stored procedure.

Returns

An enumerable of TResult .

Implements Microsoft.Practices.EnterpriseLibrary.Data.DataAccessor< TResult >.

GuardAsyncAllowed()

void Microsoft.Practices.EnterpriseLibrary.Data.CommandAccessor< TResult >.GuardAsyncAllowed ( )

protectedinherited

Checks if the current Database object supports asynchronous operations, and throws InvalidOperationException if not.

Exceptions

InvalidOperationException

The database does not support asynchronous operations.

Property Documentation

Database

Database Microsoft.Practices.EnterpriseLibrary.Data.CommandAccessor< TResult >.Database

getprotectedinherited

The database object this accessor is wrapped around.

---

The documentation for this class was generated from the following file:

• SprocAccessor.cs