Skip to content

Mikarsoft/BlackHole-Core-ORM

Repository files navigation

A very Fast, Fully automated and easy to setup ORM that has ALL the required features:

  • Supports out of the box: SQL Server, MySql, Postgres, Oracle and SqLite.
  • Handling all the databases with the same methods.
  • Auto Create and Update Database on Startup.
  • Tables are based on the Entities.
  • Supports Autoincrement, Composite Primary Keys.
  • Has Value Generator Interface , to auto generate values on Insert.
  • Uses Property Attributes to declare, Foreign Keys , Unique constraints and more.
  • Direct Mapping Entities to DTO.
  • Methods for performing Joins on any table.
  • Interface for Default Data.
  • Using BlackHole.Core.Cli it can Parse Any Database and Generate the Entities in the app.

Find documentation here => BlackHole Documentation

Find Example Project here => BlackHole Example

Find YouTube Tutorials here => Mikarsoft YouTube

Find Nuget Package Here => versions (6.1.2 / 7.1.2 / 8.1.0-rc2)

Changes: v6.1.2 / v7.1.2 / v8.1.0-rc2 Singularity Edition

  • Bugfix Postgres adding Not Nullable Column
  • Mandatory logging on Database Update
  • Added Parsing for Default Values
  • Minor optimization on Joins

Quick Start:

  • In Your project install Black.Hole.ORM from Nuget.org

  • In your Program.cs add (Namespace => using BlackHole.Configuration) Add the following line into your IServiceCollection => services.SuperNova(settings => settings.AutomaticUpdate().AddDatabase(connection => connection.UseSqlServer(connectionString)))

  • Create some Entities in any folder that Inherit from the class 'BlackHoleEntity' for Entities that are using Integer as Id, or 'BlackHoleEntity' for Entities that are using Guid as Id or 'BlackHoleEntity' for Entities that are using SHA1 hash as Id. (Namespace => using BlackHole.Entities)

  • There is also the 'BHOpenEntity' Interface which is a more flexible and advanced Entity, with more capabilities, but slightly less performance. It is suggested to advanced Developers that want to have full control of the Entity, using Composite Keys , Autogenerated values and more..

  • Add properties on your Entities except the Id property that already exists in the BlackHoleEntity class.

  • Add Attributes to the properties of your Entities' '[ForeignKey(typeof(Entity), nullability)]' , '[NotNullable]', [Unique(int)] and '[VarCharSize(int)]'

  • You can also use '[UseActivator]' Attribute on your BlackHoleEntity, to take advantage of the 'IsActive' column in case you need to keep the data after delete. (Namespace => using BlackHole.Entities)
  • Make your services Inherit from 'BlackHoleScoped' or 'BlackHoleSingleton' or 'BlackHoleTransient' so they will be automatically registered on the Startup to the IServiceCollection. (Namespace => using BlackHole.Services)

  • Last step , go to your services or your controllers and add the Interfaces for the DataProviders => private readonly IBHDataProvider<Entity,IdType> _entityService; private readonly IBHOpenDataProvider _openEntityService; Example: IBHDataProvider<Customer,Guid> _customerService; (Namespace => using BlackHole.Core)

  • Done! You are ready to use all the functionality of the Data Providers in your services.

  • Data Providers contain all the required methods to communicate with the database.

Visit Mikarsoft Official Webpage for more Information.