Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonwagner/Insight.Database

Fast, lightweight .NET micro-ORM
https://github.com/jonwagner/Insight.Database

Last synced: about 2 months ago
JSON representation

Fast, lightweight .NET micro-ORM

Awesome Lists containing this project

README 

        
# Insight.Database #



**Insight.Database** is a fast, lightweight, (and dare we say awesome) micro-orm for .NET. It's available as a [NuGet Package](http://www.nuget.org/packages/Insight.Database/).



Whoops. Forgot to mention easy. It's easy too. And you can also take control of pieces if you want to.



Let's say you have a database and a class and you want them to work together. Something like this:



```sql

CREATE TABLE Beer ([ID] [int], [Type] varchar(128), [Description] varchar(128)) GO

CREATE PROC InsertBeer @type varchar(128), @description varchar(128) AS

	INSERT INTO Beer (Type, Description) OUTPUT inserted.ID

		VALUES (@type, @description) GO

CREATE PROC GetBeerByType @type [varchar] AS SELECT * FROM Beer WHERE Type = @type GO

```

```c#

public class Beer

{

	public int ID { get; private set; }

	public string Type { get; set; }

	public string Description { get; set; }

}



	var beer = new Beer() { Type = "ipa", Description = "Sly Fox 113" };

```



Let's get Insight.Database:



	PM> Install-Package Insight.Database



If you have a database other than SqlServer, use one of the alternate provider packages:



```

	PM> Install-Package Insight.Database.Providers.Postgres

```



Now, wire up those stored procedures to an interface with a single `connection.As`:



```c#

public interface IBeerRepository

{

	void InsertBeer(Beer beer);

	IList GetBeerByType(string type);

	void UpdateBeerList(IList beerList);

}



var repo = connection.As();



repo.InsertBeer(beer);

IList beerList = repo.GetBeerByType("ipa");

repo.UpdateBeerList(beerList);

```



Look, ma! No mapping code! (Plus, you can now inject that interface with a DI framework or mock the interface for testing.)



Want to work at a lower level? Let's call a stored proc with an anonymous object. (It also automatically opens and closes the connection.)



```c#

// auto open/close

conn.Execute("AddBeer", new { Name = "IPA", Flavor = "Bitter"});

```



Objects are mapped automatically. No config files, no attributes. Just pure, clean magic:



```c#

// auto object mapping

Beer beer = new Beer();

conn.Execute("InsertBeer", beer);

List beers = conn.Query("FindBeer", new { Name = "IPA" });

```



Yes, even nested objects. Insight will just figure it out for you:



```c#

// auto object graphs

var servings = conn.Query("GetServings");

foreach (var serving in servings)

	Console.WriteLine("{0} {1}", serving.Beer.Name, serving.Glass.Ounces);

```



Feel free to return multiple result sets. We can handle them:



```c#

// multiple result sets

var results = conn.QueryResults("GetBeerAndChips", new { Pub = "Fergie's" }));

IList beer = results.Set1;

IList chips = results.Set2;

```



Or perhaps you want to return multiple independent recordsets, with one-to-many and one-to-one relationships. It's not possible! Or is it?



```c#

var results = conn.Query("GetLotsOfStuff", parameters,

	Query.Returns(OneToOne.Records)

		.ThenChildren(Some.Records)

		.Then(Some.Records));

var beer = results.Set1;

var glass = beer.Glass;

var napkins = beer.Napkins.ToList();

var wine = results.Set2;

```



But...but how? To that, I say: it's magic! Insight can decode the records and figure out one-to-one and parent-child relationships automatically. Almost all the time, it does this with no work or configuration on your part. But if you have a wacky model, there are plenty of non-scary ways to tell Insight how to work with your data. Read the [wiki](https://github.com/jonwagner/Insight.Database/wiki) for details.



Full async support. Just add `Async`:



```c#

var task = c.QueryAsync("FindBeer", new { Name = "IPA" });

```



Send whole lists of objects to databases that support table parameters. No more multiple queries or weird parameter mapping:



```sql

-- auto table parameters

CREATE TYPE BeerTable (Name [nvarchar](256), Flavor [nvarchar](256))

CREATE PROCEDURE InsertBeer (@BeerList [BeerTable])

```

```c#

List beerList = new List();

conn.Execute("InsertBeer", new { BeerList = beerList });

```



Insight can also stream objects over your database's BulkCopy protocol. 



```c#

// auto bulk-copy objects

IEnumerable beerList; // from somewhere

conn.BulkCopy("Beer", beerList);

```



Oh, wait. You want to inline your SQL. We do that too. Just add Sql.



```c#

var beerList = conn.QuerySql("SELECT * FROM Beer WHERE Name LIKE @Name", new { Name = "%ipa%" });

conn.ExecuteSql ("INSERT INTO Beer VALUES (ID, Name)", beer);

```



Seriously, everything just works automatically. But if you *really* want to control every aspect of mapping, see the [wiki](https://github.com/jonwagner/Insight.Database/wiki).



## Motto ##



Insight.Database is the .NET micro-ORM that nobody knows about because it's so easy, automatic, and fast, (and well-documented) that nobody asks questions about it on StackOverflow.



## Licensing ##



Insight.Database is available under any of the following licenses:



* The "Tell Everyone You Know How Awesome Insight Is" License

* The "Answer Every Stackoverflow ORM question with 'Use Insight.Database'" License

* The "Buy A Friend A Beer" License

* The "Do Some Good" (Karmic) License

* MS-Public License (Until version 5.X.X)

* MIT License (From version 6.X.X and above)



## Support Insight.Database ##



Shop through my Amazon Affiliate Link: [Amazon - Shop. Connect. Enjoy. All from Earth's Biggest Selection.](http://www.amazon.com/ref=assoc_tag_ph_1390604847723?_encoding=UTF8&camp=1789&creative=9325&linkCode=pf4&tag=jmileswagner-20)



Go ahead. You know you need to buy something anyway...



## Major Insight Releases ##



* v8.0 - Support for .NET 8.0. Note that many unpopular providers have been removed.

* v6.3 - Microsoft.Data.SqlClient compatibility, c# 8 interface default methods, cleaned up package organization.

* v6.0 - .Net Standard 2.0 compatibility. 

* v5.0 - Composite keys, Deep parameter binding. 

* v4.0 - Read one-to-one, one-to-many, and many-to-many relationships automatically, with ways to extend it.

* v3.0 - Support for most common database and tools. See [the list of supported providers](https://github.com/jonwagner/Insight.Database/wiki/Insight-and-Data-Providers).

* v2.1 - Automatically [implement an interface](https://github.com/jonwagner/Insight.Database/wiki/Auto-Interface-Implementation) with database calls.

* v2.0 - Performance and asynchronous release.

* v1.0 - Let the magic begin!



## Documentation ##



**Full documentation is available on the [wiki](https://github.com/jonwagner/Insight.Database/wiki)**