database

package

v0.1.3 Latest Latest Go to latest Published: Aug 25, 2026 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gombit-dev/gombit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package database opens supported GORM SQL drivers and exposes driver metadata.

MapLoadError and MapPersistError classify GORM errors into D10 categories (not_found, conflict, internal) so generated handlers, admin, and auth share one unique-violation detector instead of three copies.

Index ¶

func IsUniqueViolation(err error) bool
func MapLoadError(ctx context.Context, err error, notFound, internal string) error
func MapPersistError(ctx context.Context, err error, conflict, internal string) error
type Capabilities
- func CapabilitiesFor(driver Driver) Capabilities
type DB
- func Open(cfg config.DatabaseConfig) (*DB, error)
type Driver

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func IsUniqueViolation ¶ added in v0.1.3

func IsUniqueViolation(err error) bool

IsUniqueViolation reports duplicate-key errors. Open does not set gorm.Config.TranslateError, so ErrDuplicatedKey is usually unset and the driver error string is the portable signal across SQLite, Postgres, and MySQL.

func MapLoadError ¶ added in v0.1.3

func MapLoadError(ctx context.Context, err error, notFound, internal string) error

MapLoadError maps a GORM read/load error to a D10 category error: record-not-found becomes not_found; any other driver failure becomes internal. Unique/duplicate is not treated as conflict on load.

func MapPersistError ¶ added in v0.1.3

func MapPersistError(ctx context.Context, err error, conflict, internal string) error

MapPersistError maps a GORM write error to a D10 category error: unique/duplicate becomes conflict; any other failure becomes internal.

Types ¶

type Capabilities ¶

type Capabilities struct {
	Transactions          bool
	Savepoints            bool
	ForeignKeyConstraints bool
	Returning             bool
	Upsert                bool
	AdvisoryLocks         bool
	ConcurrentIndexBuilds bool
}

Capabilities names behavior that differs across supported database drivers.

func CapabilitiesFor ¶

func CapabilitiesFor(driver Driver) Capabilities

CapabilitiesFor returns the capability model for driver.

type DB ¶

type DB struct {
	*gorm.DB
	// contains filtered or unexported fields
}

DB is an opened GORM database with Gombit driver metadata.

func Open ¶

func Open(cfg config.DatabaseConfig) (*DB, error)

Open opens a GORM database for a supported config.DatabaseConfig.

func (*DB) Capabilities ¶

func (db *DB) Capabilities() Capabilities

Capabilities returns the configured driver's capability flags.

func (*DB) Close ¶

func (db *DB) Close() error

Close closes the underlying database/sql handle.

func (*DB) Driver ¶

func (db *DB) Driver() Driver

Driver returns the configured driver.

func (*DB) SQLDB ¶

func (db *DB) SQLDB() (*sql.DB, error)

SQLDB returns the underlying database/sql handle.

type Driver ¶

type Driver string

Driver names a supported database driver.

const (
	// DriverSQLite identifies SQLite.
	DriverSQLite Driver = Driver(config.DatabaseDriverSQLite)
	// DriverPostgres identifies PostgreSQL.
	DriverPostgres Driver = Driver(config.DatabaseDriverPostgres)
	// DriverMySQL identifies MySQL.
	DriverMySQL Driver = Driver(config.DatabaseDriverMySQL)
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
conformance Package conformance hosts the multi-DB conformance suite.	Package conformance hosts the multi-DB conformance suite.
models Package models holds GORM fixtures for the multi-DB conformance suite.	Package models holds GORM fixtures for the multi-DB conformance suite.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL