karkas code generation based .NET Framework

Database first principle

Karkas works according to database first principle. Given a database schema, karkas-codegen console application generates data application code.

Supported databases

Karkas supports following databases:

1. Sql Server
2. Oracle
3. Sqlite

Code generation

Code generation has following interfaces:

• console app (suggested)
• windows forms (Windows only)
• Asp.Net (planned)

Using above interfaces and given database schema, karkas generates following classes for every table.

• TypeLibrary/POCO Plain ordinary C#/CLR objects)
• Dal (Data Access Layer)
  • CRUD Code
  • QueryByPrimaryKey
  • QueryByForeignKey
• Bs (Business Services)
  • Transaction for multiple tables

Installation & Usage

See following tutorials:

• tutorial-sample-blog-console

How it works after code generation 1

sequenceDiagram
    Web-UI->>+Web-API: sends TypeLibrary JSON
    Web-API->>+Bs:  Call Bs Insert method with argument TypeLibrary
    Bs->>+Dal: Call Dal Insert method with argument TypeLibrary
    Dal->>+Database: Send SQL statement
    Database-->>-Dal: Send Result Back
    Dal-->>-Bs: Send Result Back
    Bs-->>-Web-API: Send Result Back
    Web-API-->>-Web-UI: Send Result Back

Loading

Requirements

Karkas currently uses and supports .Net 8/.Net 9 but generated code is usable from .NET 4, .Net Core 1-3 and .Net 6,7,8,9.

Contributing

See CONTRIBUTING file.

Running the Tests

See github actions.

• Oracle and Sql Server tests are run using docker containers.
• Sqlite tests are run on github runners itself.

Tests

• check code generation
• CRUD for tables
• Queries
• Transaction commit/rollback

Credits

...

License

Karkas is released under the BSD-3 License. See the bundled LICENSE file for details.