Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

db

package

Go to main page

Versions in this module

v1

v1.0.6

Mar 20, 2026

v1.0.5

Mar 20, 2026

Changes in this version

+ var ErrUnsupported = errors.New("operation not supported by this provider")

+ var ValidCanonicalTypes = []string

+ func IsValidCanonicalType(t string) bool

+ func MapCanonicalType(canonical string, provider ProviderKind) string

+ func RegisterNonSQLProviderFactory(driver string, factory NonSQLProviderFactory)

+ func RegisterProviderFactory(driver string, factory ProviderFactory)

+ type AppliedMigration struct

+ AppliedAt string

+ Name string

+ Version string

+ type ColumnDef struct

+ AutoIncrement bool

+ Default string

+ Name string

+ Nullable bool

+ PrimaryKey bool

+ References string

+ Type string

+ Unique bool

+ type ColumnInfo struct

+ Default string

+ Extra string

+ Name string

+ Nullable string

+ PrimaryKey bool

+ Type string

type Connection

+ Provider Provider

+ type ConstraintInfo struct

+ Columns []string

+ Definition string

+ Name string

+ RefColumns []string

+ RefTable string

+ Type string

+ type DbStats struct

+ Extra map[string]any

+ IndexCount int

+ Provider string

+ SizeBytes int64

+ TableCount int

+ Version string

+ type IndexDef struct

+ Columns []string

+ Name string

+ Unique bool

+ type IndexInfo struct

+ Columns []string

+ Name string

+ Unique bool

type Manager

+ func (m *Manager) GetProvider(id string) (Provider, error)

+ type MigrationProvider interface

+ AppliedMigrations func(ctx context.Context) ([]AppliedMigration, error)

+ EnsureMigrationTable func(ctx context.Context) error

+ RecordMigration func(ctx context.Context, version, name string) error

+ RemoveMigration func(ctx context.Context, version string) error

+ type NonSQLProviderFactory func(dsn string) (Provider, error)

+ type Provider interface

+ AlterTableAdd func(ctx context.Context, table string, column ColumnDef) error

+ AlterTableDrop func(ctx context.Context, table string, columnName string) error

+ AlterTableRename func(ctx context.Context, table, oldCol, newCol string) error

+ Close func() error

+ CreateIndex func(ctx context.Context, table string, index IndexDef) error

+ CreateTable func(ctx context.Context, name string, columns []ColumnDef, ifNotExists bool) error

+ CreateView func(ctx context.Context, view ViewDef) error

+ DatabaseStats func(ctx context.Context) (*DbStats, error)

+ DescribeTable func(ctx context.Context, table string) ([]ColumnInfo, error)

+ DropIndex func(ctx context.Context, table, indexName string) error

+ DropTable func(ctx context.Context, name string, ifExists bool) error

+ DropView func(ctx context.Context, name string) error

+ Exec func(ctx context.Context, query string, args ...any) (int64, error)

+ Kind func() ProviderKind

+ ListConstraints func(ctx context.Context, table string) ([]ConstraintInfo, error)

+ ListIndexes func(ctx context.Context, table string) ([]IndexInfo, error)

+ ListTables func(ctx context.Context, schema string) ([]TableInfo, error)

+ ListViews func(ctx context.Context, schema string) ([]ViewInfo, error)

+ Ping func(ctx context.Context) error

+ Query func(ctx context.Context, query string, args ...any) ([]map[string]any, error)

+ TableSize func(ctx context.Context, table string) (*TableStats, error)

+ type ProviderFactory func(sqlDB *sql.DB) Provider

+ type ProviderKind string

+ const ProviderFirestore

+ const ProviderMongoDB

+ const ProviderMySQL

+ const ProviderPostgres

+ const ProviderRedis

+ const ProviderSQLite

+ type TableInfo struct

+ Name string

+ type TableStats struct

+ IndexSize int64

+ RowCount int64

+ SizeBytes int64

+ TotalSize int64

+ type ViewDef struct

+ Definition string

+ Name string

+ type ViewInfo struct

+ Definition string

+ Name string

v1.0.4

Mar 12, 2026

v1.0.2

Mar 5, 2026

v1.0.0

Mar 2, 2026

Changes in this version

+ type Connection struct

+ DB *sql.DB

+ DSN string

+ Driver string

+ ID string

+ type ConnectionInfo struct

+ DSN string

+ Driver string

+ ID string

+ type Manager struct

+ func NewManager() *Manager

+ func (m *Manager) Connect(driver, dsn string) (string, error)

+ func (m *Manager) Disconnect(id string) error

+ func (m *Manager) Exec(id, query string, args ...any) (int64, error)

+ func (m *Manager) Get(id string) (*Connection, error)

+ func (m *Manager) List() []ConnectionInfo

+ func (m *Manager) Query(id, query string, args ...any) ([]map[string]any, error)