Microsoft.Practices.EnterpriseLibrary.Data.Database Class Reference

Represents an abstract database that commands can be run against. More...

Inheritance diagram for Microsoft.Practices.EnterpriseLibrary.Data.Database:

Classes
class	OldConnectionWrapper
	This is a helper class that is used to manage the lifetime of a connection for various Execute methods. We needed this class to support implicit transactions created with the TransactionScope class. In this case, the various Execute methods need to use a shared connection instead of a new connection for each request in order to prevent a distributed transaction. More...

Public Member Functions
void	AddInParameter (DbCommand command, string name, DbType dbType)
	Adds a new In DbParameter object to the given command . More...
void	AddInParameter (DbCommand command, string name, DbType dbType, object value)
	Adds a new In DbParameter object to the given command . More...
void	AddInParameter (DbCommand command, string name, DbType dbType, string sourceColumn, DataRowVersion sourceVersion)
	Adds a new In DbParameter object to the given command . More...
void	AddOutParameter (DbCommand command, string name, DbType dbType, int size)
	Adds a new Out DbParameter object to the given command . More...
void	AddInOutParameter (DbCommand command, string name, DbType dbType, object value)
	Adds new In/Out DbParameter object to given command More...
void	AddInOutParameter (DbCommand command, string name, DbType dbType, int size, object value)
	Adds new In/Out DbParameter object to given command More...
virtual void	AddParameter (DbCommand command, string name, DbType dbType, int size, ParameterDirection direction, bool nullable, byte precision, byte scale, string sourceColumn, DataRowVersion sourceVersion, object value)
	Adds a new In DbParameter object to the given command . More...
void	AddParameter (DbCommand command, string name, DbType dbType, ParameterDirection direction, string sourceColumn, DataRowVersion sourceVersion, object value)
	Adds a new instance of a DbParameter object to the command. More...
virtual string	BuildParameterName (string name)
	Builds a value parameter name for the current database. More...
virtual DbConnection	CreateConnection ()
	Creates a connection for this database. More...
void	DiscoverParameters (DbCommand command)
	Discovers the parameters for a DbCommand. More...
virtual DataSet	ExecuteDataSet (DbCommand command)
	Executes the command and returns the results in a new DataSet. More...
virtual DataSet	ExecuteDataSet (DbCommand command, DbTransaction transaction)
	Executes the command as part of the transaction and returns the results in a new DataSet. More...
virtual DataSet	ExecuteDataSet (string storedProcedureName, params object[] parameterValues)
	Executes the storedProcedureName with parameterValues and returns the results in a new DataSet. More...
virtual DataSet	ExecuteDataSet (DbTransaction transaction, string storedProcedureName, params object[] parameterValues)
	Executes the storedProcedureName with parameterValues as part of the transaction and returns the results in a new DataSet within a transaction. More...
virtual DataSet	ExecuteDataSet (CommandType commandType, string commandText)
	Executes the commandText interpreted as specified by the commandType and returns the results in a new DataSet. More...
virtual DataSet	ExecuteDataSet (DbTransaction transaction, CommandType commandType, string commandText)
	Executes the commandText as part of the given transaction and returns the results in a new DataSet. More...
virtual int	ExecuteNonQuery (DbCommand command)
	Executes the command and returns the number of rows affected. More...
virtual int	ExecuteNonQuery (DbCommand command, DbTransaction transaction)
	Executes the command within the given transaction , and returns the number of rows affected. More...
virtual int	ExecuteNonQuery (string storedProcedureName, params object[] parameterValues)
	Executes the storedProcedureName using the given parameterValues and returns the number of rows affected. More...
virtual int	ExecuteNonQuery (DbTransaction transaction, string storedProcedureName, params object[] parameterValues)
	Executes the storedProcedureName using the given parameterValues within a transaction and returns the number of rows affected. More...
virtual int	ExecuteNonQuery (CommandType commandType, string commandText)
	Executes the commandText interpreted as specified by the commandType and returns the number of rows affected. More...
virtual int	ExecuteNonQuery (DbTransaction transaction, CommandType commandType, string commandText)
	Executes the commandText interpreted as specified by the commandType as part of the given transaction and returns the number of rows affected. More...
virtual IDataReader	ExecuteReader (DbCommand command)
	Executes the command and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the reader when finished. More...
virtual IDataReader	ExecuteReader (DbCommand command, DbTransaction transaction)
	Executes the command within a transaction and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished. More...
IDataReader	ExecuteReader (string storedProcedureName, params object[] parameterValues)
	Executes the storedProcedureName with the given parameterValues and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished. More...
IDataReader	ExecuteReader (DbTransaction transaction, string storedProcedureName, params object[] parameterValues)
	Executes the storedProcedureName with the given parameterValues within the given transaction and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished. More...
IDataReader	ExecuteReader (CommandType commandType, string commandText)
	Executes the commandText interpreted as specified by the commandType and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished. More...
IDataReader	ExecuteReader (DbTransaction transaction, CommandType commandType, string commandText)
	Executes the commandText interpreted as specified by commandType within the given transaction and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished. More...
virtual object	ExecuteScalar (DbCommand command)
	Executes the command and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored. More...
virtual object	ExecuteScalar (DbCommand command, DbTransaction transaction)
	Executes the command within a transaction , and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored. More...
virtual object	ExecuteScalar (string storedProcedureName, params object[] parameterValues)
	Executes the storedProcedureName with the given parameterValues and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored. More...
virtual object	ExecuteScalar (DbTransaction transaction, string storedProcedureName, params object[] parameterValues)
	Executes the storedProcedureName with the given parameterValues within a transaction and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored. More...
virtual object	ExecuteScalar (CommandType commandType, string commandText)
	Executes the commandText interpreted as specified by the commandType and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored. More...
virtual object	ExecuteScalar (DbTransaction transaction, CommandType commandType, string commandText)
	Executes the commandText interpreted as specified by the commandType within the given transaction and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored. More...
DbDataAdapter	GetDataAdapter ()
	Gets a DbDataAdapter with Standard update behavior. More...
virtual object	GetParameterValue (DbCommand command, string name)
	Gets a parameter value. More...
DbCommand	GetSqlStringCommand (string query)
	Creates a DbCommand for a SQL query. More...
virtual DbCommand	GetStoredProcCommand (string storedProcedureName)
	Creates a DbCommand for a stored procedure. More...
virtual DbCommand	GetStoredProcCommand (string storedProcedureName, params object[] parameterValues)
	Creates a DbCommand for a stored procedure. More...
virtual void	AssignParameters (DbCommand command, object[] parameterValues)
	Discovers parameters on the command and assigns the values from parameterValues to the command s Parameters list. More...
DbCommand	GetStoredProcCommandWithSourceColumns (string storedProcedureName, params string[] sourceColumns)
	Wraps around a derived class's implementation of the GetStoredProcCommandWrapper method and adds functionality for using this method with UpdateDataSet. The GetStoredProcCommandWrapper method (above) that takes a params array expects the array to be filled with VALUES for the parameters. This method differs from the GetStoredProcCommandWrapper method in that it allows a user to pass in a string array. It will also dynamically discover the parameters for the stored procedure and set the parameter's SourceColumns to the strings that are passed in. It does this by mapping the parameters to the strings IN ORDER. Thus, order is very important. More...
virtual void	LoadDataSet (DbCommand command, DataSet dataSet, string tableName)
	Executes the command and adds a new DataTable to the existing DataSet. More...
