NPrismy 1.1.4

NPrismy - A Lightweight .NET Core ORM Framework

NPrismy is lightweight ORM for ASP.NET Core Web Applications.

• Add MySql support
• Add Oracle Db support
• Add benchmark results

Table Of Contents

1. Features
2. Installation
3. Usage
4. Examples
5. Entity Specifications
6. Benchmark

Features

• Simple CRUD operations with sugar syntax.
• Using database transactions
• Customized entity mappings
• Private field mapping support
• Managing persistance concerns with a high level language

Installation

Install NPrismy NuGet package by executing following command on .NET Core CLI:

dotnet add package NPrismy

and

PM> Install-Package NPrismy on NuGet Package Manager Console.

Usage

Step by step initialization.

1) Create a Database class

Create a database class that inherited from NPrismy.Database abstract class. (i.e. CarFactoryDatabase) Database classes are represents the remote database. (Like EF DbContext)

public class WeatherForecastDatabase : NPrismy.Database
{   
}   

2) Add NPrismy support

Insert the following code to your Startup.cs ConfigureServices() method to register your database object to ServiceCollection.

services.AddNPrismy<WeatherForecastDatabase>()
        .UseProvider(PersistanceProvider.SqlServer)
        .ConnectionString("#your-connection-string#");

1. Specify the connection string by passing it to ConnectionString() method.
2. Specify the your persistance provider (SqlServer, Oracle DB, MySql) by calling UseProvider() method. (ONLY MICROSOFT SQL SERVER SUPPORTED AT THE MOMENT)

3) Specify your tables

Add EntityTable<T>properties to your database class to specify your database tables.

 public class WeatherForecastDatabase : NPrismy.Database
 {   
    public EntityTable<City> Cities { get; set; }
    public EntityTable<Forecast> Forecasts { get; set; }
 }

4) Specify table names and schemas (optional)

As default, NPrismy pluralizes the property types of database class. And assumes they are in the dbo schema. In the above example, NPrismy assumes there are two different tables named dbo.Cities and dbo.Forecasts. Regardless of the names of properties, NPrismy pluralizes the types City and Foreacast.

If you override these definitions, simply put [TableName] and [Schema] attributes as following.

public class WeatherForecastDatabase : NPrismy.Database
{  
    [TableName("MyCities")]
    [Schema("weatherForecast")]
    public EntityTable<City> Cities { get; set; }
       
    [TableName("AwesomeForecasts")]
    [Schema("weatherForecast")]
    public EntityTable<Forecast> Forecasts { get; set; }

}   

5) Do your CRUD!

Modify your controllers as accepts WeatherForecastDatabase (how you name it) and you're done. Querying data can be performed as following:

var lovelyCities = _db.Cities.Query(c => c.Name == "Istanbul" || c.Name == "Copenhagen");

Examples

Query Data

1. Querying all data from table.

var cities = await _database.Cities.Query();

2. Querying with where clause

var cities = await _database.Cities.Query(c => c.Name == 'Copenhagen');

3. Getting by primary key

var city = await _database.Cities.FindByPrimaryKey(1); //Gets the city with ID '1' (or whatever the primary key)

Insert Data

var city = new City(name: "Paris", country: "FR");
_database.Cities.Add(city);
_database.Commit(); //Don't forget to commit

Update Data

var city = await _database.Cities.FindByPrimaryKey(10);
city.Name = "Paris";
_database.Cities.Update(city);
_database.Commit();

Delete Data

1. Deleting with LINQ expression

_database.Cities.Delete(c => c.Name == "Copenhagen");
_database.Commit();

2. Deleting by Primary Key

_database.Cities.Delete(1); //Deletes the city with ID 1
_database.Commit();

Entity Specifications

Note: All these following specifications must be applied on EntityTable<T> properties of your Database class.

Specifying table name

NOTE: NPrismy pluralizes the entity type as default table name. Use this attribute only you need a different name.

Table names can be specified with [TableName] attribute. Usage example:

[TableName("people")]
public EntityTable<AbstractPerson> People { get; set; }

According to the example above, specifying the table name as people means your table name is dbo.people instead of dbo.AbstractPeople.

Specifying schema name

Schema name can be specified with [Schema] attribute. Usage example:

[Schema("usermanagement")]
public EntityTable<AbstractPerson> People { get; set; }

NOTE: NPrismy assumes dbo is the schema name as default. Use this specification only if your table schema is different from dbo.

Specifying primary key

Specify entity's primary key by using [PrimaryKey] attribute.

Usage example:

[PrimaryKey("PolicyDefinitionId")]
[TableName("policies")]
public  EntityTable<PolicyDefinition> Policies { get; set; }

NPrismy behaves the Id property of a entity as primary key as default. Use this specification only if your primary key column is different from Id.

Mapping private properties

Ignoring properties

Enabling identity insert

Benchmark Results

I will fill up here.