Reversio

Entity Framework Core Reverse-Engineering Cli/Library Tool

Latest release: download HERE

Reversio is a tool designed to improve over Microsoft's somewhat limited DbContext-Scaffold reverse engineering command and offer a simple-to-execute and fully configurable solution to let you reverse engineer your Sql Server database in a fast and reliable way. It is capable to generate a full DbContext class file along with all the POCOs mapping your tables and views.

Key features:

• Settings file based: the program parses and executes a list of jobs defined in one or more json-formatted settings files; you'll keep these files versioned with your code
• Schema selection: you can choose which schema to read from; objects in non-specified schemas will be ignored
• Exclusion filters: after you have selected the schemas, you can exclude selected objects from being generated, based on type (table/view) or name (you can specify the exact object names as well as regexes)
• Custom namespace and location: to store your POCOs and your DbContext separately
• Custom class/property name transform: replace by regex, force PascalCase names (where possible), etc.
• Custom inheritance: POCOs and DbContext can extend any specified interface/class
• Support for Lazy Loading: you can generate navigation properties as virtual members
• Stubs: Reversio can create method stubs which let you inject your custom code (e.g. SPs/functions-related code)
• Views: Views can be included in your DbContext as Query types
• Indices: you can optionally include their definition in your DbContext

Supported DBMSs/ORMs

At the moment Reversio supports only Sql Server databases (tested with 2012 through 2016). The generated DbContext is tailored specifically to EF Core, but an alternate version for EF can be done too if requested.

However, as the generated POCOs carry no dependencies by default, you may use Reversio to just generate them and not the DbContext; in this way you can use the generated POCOs with any other ORM, such as Dapper.

Usage

Just launch the Console App from Powershell, CMD or the Visual Studio Console. Otherwise, you can use the core libraries programmatically.

• Help: Reversio.exe or Reversio.exe help
• Reverse Engineer: Reversio.exe [options] settings-path...
• Generate an empty json settings file sample: Reversio.exe {-e|--example}
• Options:
  • -v, --verbose: prints out more detailed processing informations

Some Json settings examples can be found in the examples folder. Detailed info about file structure, jobs, options etc. can be found on the Wiki.

Dependencies

The released Console App requires .NET Framework >= 4.6.2. Core libraries require .Net Standard 2.0.

Warning

Use at your own risk. As this application can delete/overwrite source files, it is highly recommended to use it only against source-controlled or otherwise properly backuped code.

Some commercial antiviruses can be triggered to scan the executable when you launch it, despite it being (mostly) harmless.

What's next

Planned features:

• Ship as a Visual Studio Extension
• Automatically ignore history tables connected to temporal tables
• Support for scalar/table functions and stored procedures

Possible next features:

• Support for MySql
• Support for Oracle
• Use a .dacpac as a source