datafx

ajan/datafx

Overview

The datafx package is a flexible database access package that provides a unified interface for different SQL database backends. Currently, it supports PostgreSQL, MySQL, and SQLite as database backends.

The documentation below provides an overview of the package, its types, functions, and usage examples. For more detailed information, refer to the source code and tests.

Configuration

Configuration struct for the database:

type Config struct {
  Sources map[string]ConfigDatasource `conf:"SOURCES"`
}

type ConfigDatasource struct {
  Provider string `conf:"PROVIDER"`
  DSN      string `conf:"DSN"`
}

Example configuration:

config := &datafx.Config{
  Sources: map[string]datafx.ConfigDatasource{
    "default": {
      Provider: "postgres",
      DSN:      "postgres://user:pass@localhost:5432/dbname",
    },
    "readonly": {
      Provider: "mysql",
      DSN:      "mysql://user:pass@localhost:3306/dbname",
    },
  },
}

Features

• Multiple SQL database backend support (PostgreSQL, MySQL, SQLite)
• Configurable database dialects
• Managing multiple database instances
• Unit of Work pattern for transaction management
• Easy to extend for additional database backends

API

Usage

import "github.com/eser/ajan/datafx"

// Create a new PostgreSQL database instance
db, err := datafx.NewSqlDatasource(ctx, datafx.DialectPostgres, "postgres://localhost:5432/mydb")
if err != nil {
  log.Fatal(err)
}

// Get the database connection
conn := db.GetConnection()

// Use Unit of Work for transaction management
uow, err := db.UseUnitOfWork(ctx)
if err != nil {
  log.Fatal(err)
}

// Perform operations within transaction
err = uow.Execute(func(tx *sql.Tx) error {
  // Your database operations here
  return nil
})

Supported Dialects

• PostgreSQL (postgres://)
• MySQL (mysql://)
• SQLite (sqlite://)

Registry

The package includes a registry pattern for managing multiple database instances. This allows you to register and retrieve database connections by name:

// Register a database instance
err := datafx.Register("main", db)

// Get a registered database instance
db, err := datafx.Get("main")