Skip to content
This repository has been archived by the owner. It is now read-only.
Lightweight code-first ORM for SQL Server or MySQL based on Dapper
C#
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
MergeUI
Postulate.Lite.Core
Postulate.Lite.MySql
Postulate.Lite.SqlServer
Tests
.gitattributes
.gitignore
LICENSE
Postulate.Lite.sln
README.md

README.md

Postulate.Lite ORM

Build status

Note: I am moving all development to the Postulate repo in order to target .NET Standard 2.0.

Postulate.Lite is a code-first ORM built around Dapper that performs CRUD operations on your model types. It's an evolution of my Postulate.Orm project that is

Postulate.Lite is not a Linq replacement. In my applications, I use inline SQL with Postulate.Lite's Query<T> type. Please see the wiki page on this.

Check out my Medium.com post, which has more background.

Nuget

  • SQL Server package: Postulate.Lite.SqlServer
  • MySql package: Postulate.Lite.MySql

How to Use

  • Create any number of model classes that correspond to your database tables. They can be POCO, but added functionality is available if you inherit from Postulate.Lite.Core.Record. The only design requirement for Postulate.Lite model classes is that either they have an [Identity] attribute that defines the primary key property, or they have a property called Id with no particular attribute decoration. You can also use the [PrimaryKey] attribute on select properties to define an explicit primary key -- of either one or multiple properties.

  • Use the [References] attribute to define foreign keys on properties.

  • For Sql Server, Postulate.Lite supports int, Guid, and long identity types. MySql currently supports int. When creating your model classes, decide on an identity type and be consistent across all your model classes.

  • Open your IDbConnection object in whatever way is appropriate for your application, normally within a using block.

  • Use any of the Postulate.Lite Crud extension methods of IDbConnection: Find, FindWhere, Save, Insert, Update, Delete, Exists, and ExistsWhere. They all accept a TModel generic argument corresponding to your model class. In the SQL Server package, there are three different namespaces with a static ConnectionExtensions class that provides the crud methods: Postulate.Lite.SqlServer.IntKey, LongKey, and GuidKey, so use the namespace appropriate to the identity type you chose above.

  • All of the Crud methods accept an IUser optional argument you can use to pass the current user name and access to the user's local time. This argument takes effect if your model class is based on Record (see above), which offers a number of overrides for checking permissions and executing row-level events, looking up foreign keys, among other things.

Code-first Migration

There are two ways to merge your model class code to a database:

  • Use the free command line tool available here. This tool merges only from C# to SQL Server, not from database to database.

  • Use my commercial GUI app SQL Model Merge. There's more product info and a demo video at that link.

Examples

A simple find using the Find method:

using (var cn = GetConnection())
{
  var e = cn.Find<Employee>(2322);
  Console.WriteLine(e.FirstName);
}

Find using criteria with the FindWhere method:

using (var cn = GetConnection())
{
  var e = cn.FindWhere(new { OrganizationId = 12, Number = 3988 });
  Console.WriteLine(e.FirstName);
}

Create and save a record with the Save method.

using (var cn = GetConnection())
{
  var e = new Employee()
  {
    FirstName = "Thomas",
    LastName = "Whoever",
    HireDate = new DateTime(2012, 1, 1)
  };
  cn.Save<Employee>(e);
  Console.WriteLine(e.Id.ToString());
}

Extending Postulate.Lite

To implement Postulate.Lite for a particular database, inherit from abstract class CommandProvider<TKey> and implement its various abstract methods that generate SQL for Crud actions. The TKey generic argument specifies the identity (primary key) type used with your model classes. The default MySQL implementation assumes an int primary key type. To implement long or Guid primary key types, you'd need to derive a new class from CommandProvider with your desired key type.

You can’t perform that action at this time.