Goo is a basic, open source Micro ORM tool which supports strongly typed entities and code-first approach.
It;
- Supports only the MSSQL right now (more to come)
- Allows you to create your data model using code-first approach
- Allows you to perform basic database operations (CRUD)
- Perform list operations in a strongly-typed manner
- Supports LINQ
- Supports caching
- Supports transaction management
- Provides you with the ability to execute inline queries
After referencing Goo Micro ORM in your project and configuring database connection properties, you can immediately start creating your own model. For the unit test environment, it's sufficient to execute the GooNorthwind.sql script in your MSSQL database
For the typed object support:
- Inherit your entities from the ModelBase abstract class.
- To let the GooContext class be generated you need to update "YOUR INFRASTRUCTURE LAYER PATH" and "YOUR MODEL LAYER PATH" fields in GooContext.tt
- You need to put the GooContext.tt class in the same place as your model layer/files.
To match properties with the database columns:
- Mark your entities with the appropriate attributes.
An example for the Categories entity:
using Goo.Attributes;
using Goo.OrmCore;
namespace Goo.UnitTest.Entities
{
public class Categories : ModelBase
{
[IsPrimaryKey]
[IsAutoIncrement(1, 1)]
public int CategoryID { get; set; }
[NVARCHAR(15)]
[NOTNULL]
public string CategoryName { get; set; }
[NTEXT]
[NULL]
public string Description { get; set; }
[IMAGE]
[NULL]
public byte[] Picture { get; set; }
}
}Supported types: BOOLEAN, DATETIME, DECIMAL, IMAGE, INT, IsAutoIncrement, IsForeignKey, IsPrimaryKey, IsRelationEntity, MONEY, NCHAR, NONCLUSTEREDINDEX, NOTNULL, NTEXT, NULL, NVARCHAR, SMALLINT, TINYINT, VARCHAR
After inheriting your entities from ModelBase abstract class and building the project Goo Micro ORM will provide you with a GooContext wrapper class
DBInitializerManager dbInitializerManager = DBInitializerManager.getInstance;
dbInitializerManager.InitializeDatabase<GooContext>();You can perform database-level operations easily using the DBInitializerManager class.
DBInitializerManager dbInitializerManager = DBInitializerManager.getInstance;
dbInitializerManager.DropTable<Categories>();
dbInitializerManager.CreateOrAlterTable<Categories>();
dbInitializerManager.TruncateTable<Categories>();Using the GooContext class you can perform basic operations like insert/update or delete an entity.
Insert an entity:
GooContext gooContext = new GooContext();
Categories category = new Categories()
{
CategoryName = "Computer",
Description = "Insert test"
};
gooContext.Categories.Insert(category);
int result = gooContext.SubmitChanges();Update an entity:
GooContex gooContext = new GooContext();
Categories category = gooContext.Categories.FirstOrDefault();
category.CategoryName = "Computer Update";
category.Description = "Update test";
gooContext.Categories.Update(category);
int result = gooContext.SubmitChanges();Delete an entity:
GooContex gooContext = new GooContext();
Categories category = gooContext.Categories.FirstOrDefault();
gooContext.Categories.Delete(category);
int result = gooContext.SubmitChanges();You can perform list, retrieve and cache operations with the GooContext class.
FirstOrDefault:
GooContext gooContext = new GooContext();
Orders order = gooContext.Orders.Where(x=>x.RequiredDate == DateTime.Now).FirstOrDefault();ToList:
GooContext gooContext = new GooContext();
List<Orders> orders = gooContext.Orders.ToList();Where:
GooContext gooContext = new GooContext();
List<Orders> orders = gooContext.Orders.Where(o => o.OrderDate > DateTime.Parse("1997-12-31") && o.ShipCountry == "Brazil").ToList();Order and Take conditions:
GooContext gooContext = new GooContext();
List<Orders> orders = gooContext.Orders.Where(o => o.OrderDate > DateTime.Parse("1997-12-31") && o.ShipCountry == "Brazil").OrderByAscending(x => x.OrderID).Take(5).ToList();Custom inline query:
GooContext gooContext = new GooContext();
var orders = gooContext.ExecuteCustomQuery(@"SELECT * FROM Orders
WHERE ShipCountry = 'Brazil' AND ShipVia = 3");AddToCache and GetFromCache conditions:
GooContext gooContext = new GooContext();
// Adds the entity to the cache (non-expiry as default)
List<Orders> ordersUntimed = gooContext.Orders.Where(o => o.OrderDate > DateTime.Parse("1997-12-31") && o.ShipCountry == "Brazil").AddToCache("AddToCacheUntimed").ToList();
// Adds the entity to the cache (Timed)
List<Orders> ordersTimed = gooContext.Orders.Where(o => o.OrderDate > DateTime.Parse("1997-12-31") && o.ShipCountry == "Brazil").AddToCache("AddToCacheTimed", CacheManager.EExpirationType.Expiration, new DateTime(2015, 6, 10)).ToList();
// Adds the entity to the cache (Sliding timed)
List<Orders> ordersSlidingTimed = gooContext.Orders.Where(o => o.OrderDate > DateTime.Parse("1997-12-31") && o.ShipCountry == "Brazil").AddToCache("AddToCacheSlidingTimed", CacheManager.EExpirationType.SlidingExpiration, new TimeSpan(1, 0, 0)).ToList();
// Allows you to get the objects from the cache. If no objects are found, returns null.
List<Orders> ordersGetFromCacheUntimed = gooContext.Orders.GetFromCache("AddToCacheUntimed"); // "AddToCacheTimed" or "AddToCacheSlidingTimed"OrmConfiguration property will allow you to perform LazyLoading and manage Connection and Transaction operations.
LazyLoading:
GooContex gooContext = new GooContext();
// Lazy loading is enabled, related objects are loaded when they are accessed through a navigation property. (false as default)
gooContext.OrmConfiguration.LazyLoadingEnabled = true;
Orders order = gooContext.Orders.FirstOrDefault();
order.Customer...?Connection:
GooContex gooContext = new GooContext();
// In case you need to reference the connection object, you need to open and manage the connection.
var connection = gooContext.OrmConfiguration.Connection; // .Open();Transaction:
GooContex gooContext = new GooContext();
using (var transaction = gooContext.OrmConfiguration.Connection.BeginTransaction())
{
// You must pass in the transaction object's reference.
gooContext.OrmConfiguration.UseTransaction(transaction);
Categories category = gooContext.Categories.FirstOrDefault();
category.Description = string.Format("{0} Updated", category.Description);
gooContext.Categories.Update(category);
int result = gooContext.SubmitChanges();
if (result > -1)
transaction.Commit();
else
transaction.Rollback();
}Performance of Select (strongly typed)
| Method | Duration | Count |
|---|---|---|
ToList() |
116ms | 500 |
Where(o => o.ShipVia == 3 && o.RequiredDate > DateTime.Parse("1996-09-01")) |
130ms | 246 |
Where(o => o.ShipName.Contains("al")) |
95ms | 87 |
Performance of Select (non-typed DBDataReader)
| Method | Duration | Count |
|---|---|---|
ExecuteCustomQuery |
76ms | 500 |
ExecuteCustomQuery("SELECT * FROM Orders WHERE ShipVia = 3 AND RequiredDate > '1996-09-01'") |
80ms | 246 |
ExecuteCustomQuery("SELECT * FROM Orders WHERE ShipName LIKE '%al%'") |
78ms | 87 |