Norm

🚀 Norm

Ultra fast, safe (SQL Injection protected) multi threads/tasks (no locking SessionManager) .Net Database framework.

✨ Features

Norm is stands for Not an ORM is a C# lib for very HIGH Speed DB data processing in async way with immediately operations and at background with Processing data with Batches. It at least 10 times faster then EF/EF.Core. In Comparison to ORMs Norm has following disadvantages:

1. No object tracking
2. No Lazy loading properties
3. No Reflection usage

But it gives us the following:

1. Read speed is ultra fast (500000 rows select from 1000000 rows in non-tuned (default) Mysql database ~10 ms)

Table size (rows)	Rows to select	Time, ms
100k	10k	5
100k	10k in a middle	5
1M	20k	7
1M	100k	8
1M	500k	9

1. Insert speed is fast (10000 rows ~ 600 ms, 100000 rows ~ 3000-5000 ms on i5 CPU for MySql 8.0.23 with default settings)

Rows to insert	Time, ms
100	13
1000	62
10000	549
100000	5111

1. Can work with DB in multiple threads unlike do all ORMs
2. Support BULK operations
3. Can synchronize data in background (for quite big operations, truly async behavior)
4. Can be used in CQRS approach because works in own thread and uses multiple tasks.
5. All modification operations (Create, Update and Delete) are using DB Transactions.

How to use

Norm works with persistant entities (table mapping or aggregate to multiple tables) via Repository interface IDbRepository<T> (T is a generic type of persistant object, i.e. User). Norm has following implementation of IDbRepository<T> interface:

1. MySqlBufferedRepository<T> for MySql DB server, it implements BufferedDbRepository<T>
2. SqlServerBufferedRepository<T> for SqlServer DB server, it implements BufferedDbRepository<T>
3. ` PostgresBufferedRepository` for `Postgres` DB server, it implements `BufferedDbRepository`
4. SqLiteBufferedRepository<T> for SqLite DB server, it implements BufferedDbRepository<T>

Consider how to use it on MySql Db:

1. Add the appropriate package; see the section below
2. Create a IDbRepository<T> instance as follows:

    DbRepositorySettings dbRepositorySettings = new DbRepositorySettings()
    {
        BufferThreshold = 100,
        CommandTimeout = 120,
        BufferSynchronizationDelayTimeout = 100,
        ForceSynchronizationBufferDelay = 500
    };
    IDbRepository<PhysicalValueEntity> repo = new MySqlBufferedRepository<PhysicalValueEntity>(ConnectionString, dbRepositorySettings,
                                                                                               new PhysicalValueQueryBuilder(),
                                                                                               PhysicalValueFactory.Create, new NullLoggerFactory());
   

Contructor expect following params:

• DB connection string
• Repository settings:
  • BufferThreshold size of buffer (creainge or updainge entities) to sync
  • Timeout of executing command in seconds
  • BufferSynchronizationDelayTimeout time in ms between background synchronization iterations attempts
  • ForceSynchronizationBufferDelay timeout for sync if amount of items to create/update < BufferThreshold
• query builder that implements interface IDbEntityQueryBuilder<TE> (see example in tests)
• factory that builds Entity from array of column values (see also tests)
• logger factory

1. Read Entities 3.1 Without filtering

   IList<PhysicalValueEntity> items = await repo.GetManyAsync(page, size, new List<WhereParameter>(), null);
   

   3.2 With filtering

      IList<PhysicalValueEntity> items = await repo.GetManyAsync(page, size, new List<WhereParameter>()
      {
      new WhereParameter("id", null, false, WhereComparison.Greater, new List<object>(){lowerIdValue}, false),
      new WhereParameter("id", WhereJoinCondition.And, false, WhereComparison.Less, new List<object>(){upperIdValue}, false)
      }, null);
   

2. Create Entity 4.1 Single

    PhysicalValueEntity entity = new PhysicalValueEntity()
    {
        Id = id,
        Name = "new phys value",
        Description = "new phys value",
        Designation = "NPV"
     };
     bool result = await repo.InsertAsync(entity, true);
   

   The last insert method param is responsible for inserting into the Repository task in the background if false or immediately if true 4.2 Bulk

    IList<PhysicalValueEntity> newPhysValues = new List<PhysicalValueEntity>()
    {
        new PhysicalValueEntity()
        {
            Id = 30,
            Name = "new phys value",
            Description = "new phys value",
            Designation = "NPV"
         },
         new PhysicalValueEntity()
         {
             Id = 31,
             Name = "new phys value2",
             Description = "new phys value2",
             Designation = "NPV2"
          },
          new PhysicalValueEntity()
          {
              Id = 32,
              Name = "new phys value3",
              Description = "new phys value3",
              Designation = "NPV3"
          }
     };
     int result = await repo.BulkInsertAsync(newPhysValues, true);
   

3. Update and bulk update are analogous to create methods:
4. Delete is quite a simple:

    bool result = await repo.DeleteAsync(new List<WhereParameter>()
    {
        new WhereParameter("id", null, false, WhereComparison.Equal, new List<object>(){newPhysValue.Id})
    });
   

📦 Nuget

1. Interface
2. Mysql
3. Postgres
4. SqlServer
5. SqLite

🔤 Changes

1. Version 0.1.0 Read and Insert (including Bulk Insert) operations were implemented with a MySql support only
2. Version 0.2.0 Update and Bulk Update operations support was added with a MySql support only
3. Version 0.5.0 Delete operation support was added with a MySql support only
4. Version 0.6.0 Some benchamarks tests were added with a MySql support only
5. Version 0.7.0 All functional tests were added to check all tests performed on a MySql support only
6. Version 0.8.0 PostgreSQL support was added
7. Version 0.9.0 SqlServer and SQLite support was added
8. Version 1.0.0 a Nuget packages were issued 10.Version 2.0.0 were added configurations and interface WhereParameter was used instead of Dictionary<string,string> 11.Version 2.0.0 minor patch fixes 12.Version 3.0.0 Used DbCommand instead of Raw SQL in BufferedDbRepository and added protection against SQL Injection

🤝 Contributors

This site is open source. Improve this page.