Useful set of utilities and abstractions for simplifying modern data-access operations and ensuring DI compatibility.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 5d9e81b Oct 7, 2018

README.md

Open.Database.Extensions

Useful set of utilities and abstractions for simplifying modern database operations and ensuring dependency injection compatibility.

Full API Documentation Click Here

Connection Factories

Connection factories facilitate creation and disposal of connections without the concern of a connection reference or need for awareness of a connection string. A SqlConnectionFactory is provided and can be overriden to provide more specific dependency injection configurations.

Expressive Commands

The provided expressive command classes allow for an expressive means to append parameters and execute the results without lenghty complicated setup.

Extensions are provied to create commands from connection factories.

Example
var result = connectionFactory
   .StoredProcedure("[procedure name]")
   .AddParam("a",1)
   .AddParam("b",true)
   .AddParam("c","hello")
   .ExecuteScalar();

Asynchronous

End-to-end asynchronous methods suffixed with Async.

When using the SQL Client, asychronous methods are available as well as .ToTargetBlockAsync<T>(target) and .AsSourceBlockAsync<T>() Dataflow methods.

Extensions

Instead of writing this:

var myResult = new List<T>();
using(var reader = await mySqlCommand.ExecuteReaderAsync(CommandBehavior.CloseConnection))
{
   while(await reader.ReadAsync())
     list.Add(transform(reader));
}

Is now simplifed to this:

var myResult = await cmd.ToListAsync(transform);

Deferred Transformation

In order to keep connection open time to a minimum, some methods cache data before closing the connection and then subsequently applying the transformations as needed.

Results<T>() and ResultsAsync<T>()

Queues all the data. Then using the provided type T entity, the data is coerced by which properties intersect with the ones available to the IDataReader.

Optionally a field to column override map can be passed as a parameter. If a column is set as null then that field is ignored (not applied to the model).

Examples

If all the columns in the database map exactly to a field: (A column that has no associated field/property is ignored.)

var people = cmd.Results<Person>();

If the database fields don't map exactly:

var people = cmd.Results<Person>(
 (Field:"FirstName", Column:"first_name"),
 (Field:"LastName", Column:"last_name")));

or

var people = cmd.Results<Person>(
 ("FirstName", "first_name"),
 ("LastName", "last_name"));

or

var people = cmd.Results<Person>(new Dictionary<string,string>{
 {"FirstName", "first_name"},
 {"LastName", "last_name"});

Retrieve() and RetrieveAsync()

Queues all the data. Returns a QueryResult<Queue<object[]>> containing the requested data and column information. The .AsDequeueingMappedEnumerable() extension will iteratively convert the results to dictionaries for ease of access.

AsSourceBlockAsync<T>()

(Fully asynchronous.) Retuns a Dataflow source block. Then asynchronously buffers and transforms the results allowing for any possible Dataflow configuration. The source block is marked as complete when there are no more results. If the block is somehow marked as complete externally, the flow of data will stop and the connection will close.

AsSourceBlockAsync<T>() versus ResultsAsync<T>

Depending on the level of asynchrony in your application, you may want to avoid too much buffering of data.

AsSourceBlockAsync<T>() is fully asynchronous from end-to-end and can keep total buffering to a minimum by consuming (receiving) results as fast as possible, but may incur additional latency between reads.

ResultsAsync<T>() is fully asynchronous from end-to-end but returns an IEnumerable<T> that although has fully buffered the all the data into memory, has deferred the transformation until enumerated. This way, the asynchronous data pipeline is fully complete before synchronously transforming the data.

Both methods ultimately are using a Queue<object[]> or ConcurrentQueue<object[]> (Dataflow) to buffer the data, but ResultsAsync<T>() buffers the entire data set before dequeuing and transforming the results.

Transactions

Example:

	// Returns true if the transaction is successful.
	public static bool TryTransaction()
	=> ConnectionFactory.Using(connection =>
		// Open a connection and start a transaction.
		connection.ExecuteTransactionConditional(transaction => {

			// First procedure does some updates.
			var count = transaction
				.StoredProcedure("[Updated Procedure]")
				.ExecuteNonQuery();

			// Second procedure validates the results.
			// If it returns true, then the transaction is commited.
			// If it returns false, then the transaction is rolled back.
			return transaction
				.StoredProcedure("[Validation Procedure]")
				.AddParam("@ExpectedCount", count)
				.ExecuteScalar<bool>();
		}));