virtual void	LoadDataSet (DbCommand command, DataSet dataSet, string tableName, DbTransaction transaction)
	Executes the command within the given transaction and adds a new DataTable to the existing DataSet. More...
virtual void	LoadDataSet (DbCommand command, DataSet dataSet, string[] tableNames)
	Loads a DataSet from a DbCommand. More...
virtual void	LoadDataSet (DbCommand command, DataSet dataSet, string[] tableNames, DbTransaction transaction)
	Loads a DataSet from a DbCommand in a transaction. More...
virtual void	LoadDataSet (string storedProcedureName, DataSet dataSet, string[] tableNames, params object[] parameterValues)
	Loads a DataSet with the results returned from a stored procedure. More...
virtual void	LoadDataSet (DbTransaction transaction, string storedProcedureName, DataSet dataSet, string[] tableNames, params object[] parameterValues)
	Loads a DataSet with the results returned from a stored procedure executed in a transaction. More...
virtual void	LoadDataSet (CommandType commandType, string commandText, DataSet dataSet, string[] tableNames)
	Loads a DataSet from command text. More...
void	LoadDataSet (DbTransaction transaction, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames)
	Loads a DataSet from command text in a transaction. More...
virtual void	SetParameterValue (DbCommand command, string parameterName, object value)
	Sets a parameter value. More...
int	UpdateDataSet (DataSet dataSet, string tableName, DbCommand insertCommand, DbCommand updateCommand, DbCommand deleteCommand, UpdateBehavior updateBehavior, int? updateBatchSize)
	Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet. More...
int	UpdateDataSet (DataSet dataSet, string tableName, DbCommand insertCommand, DbCommand updateCommand, DbCommand deleteCommand, UpdateBehavior updateBehavior)
	Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet. More...
int	UpdateDataSet (DataSet dataSet, string tableName, DbCommand insertCommand, DbCommand updateCommand, DbCommand deleteCommand, DbTransaction transaction, int? updateBatchSize)
	Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet within a transaction. More...
int	UpdateDataSet (DataSet dataSet, string tableName, DbCommand insertCommand, DbCommand updateCommand, DbCommand deleteCommand, DbTransaction transaction)
	Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet within a transaction. More...
virtual IAsyncResult	BeginExecuteNonQuery (DbCommand command, AsyncCallback callback, object state)
	Initiates the asynchronous execution of the DbCommand which will return the number of affected records. More...
virtual IAsyncResult	BeginExecuteNonQuery (DbCommand command, DbTransaction transaction, AsyncCallback callback, object state)
	Initiates the asynchronous execution of the DbCommand inside a transaction which will return the number of affected records. More...
virtual IAsyncResult	BeginExecuteNonQuery (string storedProcedureName, AsyncCallback callback, object state, params object[] parameterValues)
	Initiates the asynchronous execution of the storedProcedureName using the given parameterValues which will return the number of rows affected. More...
virtual IAsyncResult	BeginExecuteNonQuery (DbTransaction transaction, string storedProcedureName, AsyncCallback callback, object state, params object[] parameterValues)
	Initiates the asynchronous execution of the storedProcedureName using the given parameterValues inside a transaction which will return the number of rows affected. More...
virtual IAsyncResult	BeginExecuteNonQuery (CommandType commandType, string commandText, AsyncCallback callback, object state)
	Initiates the asynchronous execution of the commandText interpreted as specified by the commandType which will return the number of rows affected. More...
virtual IAsyncResult	BeginExecuteNonQuery (DbTransaction transaction, CommandType commandType, string commandText, AsyncCallback callback, object state)
	Initiates the asynchronous execution of the commandText interpreted as specified by the commandType inside a transaction which will return the number of rows affected. More...
virtual int	EndExecuteNonQuery (IAsyncResult asyncResult)
	Finishes asynchronous execution of a SQL statement, returning the number of affected records. More...
virtual IAsyncResult	BeginExecuteReader (DbCommand command, AsyncCallback callback, object state)
	Initiates the asynchronous execution of a command which will return a IDataReader. More...
virtual IAsyncResult	BeginExecuteReader (DbCommand command, DbTransaction transaction, AsyncCallback callback, object state)
	Initiates the asynchronous execution of a command inside a transaction which will return a IDataReader. More...
virtual IAsyncResult	BeginExecuteReader (string storedProcedureName, AsyncCallback callback, object state, params object[] parameterValues)
	Initiates the asynchronous execution of storedProcedureName using the given parameterValues which will return a IDataReader. More...
virtual IAsyncResult	BeginExecuteReader (DbTransaction transaction, string storedProcedureName, AsyncCallback callback, object state, params object[] parameterValues)
	Initiates the asynchronous execution of storedProcedureName using the given parameterValues inside a transaction which will return a IDataReader. More...
virtual IAsyncResult	BeginExecuteReader (CommandType commandType, string commandText, AsyncCallback callback, object state)
	Initiates the asynchronous execution of the commandText interpreted as specified by the commandType which will return a IDataReader. When the async operation completes, the callback will be invoked on another thread to process the result. More...
virtual IAsyncResult	BeginExecuteReader (DbTransaction transaction, CommandType commandType, string commandText, AsyncCallback callback, object state)
	Initiates the asynchronous execution of the commandText interpreted as specified by the commandType inside an transaction which will return a IDataReader. More...
virtual IDataReader	EndExecuteReader (IAsyncResult asyncResult)
	Finishes asynchronous execution of a Transact-SQL statement, returning an IDataReader. More...
virtual IAsyncResult	BeginExecuteScalar (DbCommand command, AsyncCallback callback, object state)
	Initiates the asynchronous execution of a command which will return a single value. More...
virtual IAsyncResult	BeginExecuteScalar (DbCommand command, DbTransaction transaction, AsyncCallback callback, object state)
	Initiates the asynchronous execution of a command inside a transaction which will return a single value. More...
virtual IAsyncResult	BeginExecuteScalar (string storedProcedureName, AsyncCallback callback, object state, params object[] parameterValues)
	Initiates the asynchronous execution of storedProcedureName using the given parameterValues which will return a single value. More...
virtual IAsyncResult	BeginExecuteScalar (DbTransaction transaction, string storedProcedureName, AsyncCallback callback, object state, params object[] parameterValues)
	Initiates the asynchronous execution of storedProcedureName using the given parameterValues inside a transaction which will return a single value. More...
virtual IAsyncResult	BeginExecuteScalar (CommandType commandType, string commandText, AsyncCallback callback, object state)
	Initiates the asynchronous execution of the commandText interpreted as specified by the commandType which will return a single value. More...
virtual IAsyncResult	BeginExecuteScalar (DbTransaction transaction, CommandType commandType, string commandText, AsyncCallback callback, object state)
	Initiates the asynchronous execution of the commandText interpreted as specified by the commandType inside an transaction which will return a single value. More...
virtual object	EndExecuteScalar (IAsyncResult asyncResult)
	Finishes asynchronous execution of a Transact-SQL statement, returning the first column of the first row in the result set returned by the query. Extra columns or rows are ignored. More...

Static Public Member Functions
static void	ClearParameterCache ()
	Clears the parameter cache. Since there is only one parameter cache that is shared by all instances of this class, this clears all parameters cached for all databases. More...

Protected Member Functions
	Database (string connectionString, DbProviderFactory dbProviderFactory)
	Initializes a new instance of the Database class with a connection string and a DbProviderFactory. More...
