zspitz / stringassql

Run SQL statements against ADO.NET providers without the distraction of ADO.NET objects

StringAsSql

This library enables you to use SQL statements without a mess of multiple objects and using blocks. For example, you can write this:

// setup ConnectionFactory -- not shown
// optionally, setup ParameterNameBuilder -- not shown

List<Person> persons = "SELECT * FROM Persons WHERE LastName LIKE ? + '%'".AsSql("An").ToList<Person>();

instead of this:

var persons = new List<Person>();
using (var conn = new OleDbConnection(connectionString)) {
    conn.Open();
    var cmd = conn.CreateCommand();
    cmd.CommandText = "SELECT * FROM Persons WHERE LastName LIKE ? + '%'";
    cmd.Parameters.Add(
        new OleDbParameter("Parameter1", "An")
    );
    using (var rdr = cmd.ExecuteReader()) {
        while (rdr.Read()) {
            persons.Add(
                new Person {
                    ID = (int)rdr["ID"],
                    LastName = (string)rdr["LastName"],
                    FirstName = (string)rdr["FirstName"]
                }
            );
        }
    }
}

Setting up the ConnectionFactory

Before using the .AsSql method, or creating an instance of SqlString, set the global ConnectionFactory:

// using System.Data.OleDb;
// using static StringAsSql.SqlString;

// Define a connection string against an Access database
var connectionString = new OleDbConnectionStringBuilder {
    // ...
}.ToString();
ConnectionFactory = () => new OleDbConnection(connectionString);

See the wiki for more information.

Some more examples:

Create a table:

@"CREATE TABLE Persons (
  ID COUNTER PRIMARY KEY, 
  LastName TEXT,
  FirstName TEXT
)".AsSql().Execute();

Insert rows using parameters, via a collection of values:

var insertSql = "INSERT INTO Persons (FirstName, LastName) VALUES (?, ?)";
insertSql.AsSql(new [] {"Artie", "Choke"}).Execute();
insertSql.AsSql(new [] {"Anna", "Lytics"}).Execute();
insertSql.AsSql(new [] {"Gerry", "Atric"}).Execute();

Get a scalar value:

int count = "SELECT COUNT(*) FROM Persons".AsSql().ExecuteScalar<int>();

Get a list of objects, using a TableDirect command type:

// using static System.Data.CommandType;
List<Person> persons = "Persons".AsSql(TableDirect).ToList<Person>();

stringassql's Issues

Create tests that ensure connection, reader, adapter, command are disposed even in case of an exception

Transactions

1. If an SQL statement should be executed on a specific transaction, where should it go in the argument list?
2. Do we need to check that the transaction and connection match? both that their types match, and that the transaction is on the given connection?

Probably have an overload that takes a ref IDbTransaction, and if the argument is null, begin a new transaction.

Transaction rollback / commit is left up to the calling code.

What about TransactionScope?

Async support

ConnectionFactory may change between creation of SqlString and use of its methods

Perhaps SqlString should store a reference to ConnectionFactory at the time of its creation?

Tests using server-based database

Create a new test project for which tests will only execute on appveyor
Inverse of regular tests -- will build only in the ReleaseCI configuration, not the Debug or Release configurations.

SQL Server? MySQL?

Allow passing in an explicit parameter object

Allow returning a List<dynamic>

The same behavior should happen when the type parameter is object -- return a List<ExpandoObject> with the relevant properties set.