StrongSyntax is a C# library that lets you execute ad hoc SQL queries from your data layer very easily. It lets you write your entire DAL (Data Access Layer) in one language: C#. Then, it generates the required SQL queries and runs them against your database. StongSyntax doesn't entirely replace SQL, but at least it lets you write the queries more easily.
Configuration:
// Initialize the syntax container. you can store it somewhere statically for convinience.
var syntax = new Syntax("YourConnectionString");
// Configure.
syntax.Timout = 60000; // or your desired timeout for the queries.Build the SQL query:
var items = Syntax
.GetQuery()
.Select(
"InvItems.ID"
, "InvItems.Code"
, "InvItems.Name"
, "InvItems.Description"
, "UnitOfMeasures.ID"
, "UnitOfMeasures.Name"
).From("InvItems")
.InnerJoin("UnitOfMeasures", "UnitOfMeasures.ID = InvItems.UOMID");This will generate:
SELECT
InvItems.ID
,InvItems.Code
,InvItems.Name
,InvItems.Description
,UnitOfMeasures.ID
,UnitOfMeasures.Name
FROM InvItems
INNER JOIN UnitOfMeasures
ON UnitOfMeasures.ID = InvItems.UOMIDYou can see the underlying query by calling ToString() method of the returned object. The generated query will not be executed until you execute it either with help of ADO.NET or call Read() method of the returned object. This will read the data from database and populate your POCO class with the returned dataset:
var items = Syntax
.GetQuery()
.Select(
"InvItems.ID"
, "InvItems.Code"
, "InvItems.Name"
, "InvItems.Description"
, "UnitOfMeasures.ID"
, "UnitOfMeasures.Name"
).From("InvItems")
.InnerJoin("UnitOfMeasures", "UnitOfMeasures.ID = InvItems.UOMID")
.PrepareReader<InvItem>()
.Read();
//Then use the returned collection of objects (in this case InvItem type objects).
foreach (var i in items)
{
Console.WriteLine("ID = {0}, Name = {1}", i.ID, i.Name);
}In case if you need to map you Models to ViewModels or DTOs, you can call Project() method passing it a delegate that does the mapping:
// Method that maps the Model to DTO.
private InvItemDTO MapToDTO(InvItem model)
{
InvItemDTO dto = new InvItemDTO();
dto.ID = model.ID;
dto.OnHandQty = model.OnHandQty;
if (model.UOM != null)
{
dto.UOM = new UnitOfMeasureDTO();
dto.UOM.ID = model.UOM.ID;
dto.UOM.Name = model.UOM.Name;
}
return dto;
}
// Execute the query.
var items = Syntax
.GetQuery()
.Select(
"InvItems.ID"
, "InvItems.Code"
, "InvItems.Name"
, "InvItems.Description"
, "InvItems.UnitPrice"
, "UnitOfMeasures.ID"
, "UnitOfMeasures.Name"
).From("InvItems")
.LeftJoin("UnitOfMeasures", "UnitOfMeasures.ID = InvItems.UOMID")
.Where("InvItems.UnitPrice > @0 AND InvItems.Name LIKE @1", unitPrice, "%17%")
.PrepareReader<InvItem>()
.Project(MapToDTO); //pass our method that does the mapping to the reader.Subselects:
// Prepare the subselect.
private ICompleteQuery GetSubSelect()
{
var items = Syntax
.GetQuery()
.Select(
"InvItems.ID"
, "InvItems.Code"
, "InvItems.Name"
, "InvItems.Description"
, "InvItems.UnitPrice"
).From("InvItems");
return items;
}
// Get our subselect.
var subSelect = GetSubSelect();
var items = await Syntax
.GetQuery()
.Select(
"I.ID"
, "I.Code"
, "I.UnitPrice"
).From(subSelect, "I") // Pass it to the main query with an alias that can be used in select clauseThat will generate:
SELECT
I.ID
,I.Code
,I.UnitPrice
FROM
(
SELECT
InvItems.ID
,InvItems.Code
,InvItems.Name
,InvItems.Description
,InvItems.UnitPrice
FROM InvItems
) AS IHowever, if you use the generated SQL query to read and populate your POCO classes with the help of StrongSyntax buid in database reader, that operation will fail because StrongSyntax won't be able to map the returned columns to you POCO class properties. In that case you have to do the following:
// This will work fine. You need to do this only when using subselects.
var items = await Syntax
.GetQuery()
.Select(
"I.ID AS [InvItems.ID]" // This is how we tell StrongSyntax that ID belongs to InvItem class.
, "I.Code AS [InvItems.Code]"
, "I.UnitPrice AS [InvItems.UnitPrice]"
).From(subSelect, "I")
.PrepareReader<InvItem>()
.ReadAsync();Inserting records:
var query = Syntax.GetInsert();
// This will insert a new record in InvItems table and will return the number of rows affected by the query.
var rows = query
.Insert
(
"Code"
, "Name"
, "Description"
, "Status"
).Into("InvItems")
.Values
(
"1111"
, "Name 1111"
, "Description 1111"
, 0
).Execute();This will run the following query:
exec sp_executesql
N'INSERT INTO InvItems
(
Code
,Name
,Description
,Status
)
VALUES
(
@0
,@1
,@2
,@3
)
',N'@0 nvarchar(4),@1 nvarchar(9),@2 nvarchar(16),@3 int',@0=N'1111',@1=N'Name 1111',@2=N'Description 1111',@3=0In case if you need to insert multiple records in one batch, you can do:
var query = Syntax.GetInsert();
// Prepare the insert clause
var into = query
.Insert
(
"Code"
, "Name"
, "Description"
, "Status"
).Into("InvItems");
// Add the values
for (int i = 2000; i < 2100; i++)
{
string code = i.ToString();
into = into
.Values
(
code
, "Name " + code
, "Description " + code
, 0
);
}
// This will insert 100 records into InvItems table in one batch.
var rows = into.Execute();Updates:
// Notice we use async version of this query. All the queries support async methods.
var rows = await Syntax.GetUpdate()
.Update("InvItems")
.Set(new SetClause()
{
{"Code", "1111" }
, {"Name", "Changed Name" }
, {"Description", "Changed Description" }
, {"UnitPrice", 1000.00M }
}).Where("Code = @0", "1111")
.ExecuteAsync();Deletes:
var rows = Syntax.GetDelete()
.Delete()
.From("InvItems")
.Where("Code = @0", "1111")
.Execute();All this queries have certain compile time checks to avoid any mistakes, but if you mistype a column name, or write something wrong in where clause, you won't know it unitl you run the query during the runtime. That is why we need 100% compile time checking, but that functionality is still under development.
Future goals:
// You should be able to do something like this in the future.
var items = Syntax
.GetStrongQuery<InvItem>()
.Select(i => new object[]
{
i.ID
,i.Code
,i.Name
,i.Description
,i.WarehouseItems.Sum(s => s.OnHandQty)
}).From()
.LeftJoin<UnitOfMeasure>((i, u) => i.UOMID == u.ID)
.LeftJoin<WarehouseItem>((i, w) => i.ID == w.InvItemID)
.GroupBy(i => new object[]
{
i.ID
,i.Code
,i.Name
,i.Description
});