virtual void	ConfigureParameter (DbParameter param, string name, DbType dbType, int size, ParameterDirection direction, bool nullable, byte precision, byte scale, string sourceColumn, DataRowVersion sourceVersion, object value)
	Configures a given DbParameter. More...
DbParameter	CreateParameter (string name, DbType dbType, int size, ParameterDirection direction, bool nullable, byte precision, byte scale, string sourceColumn, DataRowVersion sourceVersion, object value)
	Adds a new instance of a DbParameter object. More...
DbParameter	CreateParameter (string name)
	Creates a new instance of a DbParameter object. More...
abstract void	DeriveParameters (DbCommand discoveryCommand)
	Retrieves parameter information from the stored procedure specified in the DbCommand and populates the Parameters collection of the specified DbCommand object. More...
int	DoExecuteNonQuery (DbCommand command)
	Executes the query for command . More...
virtual IDataReader	CreateWrappedReader (DatabaseConnectionWrapper connection, IDataReader innerReader)
	All data readers get wrapped in objects so that they properly manage connections. Some derived Database classes will need to create a different wrapper, so this method is provided so that they can do this. More...
DbDataAdapter	GetDataAdapter (UpdateBehavior updateBehavior)
	Gets the DbDataAdapter with the given update behavior and connection from the proper derived class. More...
DatabaseConnectionWrapper	GetOpenConnection ()
	Gets a "wrapped" connection that will be not be disposed if a transaction is active (created by creating a TransactionScope instance). The connection will be disposed when no transaction is active. More...
virtual DatabaseConnectionWrapper	GetWrappedConnection ()
	Gets a "wrapped" connection for use outside a transaction. More...
virtual bool	SameNumberOfParametersAndValues (DbCommand command, object[] values)
	Determines if the number of parameters in the command matches the array of parameter values. More...
virtual void	SetUpRowUpdatedEvent (DbDataAdapter adapter)
	Sets the RowUpdated event for the data adapter. More...
virtual int	UserParametersStartIndex ()
	Returns the starting index for parameters in a command. More...

Static Protected Member Functions
static void	PrepareCommand (DbCommand command, DbConnection connection)
	Assigns a connection to the command and discovers parameters if needed. More...
static void	PrepareCommand (DbCommand command, DbTransaction transaction)
	Assigns a transaction to the command and discovers parameters if needed. More...

Properties
string	ConnectionString [get]
	Gets the string used to open a database. More...
string	ConnectionStringNoCredentials [get]
	Gets the connection string without the username and password. More...
string	ConnectionStringWithoutCredentials [get]
	Gets the connection string without credentials. More...
DbProviderFactory	DbProviderFactory [get]
	Gets the DbProviderFactory used by the database instance. More...
virtual bool	SupportsParemeterDiscovery [get]
	Does this Database object support parameter discovery? More...
virtual bool	SupportsAsync [get]
	Does this Database object support asynchronous execution? More...

Detailed Description

Represents an abstract database that commands can be run against.

The Database class leverages the provider factory model from ADO.NET. A database instance holds a reference to a concrete DbProviderFactory object to which it forwards the creation of ADO.NET objects.

Constructor & Destructor Documentation

Database()

Microsoft.Practices.EnterpriseLibrary.Data.Database.Database ( string  connectionString, DbProviderFactory  dbProviderFactory  )

protected

Initializes a new instance of the Database class with a connection string and a DbProviderFactory.

Parameters

connectionString	The connection string for the database.
dbProviderFactory	A DbProviderFactory object.

Member Function Documentation

AddInOutParameter() [1/2]

void Microsoft.Practices.EnterpriseLibrary.Data.Database.AddInOutParameter	(	DbCommand	command,
		string	name,
		DbType	dbType,
		int	size,
		object	value
	)

Adds new In/Out DbParameter object to given command

Parameters

command	The command to add the in/out parameter.
name	The name of the parameter
dbType	One of the DbType values.
size	The maximum size of the data within the column.
value	The value of the parameter for In direction.

AddInOutParameter() [2/2]

void Microsoft.Practices.EnterpriseLibrary.Data.Database.AddInOutParameter	(	DbCommand	command,
		string	name,
		DbType	dbType,
		object	value
	)

Adds new In/Out DbParameter object to given command

Parameters

command	The command to add the in/out parameter.
name	The name of the parameter
dbType	One of the DbType values.
value	The value of the parameter for In direction.

AddInParameter() [1/3]

void Microsoft.Practices.EnterpriseLibrary.Data.Database.AddInParameter	(	DbCommand	command,
		string	name,
		DbType	dbType
	)

Adds a new In DbParameter object to the given command .

Parameters

command	The command to add the in parameter.
name	The name of the parameter.
dbType	One of the DbType values.

This version of the method is used when you can have the same parameter object multiple times with different values.

AddInParameter() [2/3]

void Microsoft.Practices.EnterpriseLibrary.Data.Database.AddInParameter	(	DbCommand	command,
		string	name,
		DbType	dbType,
		object	value
	)

Adds a new In DbParameter object to the given command .

Parameters

command	The command to add the parameter.
name	The name of the parameter.
dbType	One of the DbType values.
value	The value of the parameter.

AddInParameter() [3/3]

void Microsoft.Practices.EnterpriseLibrary.Data.Database.AddInParameter	(	DbCommand	command,
		string	name,
		DbType	dbType,
		string	sourceColumn,
		DataRowVersion	sourceVersion
	)

Adds a new In DbParameter object to the given command .

Parameters

command	The command to add the parameter.
name	The name of the parameter.
dbType	One of the DbType values.
sourceColumn	The name of the source column mapped to the DataSet and used for loading or returning the value.
sourceVersion	One of the DataRowVersion values.

AddOutParameter()

void Microsoft.Practices.EnterpriseLibrary.Data.Database.AddOutParameter	(	DbCommand	command,
		string	name,
		DbType	dbType,
		int	size
	)

Adds a new Out DbParameter object to the given command .

Parameters

command	The command to add the out parameter.
name	The name of the parameter.
dbType	One of the DbType values.
size	The maximum size of the data within the column.

AddParameter() [1/2]

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.AddParameter ( DbCommand  command, string  name, DbType  dbType, int  size, ParameterDirection  direction, bool  nullable, byte  precision, byte  scale, string  sourceColumn, DataRowVersion  sourceVersion, object  value  )

virtual

Adds a new In DbParameter object to the given command .

Parameters

command	The command to add the parameter.
name	The name of the parameter.
dbType	One of the DbType values.
size	The maximum size of the data within the column.
direction	One of the ParameterDirection values.
nullable	A value indicating whether the parameter accepts null (Nothing in Visual Basic) values.
precision	The maximum number of digits used to represent the value .
scale	The number of decimal places to which value is resolved.
sourceColumn	The name of the source column mapped to the DataSet and used for loading or returning the value .
sourceVersion	One of the DataRowVersion values.
value	The value of the parameter.

Exceptions

ArgumentNullException

command is null.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

AddParameter() [2/2]

void Microsoft.Practices.EnterpriseLibrary.Data.Database.AddParameter	(	DbCommand	command,
		string	name,
		DbType	dbType,
		ParameterDirection	direction,
		string	sourceColumn,
		DataRowVersion	sourceVersion,
		object	value
	)

Adds a new instance of a DbParameter object to the command.

Parameters

command	The command to add the parameter.
name	The name of the parameter.
dbType	One of the DbType values.
direction	One of the ParameterDirection values.
sourceColumn	The name of the source column mapped to the DataSet and used for loading or returning the value .
sourceVersion	One of the DataRowVersion values.
value	The value of the parameter.

