dotnet-pgroutiner 1.0.0

PgRoutiner

.NET Core tool for easy scaffolding of your PostgreSQL server.

Make your .NET Core project to do a static type checking - on your PostgreSQL.

This tool will generate all the necessary source code files needed to make a simple execution of your PostgreSQL routines (functions or procedures):

• Simple execution - or data retrieval - in C#, sync, or async.

• All the necessary data-access code as connection object extension.

• All related model classes (or Data Transfer Object) for data retrieval operations (function returning recordset or physical table returned from a function).

You can use this tool to enforce static type checking over PostgreSQL programable routines (functions or procedures) - in your .NET Core project.

Simply add the code generation command with this tool to your pre-build event.

Or, you can simply just generate the code you need with a simple command.

It will take care of things like:

• PostgreSQL function overload for multiple versions.

• PostgreSQL array types for complex input and output.

• Serialization of results into class models faster than any standard mapping mechanism (like Dapper or EF) and without any caching. Thanks to the innovative mapping mechanism by position implemented in Norm.net data access.

Installation

.NET global tool install:

> dotnet tool install --global dotnet-pgroutiner

You will receive a message:

You can invoke the tool using the following command: PgRoutiner
Tool 'dotnet-pgroutiner' (version '1.0.0') was successfully installed.

Running

PgRoutiner

It is enough to just type PgRoutiner (case-insensitive) and it will look for .NET Core project file (.csproj) in the current directory - and start source file generation by using first available connection string in your configuration.

Or... you may supply additional configuration settings trough either:

1. Custom JSON configuration settings section PgRoutiner. It is your standard appsettings.json or appsettings.Development.json from your project. For example, to configure the connection that will be used:

{
  "PgRoutiner": {
    "Connection": "MyConnection",
  }
}

2. Standard command-line interface, by supplying command-line arguments. Example from above, to configure the connection that will be used:

pgroutiner connection=MyConnection

The command-line settings if supplied - will always override JSON configuration settings.

Configuration

• Key-values are JSON object in JSON configuration. For command-line, use following format: pgroutiner mapping:Key=Value

Examples

...

Required dependencies for project

• Npgsql
• Norm.net >= 15.1.
• System.Linq.Async (only for async operations)

Currently supported platforms

• .NET Core 3.0
• .NET Core 3.1

Support

This is open-source software developed and maintained freely without any compensation whatsoever.

If you find it useful please consider rewarding me on my effort by buying me a beer🍻 or buying me a pizza🍕

Or if you prefer bitcoin: bitcoincash:qp93skpzyxtvw3l3lqqy7egwv8zrszn3wcfygeg0mv

Licence

Copyright (c) Vedran Bilopavlović - VB Consulting and VB Software 2020 This source code is licensed under the MIT license.