sqlite_modernc

Documentation

Overview

Package sqlite_modernc provides SQLite database connection and migration utilities using the modernc.org/sqlite driver.

Index

• type Config
• type Connection
  • func NewConnection(cfg Config) (*Connection, error)
  • func (c *Connection) Close() error
  • func (c *Connection) Config() Config
  • func (c *Connection) Ping(ctx context.Context) error
  • func (c *Connection) ReadDB() *sqlx.DB
  • func (c *Connection) WriteDB() *sqlx.DB

Types

type Config

type Config struct {
	URI             string
	Timeout         time.Duration
	MaxIdleConns    int
	MaxIdleTime     time.Duration
	MaxConnLifetime time.Duration
	AutoMigrate     bool
	MigrationsFS    fs.FS
	MigrationsPath  string
}

Config holds the configuration for the SQLite connection.

type Connection

type Connection struct {
	// contains filtered or unexported fields
}

Connection represents the database connection.

func NewConnection

func NewConnection(cfg Config) (*Connection, error)

NewConnection creates a new SQLite connection.

func (*Connection) Close

func (c *Connection) Close() error

Close closes the database connections.

func (*Connection) Config

func (c *Connection) Config() Config

Config returns a copy of the connection configuration.

func (*Connection) Ping

func (c *Connection) Ping(ctx context.Context) error

Ping checks the database connection.

func (*Connection) ReadDB

func (c *Connection) ReadDB() *sqlx.DB

ReadDB returns the read database connection.

func (*Connection) WriteDB

func (c *Connection) WriteDB() *sqlx.DB

WriteDB returns the write database connection.