Exceptions

ArgumentNullException

command is null.

AssignParameters()

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.AssignParameters ( DbCommand  command, object[]  parameterValues  )

virtual

Discovers parameters on the command and assigns the values from parameterValues to the command s Parameters list.

Parameters

command	The command the parameter values will be assigned to
parameterValues	The parameter values that will be assigned to the command.

Exceptions

InvalidOperationException

The number of parameters in parameterValues does not match the number of parameters in command .

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

BeginExecuteNonQuery() [1/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteNonQuery ( CommandType  commandType, string  commandText, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of the commandText interpreted as specified by the commandType which will return the number of rows affected.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteNonQuery, which returns the number of affected records.

See also

Database.ExecuteNonQuery(CommandType,string), EndExecuteNonQuery(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteNonQuery() [2/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteNonQuery ( DbCommand  command, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of the DbCommand which will return the number of affected records.

Parameters

command	The DbCommand to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

See also

Database.ExecuteNonQuery(DbCommand), EndExecuteNonQuery(IAsyncResult)

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteNonQuery, which returns the number of affected records.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteNonQuery() [3/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteNonQuery ( DbCommand  command, DbTransaction  transaction, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of the DbCommand inside a transaction which will return the number of affected records.

Parameters

command	The DbCommand to execute.
transaction	The DbTransaction to execute the command within.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

See also

Database.ExecuteNonQuery(DbCommand), EndExecuteNonQuery(IAsyncResult)

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteNonQuery, which returns the number of affected records.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteNonQuery() [4/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteNonQuery ( DbTransaction  transaction, CommandType  commandType, string  commandText, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of the commandText interpreted as specified by the commandType inside a transaction which will return the number of rows affected.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.
transaction	The DbTransaction to execute the command within.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteNonQuery, which returns the number of affected records.

See also

Database.ExecuteNonQuery(CommandType,string), EndExecuteNonQuery(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteNonQuery() [5/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteNonQuery ( DbTransaction  transaction, string  storedProcedureName, AsyncCallback  callback, object  state, params object[]  parameterValues  )

virtual

Initiates the asynchronous execution of the storedProcedureName using the given parameterValues inside a transaction which will return the number of rows affected.

Parameters

storedProcedureName	The name of the stored procedure to execute.
transaction	The DbTransaction to execute the command within.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteNonQuery, which returns the number of affected records.

See also

Database.ExecuteNonQuery(string,object[]), EndExecuteNonQuery(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteNonQuery() [6/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteNonQuery ( string  storedProcedureName, AsyncCallback  callback, object  state, params object[]  parameterValues  )

virtual

Initiates the asynchronous execution of the storedProcedureName using the given parameterValues which will return the number of rows affected.

Parameters

storedProcedureName	The name of the stored procedure to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteNonQuery, which returns the number of affected records.

See also

Database.ExecuteNonQuery(string,object[]), EndExecuteNonQuery(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteReader() [1/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteReader ( CommandType  commandType, string  commandText, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of the commandText interpreted as specified by the commandType which will return a IDataReader. When the async operation completes, the callback will be invoked on another thread to process the result.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.
callback	AsyncCallback to execute when the async operation completes.
state	State object passed to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteReader, which returns the IDataReader.

See also

Database.ExecuteReader(CommandType, string), EndExecuteReader(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteReader() [2/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteReader ( DbCommand  command, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of a command which will return a IDataReader.

Parameters

command	The DbCommand to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteReader, which returns the IDataReader.

See also

Database.ExecuteReader(DbCommand), EndExecuteReader(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteReader() [3/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteReader ( DbCommand  command, DbTransaction  transaction, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of a command inside a transaction which will return a IDataReader.

Parameters

command	The DbCommand to execute.
transaction	The DbTransaction to execute the command within.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteReader, which returns the IDataReader.

See also

Database.ExecuteReader(DbCommand), EndExecuteReader(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteReader() [4/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteReader ( DbTransaction  transaction, CommandType  commandType, string  commandText, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of the commandText interpreted as specified by the commandType inside an transaction which will return a IDataReader.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.
transaction	The DbTransaction to execute the command within.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteReader, which returns the IDataReader.

See also

Database.ExecuteReader(CommandType, string), EndExecuteReader(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteReader() [5/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteReader ( DbTransaction  transaction, string  storedProcedureName, AsyncCallback  callback, object  state, params object[]  parameterValues  )

virtual

Initiates the asynchronous execution of storedProcedureName using the given parameterValues inside a transaction which will return a IDataReader.

Parameters

transaction	The DbTransaction to execute the command within.
storedProcedureName	The name of the stored procedure to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteReader, which returns the IDataReader.

See also

Database.ExecuteReader(DbTransaction, string, object[]), EndExecuteReader(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteReader() [6/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteReader ( string  storedProcedureName, AsyncCallback  callback, object  state, params object[]  parameterValues  )

virtual

Initiates the asynchronous execution of storedProcedureName using the given parameterValues which will return a IDataReader.

Parameters

storedProcedureName	The name of the stored procedure to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteReader, which returns the IDataReader.

See also

Database.ExecuteReader(string, object[]), EndExecuteReader(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteScalar() [1/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteScalar ( CommandType  commandType, string  commandText, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of the commandText interpreted as specified by the commandType which will return a single value.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteScalar, which returns the actual result.

See also

Database.ExecuteScalar(CommandType, string), EndExecuteScalar(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteScalar() [2/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteScalar ( DbCommand  command, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of a command which will return a single value.

Parameters

command	The DbCommand to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteScalar, which returns the actual result.

See also

Database.ExecuteScalar(DbCommand), EndExecuteScalar(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteScalar() [3/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteScalar ( DbCommand  command, DbTransaction  transaction, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of a command inside a transaction which will return a single value.

Parameters

command	The DbCommand to execute.
transaction	The DbTransaction to execute the command within.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteScalar, which returns the actual result.

See also

Database.ExecuteScalar(DbCommand, DbTransaction), EndExecuteScalar(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteScalar() [4/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteScalar ( DbTransaction  transaction, CommandType  commandType, string  commandText, AsyncCallback  callback, object  state  )

virtual

Initiates the asynchronous execution of the commandText interpreted as specified by the commandType inside an transaction which will return a single value.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.
transaction	The DbTransaction to execute the command within.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteScalar, which returns the actual result.

See also

Database.ExecuteScalar(DbTransaction, CommandType, string), EndExecuteScalar(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteScalar() [5/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteScalar ( DbTransaction  transaction, string  storedProcedureName, AsyncCallback  callback, object  state, params object[]  parameterValues  )

virtual

Initiates the asynchronous execution of storedProcedureName using the given parameterValues inside a transaction which will return a single value.

Parameters

transaction	The DbTransaction to execute the command within.
storedProcedureName	The name of the stored procedure to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteScalar, which returns the actual result.

See also

Database.ExecuteScalar(DbTransaction, string, object[]), EndExecuteScalar(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BeginExecuteScalar() [6/6]

virtual IAsyncResult Microsoft.Practices.EnterpriseLibrary.Data.Database.BeginExecuteScalar ( string  storedProcedureName, AsyncCallback  callback, object  state, params object[]  parameterValues  )

virtual

Initiates the asynchronous execution of storedProcedureName using the given parameterValues which will return a single value.

Parameters

storedProcedureName	The name of the stored procedure to execute.
callback	The async callback to execute when the result of the operation is available. Pass <langword>null</langword> if you don't want to use a callback.
state	Additional state object to pass to the callback.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteScalar, which returns the actual result.

See also

Database.ExecuteScalar(string, object[]), EndExecuteScalar(IAsyncResult)

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

BuildParameterName()

virtual string Microsoft.Practices.EnterpriseLibrary.Data.Database.BuildParameterName ( string  name )

virtual

Builds a value parameter name for the current database.

Parameters

name	The name of the parameter.

Returns

A correctly formated parameter name.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase, and Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

ClearParameterCache()

static void Microsoft.Practices.EnterpriseLibrary.Data.Database.ClearParameterCache ( )

static

Clears the parameter cache. Since there is only one parameter cache that is shared by all instances of this class, this clears all parameters cached for all databases.

ConfigureParameter()

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.ConfigureParameter ( DbParameter  param, string  name, DbType  dbType, int  size, ParameterDirection  direction, bool  nullable, byte  precision, byte  scale, string  sourceColumn, DataRowVersion  sourceVersion, object  value  )

protectedvirtual

Configures a given DbParameter.

Parameters

param	The DbParameter to configure.
name	The name of the parameter.
dbType	One of the DbType values.
size	The maximum size of the data within the column.
direction	One of the ParameterDirection values.
nullable	A value indicating whether the parameter accepts null (Nothing in Visual Basic) values.
precision	The maximum number of digits used to represent the value .
scale	The number of decimal places to which value is resolved.
sourceColumn	The name of the source column mapped to the DataSet and used for loading or returning the value .
sourceVersion	One of the DataRowVersion values.
value	The value of the parameter.

CreateConnection()

virtual DbConnection Microsoft.Practices.EnterpriseLibrary.Data.Database.CreateConnection ( )

virtual

Creates a connection for this database.

Returns

The DbConnection for this database.

See also

DbConnection

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase.

CreateParameter() [1/2]

DbParameter Microsoft.Practices.EnterpriseLibrary.Data.Database.CreateParameter ( string  name )

protected

Creates a new instance of a DbParameter object.

Parameters

name	The name of the parameter.

Returns

An unconfigured parameter.

CreateParameter() [2/2]

DbParameter Microsoft.Practices.EnterpriseLibrary.Data.Database.CreateParameter ( string  name, DbType  dbType, int  size, ParameterDirection  direction, bool  nullable, byte  precision, byte  scale, string  sourceColumn, DataRowVersion  sourceVersion, object  value  )

protected

Adds a new instance of a DbParameter object.

Parameters

name	The name of the parameter.
dbType	One of the DbType values.
size	The maximum size of the data within the column.
direction	One of the ParameterDirection values.
nullable	A value indicating whether the parameter accepts null (Nothing in Visual Basic) values.
precision	The maximum number of digits used to represent the value .
scale	The number of decimal places to which value is resolved.
sourceColumn	The name of the source column mapped to the DataSet and used for loading or returning the value .
sourceVersion	One of the DataRowVersion values.
value	The value of the parameter.

Returns

A newly created DbParameter fully initialized with given parameters.

CreateWrappedReader()

virtual IDataReader Microsoft.Practices.EnterpriseLibrary.Data.Database.CreateWrappedReader ( DatabaseConnectionWrapper  connection, IDataReader  innerReader  )

protectedvirtual

All data readers get wrapped in objects so that they properly manage connections. Some derived Database classes will need to create a different wrapper, so this method is provided so that they can do this.

Parameters

connection	Connection + refcount.
innerReader	The reader to wrap.

Returns

The new reader.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

DeriveParameters()

abstract void Microsoft.Practices.EnterpriseLibrary.Data.Database.DeriveParameters ( DbCommand  discoveryCommand )

protectedpure virtual

Retrieves parameter information from the stored procedure specified in the DbCommand and populates the Parameters collection of the specified DbCommand object.

Parameters

discoveryCommand

The DbCommand to do the discovery.

Implemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase, Microsoft.Practices.EnterpriseLibrary.Data.GenericDatabase, Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase, Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase, Microsoft.Practices.EnterpriseLibrary.Data.OleDb.OleDbDatabase, and Microsoft.Practices.EnterpriseLibrary.Data.Odbc.OdbcDatabase.

DiscoverParameters()

void Microsoft.Practices.EnterpriseLibrary.Data.Database.DiscoverParameters

(

DbCommand

command

)

Discovers the parameters for a DbCommand.

Parameters

command

The DbCommand to discover the parameters.

You should get the value of SupportsParemeterDiscovery to detect if parameter discovery is supported for your database provider type.

DoExecuteNonQuery()

int Microsoft.Practices.EnterpriseLibrary.Data.Database.DoExecuteNonQuery ( DbCommand  command )

protected

Executes the query for command .

Parameters

command

The DbCommand representing the query to execute.

Returns

The quantity of rows affected.

EndExecuteNonQuery()

virtual int Microsoft.Practices.EnterpriseLibrary.Data.Database.EndExecuteNonQuery ( IAsyncResult  asyncResult )

virtual

Finishes asynchronous execution of a SQL statement, returning the number of affected records.

Parameters

asyncResult

The IAsyncResult returned by a call to any overload of BeginExecuteNonQuery(DbCommand, AsyncCallback, object).

See also

Database.ExecuteNonQuery(DbCommand), BeginExecuteNonQuery(DbCommand, AsyncCallback, object), BeginExecuteNonQuery(DbCommand, DbTransaction, AsyncCallback, object)

Returns

The number of affected records.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

EndExecuteReader()

virtual IDataReader Microsoft.Practices.EnterpriseLibrary.Data.Database.EndExecuteReader ( IAsyncResult  asyncResult )

virtual

Finishes asynchronous execution of a Transact-SQL statement, returning an IDataReader.

Parameters

asyncResult

The IAsyncResult returned by a call to any overload of BeginExecuteReader.

See also

Database.ExecuteReader(DbCommand), BeginExecuteReader(DbCommand,AsyncCallback,object), BeginExecuteReader(DbCommand, DbTransaction,AsyncCallback,object)

Returns

An IDataReader object that can be used to consume the queried information.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

EndExecuteScalar()

virtual object Microsoft.Practices.EnterpriseLibrary.Data.Database.EndExecuteScalar ( IAsyncResult  asyncResult )

virtual

Finishes asynchronous execution of a Transact-SQL statement, returning the first column of the first row in the result set returned by the query. Extra columns or rows are ignored.

Parameters

asyncResult

The IAsyncResult returned by a call to any overload of BeginExecuteScalar.

See also

Database.ExecuteScalar(DbCommand), BeginExecuteScalar(DbCommand,AsyncCallback,object), BeginExecuteScalar(DbCommand,DbTransaction,AsyncCallback,object)

Returns

The value of the first column of the first row in the result set returned by the query. If the result didn't have any columns or rows null (Nothing in Visual Basic).

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase.

ExecuteDataSet() [1/6]

virtual DataSet Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteDataSet ( CommandType  commandType, string  commandText  )

virtual

Executes the commandText interpreted as specified by the commandType and returns the results in a new DataSet.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.

Returns

A DataSet with the results of the commandText .

ExecuteDataSet() [2/6]

virtual DataSet Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteDataSet ( DbCommand  command )

virtual

Executes the command and returns the results in a new DataSet.

Parameters

command

The DbCommand to execute.

Returns

A DataSet with the results of the command .

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

ExecuteDataSet() [3/6]

virtual DataSet Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteDataSet ( DbCommand  command, DbTransaction  transaction  )

virtual

Executes the command as part of the transaction and returns the results in a new DataSet.

Parameters

command	The DbCommand to execute.
transaction	The IDbTransaction to execute the command within.

Returns

A DataSet with the results of the command .

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

ExecuteDataSet() [4/6]

virtual DataSet Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteDataSet ( DbTransaction  transaction, CommandType  commandType, string  commandText  )

virtual

Executes the commandText as part of the given transaction and returns the results in a new DataSet.

Parameters

transaction	The IDbTransaction to execute the command within.
commandType	One of the CommandType values.
commandText	The command text to execute.

Returns

A DataSet with the results of the commandText .

ExecuteDataSet() [5/6]

virtual DataSet Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteDataSet ( DbTransaction  transaction, string  storedProcedureName, params object[]  parameterValues  )

virtual

Executes the storedProcedureName with parameterValues as part of the transaction and returns the results in a new DataSet within a transaction.

Parameters

transaction	The IDbTransaction to execute the command within.
storedProcedureName	The stored procedure to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

A DataSet with the results of the storedProcedureName .

ExecuteDataSet() [6/6]

virtual DataSet Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteDataSet ( string  storedProcedureName, params object[]  parameterValues  )

virtual

Executes the storedProcedureName with parameterValues and returns the results in a new DataSet.

Parameters

storedProcedureName	The stored procedure to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

A DataSet with the results of the storedProcedureName .

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase.

ExecuteNonQuery() [1/6]

virtual int Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteNonQuery ( CommandType  commandType, string  commandText  )

virtual

Executes the commandText interpreted as specified by the commandType and returns the number of rows affected.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.

Returns

The number of rows affected.

See also

IDbCommand.ExecuteScalar

ExecuteNonQuery() [2/6]

virtual int Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteNonQuery ( DbCommand  command )

virtual

Executes the command and returns the number of rows affected.

Parameters

command

The command that contains the query to execute.

See also

IDbCommand.ExecuteScalar

ExecuteNonQuery() [3/6]

virtual int Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteNonQuery ( DbCommand  command, DbTransaction  transaction  )

virtual

Executes the command within the given transaction , and returns the number of rows affected.

Parameters

command	The command that contains the query to execute.
transaction	The IDbTransaction to execute the command within.

See also

IDbCommand.ExecuteScalar

ExecuteNonQuery() [4/6]

virtual int Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteNonQuery ( DbTransaction  transaction, CommandType  commandType, string  commandText  )

virtual

Executes the commandText interpreted as specified by the commandType as part of the given transaction and returns the number of rows affected.

Parameters

transaction	The IDbTransaction to execute the command within.
commandType	One of the CommandType values.
commandText	The command text to execute.

Returns

The number of rows affected

See also

IDbCommand.ExecuteScalar

ExecuteNonQuery() [5/6]

virtual int Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteNonQuery ( DbTransaction  transaction, string  storedProcedureName, params object[]  parameterValues  )

virtual

Executes the storedProcedureName using the given parameterValues within a transaction and returns the number of rows affected.

Parameters

transaction	The IDbTransaction to execute the command within.
storedProcedureName	The name of the stored procedure to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

The number of rows affected.

See also

IDbCommand.ExecuteScalar

ExecuteNonQuery() [6/6]

virtual int Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteNonQuery ( string  storedProcedureName, params object[]  parameterValues  )

virtual

Executes the storedProcedureName using the given parameterValues and returns the number of rows affected.

Parameters

storedProcedureName	The name of the stored procedure to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

The number of rows affected

See also

IDbCommand.ExecuteScalar

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase.

ExecuteReader() [1/6]

IDataReader Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteReader	(	CommandType	commandType,
		string	commandText
	)

Executes the commandText interpreted as specified by the commandType and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.

Returns

An IDataReader object.

ExecuteReader() [2/6]

virtual IDataReader Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteReader ( DbCommand  command )

virtual

Executes the command and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the reader when finished.

Parameters

command

The command that contains the query to execute.

Returns

An IDataReader object.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

ExecuteReader() [3/6]

virtual IDataReader Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteReader ( DbCommand  command, DbTransaction  transaction  )

virtual

Executes the command within a transaction and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished.

Parameters

command	The command that contains the query to execute.
transaction	The IDbTransaction to execute the command within.

Returns

An IDataReader object.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

ExecuteReader() [4/6]

IDataReader Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteReader	(	DbTransaction	transaction,
		CommandType	commandType,
		string	commandText
	)

Executes the commandText interpreted as specified by commandType within the given transaction and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished.

Parameters

transaction	The IDbTransaction to execute the command within.
commandType	One of the CommandType values.
commandText	The command text to execute.

Returns

An IDataReader object.

ExecuteReader() [5/6]

IDataReader Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteReader	(	DbTransaction	transaction,
		string	storedProcedureName,
		params object[]	parameterValues
	)

Executes the storedProcedureName with the given parameterValues within the given transaction and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished.

Parameters

transaction	The IDbTransaction to execute the command within.
storedProcedureName	The command that contains the query to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

An IDataReader object.

ExecuteReader() [6/6]

IDataReader Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteReader	(	string	storedProcedureName,
		params object[]	parameterValues
	)

Executes the storedProcedureName with the given parameterValues and returns an IDataReader through which the result can be read. It is the responsibility of the caller to close the connection and reader when finished.

Parameters

storedProcedureName	The command that contains the query to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

An IDataReader object.

ExecuteScalar() [1/6]

virtual object Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteScalar ( CommandType  commandType, string  commandText  )

virtual

Executes the commandText interpreted as specified by the commandType and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.

Returns

The first column of the first row in the result set.

See also

IDbCommand.ExecuteScalar

ExecuteScalar() [2/6]

virtual object Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteScalar ( DbCommand  command )

virtual

Executes the command and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored.

Parameters

command

The command that contains the query to execute.

Returns

The first column of the first row in the result set.

See also

IDbCommand.ExecuteScalar

ExecuteScalar() [3/6]

virtual object Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteScalar ( DbCommand  command, DbTransaction  transaction  )

virtual

Executes the command within a transaction , and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored.

Parameters

command	The command that contains the query to execute.
transaction	The IDbTransaction to execute the command within.

Returns

The first column of the first row in the result set.

See also

IDbCommand.ExecuteScalar

ExecuteScalar() [4/6]

virtual object Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteScalar ( DbTransaction  transaction, CommandType  commandType, string  commandText  )

virtual

Executes the commandText interpreted as specified by the commandType within the given transaction and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored.

Parameters

transaction	The IDbTransaction to execute the command within.
commandType	One of the CommandType values.
commandText	The command text to execute.

Returns

The first column of the first row in the result set.

See also

IDbCommand.ExecuteScalar

ExecuteScalar() [5/6]

virtual object Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteScalar ( DbTransaction  transaction, string  storedProcedureName, params object[]  parameterValues  )

virtual

Executes the storedProcedureName with the given parameterValues within a transaction and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored.

Parameters

transaction	The IDbTransaction to execute the command within.
storedProcedureName	The stored procedure to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

The first column of the first row in the result set.

See also

IDbCommand.ExecuteScalar

ExecuteScalar() [6/6]

virtual object Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteScalar ( string  storedProcedureName, params object[]  parameterValues  )

virtual

Executes the storedProcedureName with the given parameterValues and returns the first column of the first row in the result set returned by the query. Extra columns or rows are ignored.

Parameters

storedProcedureName	The stored procedure to execute.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Returns

The first column of the first row in the result set.

See also

IDbCommand.ExecuteScalar

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase.

GetDataAdapter() [1/2]

DbDataAdapter Microsoft.Practices.EnterpriseLibrary.Data.Database.GetDataAdapter

(

)

Gets a DbDataAdapter with Standard update behavior.

Created this new, public method instead of modifying the protected, abstract one so that there will be no breaking changes for any currently derived Database class.

Returns

A DbDataAdapter.

See also

DbDataAdapter

GetDataAdapter() [2/2]

DbDataAdapter Microsoft.Practices.EnterpriseLibrary.Data.Database.GetDataAdapter ( UpdateBehavior  updateBehavior )

protected

Gets the DbDataAdapter with the given update behavior and connection from the proper derived class.

Parameters

updateBehavior

One of the UpdateBehavior values.

Returns

A DbDataAdapter.

See also

DbDataAdapter

GetOpenConnection()

DatabaseConnectionWrapper Microsoft.Practices.EnterpriseLibrary.Data.Database.GetOpenConnection ( )

protected

Gets a "wrapped" connection that will be not be disposed if a transaction is active (created by creating a TransactionScope instance). The connection will be disposed when no transaction is active.

Returns

GetParameterValue()

virtual object Microsoft.Practices.EnterpriseLibrary.Data.Database.GetParameterValue ( DbCommand  command, string  name  )

virtual

Gets a parameter value.

Parameters

command	The command that contains the parameter.
name	The name of the parameter.

Returns

The value of the parameter.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

GetSqlStringCommand()

DbCommand Microsoft.Practices.EnterpriseLibrary.Data.Database.GetSqlStringCommand

(

string

query

)

Creates a DbCommand for a SQL query.

Parameters

query

The text of the query.

Returns

The DbCommand for the SQL query.

Exceptions

ArgumentException

query is null or empty.

GetStoredProcCommand() [1/2]

virtual DbCommand Microsoft.Practices.EnterpriseLibrary.Data.Database.GetStoredProcCommand ( string  storedProcedureName )

virtual

Creates a DbCommand for a stored procedure.

Parameters

storedProcedureName

The name of the stored procedure.

Returns

The DbCommand for the stored procedure.

Exceptions

ArgumentException

storedProcedureName is null or empty.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase, and Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

GetStoredProcCommand() [2/2]

virtual DbCommand Microsoft.Practices.EnterpriseLibrary.Data.Database.GetStoredProcCommand ( string  storedProcedureName, params object[]  parameterValues  )

virtual

Creates a DbCommand for a stored procedure.

Parameters

storedProcedureName	The name of the stored procedure.
parameterValues	The list of parameters for the procedure.

Returns

The DbCommand for the stored procedure.

The parameters for the stored procedure will be discovered and the values are assigned in positional order.

Exceptions

ArgumentException

storedProcedureName is null or empty.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase, and Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

GetStoredProcCommandWithSourceColumns()

DbCommand Microsoft.Practices.EnterpriseLibrary.Data.Database.GetStoredProcCommandWithSourceColumns	(	string	storedProcedureName,
		params string[]	sourceColumns
	)

Wraps around a derived class's implementation of the GetStoredProcCommandWrapper method and adds functionality for using this method with UpdateDataSet. The GetStoredProcCommandWrapper method (above) that takes a params array expects the array to be filled with VALUES for the parameters. This method differs from the GetStoredProcCommandWrapper method in that it allows a user to pass in a string array. It will also dynamically discover the parameters for the stored procedure and set the parameter's SourceColumns to the strings that are passed in. It does this by mapping the parameters to the strings IN ORDER. Thus, order is very important.

Parameters

storedProcedureName	The name of the stored procedure.
sourceColumns	The list of DataFields for the procedure.

Returns

The DbCommand for the stored procedure.

GetWrappedConnection()

virtual DatabaseConnectionWrapper Microsoft.Practices.EnterpriseLibrary.Data.Database.GetWrappedConnection ( )

protectedvirtual

Gets a "wrapped" connection for use outside a transaction.

Returns

The wrapped connection.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase.

LoadDataSet() [1/8]

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.LoadDataSet ( CommandType  commandType, string  commandText, DataSet  dataSet, string[]  tableNames  )

virtual

Loads a DataSet from command text.

Parameters

commandType	One of the CommandType values.
commandText	The command text to execute.
dataSet	The DataSet to fill.
tableNames	An array of table name mappings for the DataSet.

LoadDataSet() [2/8]

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.LoadDataSet ( DbCommand  command, DataSet  dataSet, string  tableName  )

virtual

Executes the command and adds a new DataTable to the existing DataSet.

Parameters

command	The DbCommand to execute.
dataSet	The DataSet to load.
tableName	The name for the new DataTable to add to the DataSet.

Exceptions

System.ArgumentNullException	Any input parameter was null (Nothing in Visual Basic)
System.ArgumentException	tableName was an empty string

LoadDataSet() [3/8]

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.LoadDataSet ( DbCommand  command, DataSet  dataSet, string  tableName, DbTransaction  transaction  )

virtual

Executes the command within the given transaction and adds a new DataTable to the existing DataSet.

Parameters

command	The DbCommand to execute.
dataSet	The DataSet to load.
tableName	The name for the new DataTable to add to the DataSet.
transaction	The IDbTransaction to execute the command within.

Exceptions

System.ArgumentNullException	Any input parameter was null (Nothing in Visual Basic).
System.ArgumentException	tableName was an empty string.

LoadDataSet() [4/8]

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.LoadDataSet ( DbCommand  command, DataSet  dataSet, string[]  tableNames  )

virtual

Loads a DataSet from a DbCommand.

Parameters

command	The command to execute to fill the DataSet.
dataSet	The DataSet to fill.
tableNames	An array of table name mappings for the DataSet.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

LoadDataSet() [5/8]

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.LoadDataSet ( DbCommand  command, DataSet  dataSet, string[]  tableNames, DbTransaction  transaction  )

virtual

Loads a DataSet from a DbCommand in a transaction.

Parameters

command	The command to execute to fill the DataSet.
dataSet	The DataSet to fill.
tableNames	An array of table name mappings for the DataSet.
transaction	The IDbTransaction to execute the command in.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

LoadDataSet() [6/8]

void Microsoft.Practices.EnterpriseLibrary.Data.Database.LoadDataSet	(	DbTransaction	transaction,
		CommandType	commandType,
		string	commandText,
		DataSet	dataSet,
		string[]	tableNames
	)

Loads a DataSet from command text in a transaction.

Parameters

transaction	The IDbTransaction to execute the command in.
commandType	One of the CommandType values.
commandText	The command text to execute.
dataSet	The DataSet to fill.
tableNames	An array of table name mappings for the DataSet.

LoadDataSet() [7/8]

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.LoadDataSet ( DbTransaction  transaction, string  storedProcedureName, DataSet  dataSet, string[]  tableNames, params object[]  parameterValues  )

virtual

Loads a DataSet with the results returned from a stored procedure executed in a transaction.

Parameters

transaction	The IDbTransaction to execute the stored procedure in.
storedProcedureName	The stored procedure name to execute.
dataSet	The DataSet to fill.
tableNames	An array of table name mappings for the DataSet.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

LoadDataSet() [8/8]

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.LoadDataSet ( string  storedProcedureName, DataSet  dataSet, string[]  tableNames, params object[]  parameterValues  )

virtual

Loads a DataSet with the results returned from a stored procedure.

Parameters

storedProcedureName	The stored procedure name to execute.
dataSet	The DataSet to fill.
tableNames	An array of table name mappings for the DataSet.
parameterValues	An array of parameters to pass to the stored procedure. The parameter values must be in call order as they appear in the stored procedure.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase.

PrepareCommand() [1/2]

static void Microsoft.Practices.EnterpriseLibrary.Data.Database.PrepareCommand ( DbCommand  command, DbConnection  connection  )

staticprotected

Assigns a connection to the command and discovers parameters if needed.

Parameters

command	The command that contains the query to prepare.
connection	The connection to assign to the command.

PrepareCommand() [2/2]

static void Microsoft.Practices.EnterpriseLibrary.Data.Database.PrepareCommand ( DbCommand  command, DbTransaction  transaction  )

staticprotected

Assigns a transaction to the command and discovers parameters if needed.

Parameters

command	The command that contains the query to prepare.
transaction	The transaction to assign to the command.

SameNumberOfParametersAndValues()

virtual bool Microsoft.Practices.EnterpriseLibrary.Data.Database.SameNumberOfParametersAndValues ( DbCommand  command, object[]  values  )

protectedvirtual

Determines if the number of parameters in the command matches the array of parameter values.

Parameters

command	The DbCommand containing the parameters.
values	The array of parameter values.

Returns

true if the number of parameters and values match; otherwise, false.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase, and Microsoft.Practices.EnterpriseLibrary.Data.OleDb.OleDbDatabase.

SetParameterValue()

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.SetParameterValue ( DbCommand  command, string  parameterName, object  value  )

virtual

Sets a parameter value.

Parameters

command	The command with the parameter.
parameterName	The parameter name.
value	The parameter value.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase.

SetUpRowUpdatedEvent()

virtual void Microsoft.Practices.EnterpriseLibrary.Data.Database.SetUpRowUpdatedEvent ( DbDataAdapter  adapter )

protectedvirtual

Sets the RowUpdated event for the data adapter.

Parameters

adapter

The DbDataAdapter to set the event.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.SqlCe.SqlCeDatabase, Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase, Microsoft.Practices.EnterpriseLibrary.Data.Oracle.OracleDatabase, Microsoft.Practices.EnterpriseLibrary.Data.OleDb.OleDbDatabase, and Microsoft.Practices.EnterpriseLibrary.Data.Odbc.OdbcDatabase.

UpdateDataSet() [1/4]

int Microsoft.Practices.EnterpriseLibrary.Data.Database.UpdateDataSet	(	DataSet	dataSet,
		string	tableName,
		DbCommand	insertCommand,
		DbCommand	updateCommand,
		DbCommand	deleteCommand,
		DbTransaction	transaction
	)

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet within a transaction.

Parameters

dataSet	The DataSet used to update the data source.
tableName	The name of the source table to use for table mapping.
insertCommand	The DbCommand executed when DataRowState is DataRowState.Added.
updateCommand	The DbCommand executed when DataRowState is DataRowState.Modified.
deleteCommand	The DbCommand executed when DataRowState is DataRowState.Deleted.
transaction	The IDbTransaction to use.

Returns

Number of records affected.

UpdateDataSet() [2/4]

int Microsoft.Practices.EnterpriseLibrary.Data.Database.UpdateDataSet	(	DataSet	dataSet,
		string	tableName,
		DbCommand	insertCommand,
		DbCommand	updateCommand,
		DbCommand	deleteCommand,
		DbTransaction	transaction,
		int?	updateBatchSize
	)

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet within a transaction.

Parameters

dataSet	The DataSet used to update the data source.
tableName	The name of the source table to use for table mapping.
insertCommand	The DbCommand executed when DataRowState is DataRowState.Added.
updateCommand	The DbCommand executed when DataRowState is DataRowState.Modified.
deleteCommand	The DbCommand executed when DataRowState is DataRowState.Deleted.
transaction	The IDbTransaction to use.
updateBatchSize	The number of commands that can be executed in a single call to the database. Set to 0 to use the largest size the server can handle, 1 to disable batch updates, and anything else to set the number of rows.

Returns

Number of records affected.

UpdateDataSet() [3/4]

int Microsoft.Practices.EnterpriseLibrary.Data.Database.UpdateDataSet	(	DataSet	dataSet,
		string	tableName,
		DbCommand	insertCommand,
		DbCommand	updateCommand,
		DbCommand	deleteCommand,
		UpdateBehavior	updateBehavior
	)

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet.

Parameters

dataSet	The DataSet used to update the data source.
tableName	The name of the source table to use for table mapping.
insertCommand	The DbCommand executed when DataRowState is DataRowState.Added
updateCommand	The DbCommand executed when DataRowState is DataRowState.Modified
deleteCommand	The DbCommand executed when DataRowState is DataRowState.Deleted
updateBehavior	One of the UpdateBehavior values.

Returns

number of records affected

UpdateDataSet() [4/4]

int Microsoft.Practices.EnterpriseLibrary.Data.Database.UpdateDataSet	(	DataSet	dataSet,
		string	tableName,
		DbCommand	insertCommand,
		DbCommand	updateCommand,
		DbCommand	deleteCommand,
		UpdateBehavior	updateBehavior,
		int?	updateBatchSize
	)

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet.

Parameters

dataSet	The DataSet used to update the data source.
tableName	The name of the source table to use for table mapping.
insertCommand	The DbCommand executed when DataRowState is DataRowState.Added
updateCommand	The DbCommand executed when DataRowState is DataRowState.Modified
deleteCommand	The DbCommand executed when DataRowState is DataRowState.Deleted
updateBehavior	One of the UpdateBehavior values.
updateBatchSize	The number of database commands to execute in a batch.

Returns

number of records affected

UserParametersStartIndex()

virtual int Microsoft.Practices.EnterpriseLibrary.Data.Database.UserParametersStartIndex ( )

protectedvirtual

Returns the starting index for parameters in a command.

Returns

The starting index for parameters in a command.

Reimplemented in Microsoft.Practices.EnterpriseLibrary.Data.Sql.SqlDatabase, and Microsoft.Practices.EnterpriseLibrary.Data.OleDb.OleDbDatabase.

Property Documentation

ConnectionString

string Microsoft.Practices.EnterpriseLibrary.Data.Database.ConnectionString

get

Gets the string used to open a database.

The string used to open a database.

See also

DbConnection.ConnectionString

ConnectionStringNoCredentials

string Microsoft.Practices.EnterpriseLibrary.Data.Database.ConnectionStringNoCredentials

getprotected

Gets the connection string without the username and password.

The connection string without the username and password.

See also

ConnectionString

ConnectionStringWithoutCredentials

string Microsoft.Practices.EnterpriseLibrary.Data.Database.ConnectionStringWithoutCredentials

get

Gets the connection string without credentials.

The connection string without credentials.

DbProviderFactory

DbProviderFactory Microsoft.Practices.EnterpriseLibrary.Data.Database.DbProviderFactory

get

Gets the DbProviderFactory used by the database instance.

See also

DbProviderFactory

SupportsAsync

virtual bool Microsoft.Practices.EnterpriseLibrary.Data.Database.SupportsAsync

get

Does this Database object support asynchronous execution?

Base class always returns false.

SupportsParemeterDiscovery

virtual bool Microsoft.Practices.EnterpriseLibrary.Data.Database.SupportsParemeterDiscovery

get

Does this Database object support parameter discovery?

Base class always returns false.

---

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

• Database.cs