Flowsy.Db.Conventions.Postgres 2.3.1

Flowsy Db Conventions Postgres

This package extends the Flowsy Db Conventions library with PostgreSQL specific conventions.

DbEnumNameTranslator

The DbEnumNameTranslator class is used to translate enum names between .NET and database. It has the following properties:

• TypeNameStyle: The style to use when converting enum type names.
• MemberNameStyle: The style to use when converting enum member names.

DbPostgresConnectionFactory

The DbPostgresConnectionFactory class is used to create connections to a PostgreSQL database. It can be instantiated using a DbPostgresConnectionFactoryOptions object that contains the following properties:

• ConnectionOptions: A dictionary of DbConnectionOptions objects.
• EnumMappings: A list of DbEnumMapping objects.
• EnumNameTranslator: A DbEnumNameTranslator object. This will be the default translator if any of the mappings do not have its own translator.

DbPostgresConnectionFactoryOptions options;
// Configure options

using var factory = new DbPostgresConnectionFactory(options);

using var connection = factory.GetConnection("MyDatabase1");

// Use the connection

Dependency Injection

Configuration

{
 "Databases": {
 "MyDatabase1": {
 "ProviderInvariantName": "Npgsql",
 "ConnectionString": "Server=pg.example.com;Database=my_database1;User Id=myuser;Password=mypassword;"
 }
 }
}

Registering the Connection Factory

// using ...

var builder = WebApplication.CreateBuilder(args);
// Register services
// ...

// Register database provider factories required by the application
DbProvider.Register("Npgsql", DbProviderFamily.PostgreSql, NpgsqlFactory.Instance);

builder.Services.AddPostgresConnectionFactory((factoryOptions, serviceProvider) =>
{
 // Obtain the configuration service
 var configuration = serviceProvider.GetRequiredService<IConfiguration>();
 
 // Get connection options from configuration
 var connectionOptions = configuration.GetConnectionOptions("Databases");
 
 // Set the connection options in the factory options
 // Each key of the connectionOptions dictionary will be used to identify
 // the connection options when asking the IDbConnectionFactory for a connection.
 factoryOptions.ConnectionOptions = connectionOptions;
 
 factoryOptions.EnumMappings =
 [
 new DbEnumMapping(typeof(UserStatus), "user_status", "security"),
 new DbEnumMapping(typeof(RoleType), "role_type", "security")
 ];
 
 factoryOptions.EnumNameTranslator = new DbEnumNameTranslator(
 typeNameStyle: CaseStyle.LowerSnakeCase,
 memberNameStyle: CaseStyle.LowerSnakeCase
 );
});