sqlite

package module

v0.8.1 Latest Latest Go to latest Published: May 14, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

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

Repository

github.com/oddbit-project/blueprint

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ColumnExists(ctx context.Context, client *db.SqlClient, tableName string, columnName string) (bool, error)
func DialectOptions() *goqu.SQLDialectOptions
func GetServerVersion(db *sqlx.DB, ctx context.Context) (string, error)
func NewClient(config *ClientConfig) (*db.SqlClient, error)
func NewMigrationManager(ctx context.Context, client *db.SqlClient, opts ...SqliteMigrationOption) (migrations.Manager, error)
func TableExists(ctx context.Context, client *db.SqlClient, tableName string) (bool, error)
func ViewExists(ctx context.Context, client *db.SqlClient, tableName string) (bool, error)
type ClientConfig
- func NewClientConfig() *ClientConfig
- func (c ClientConfig) Apply(db *sqlx.DB) error
- func (c ClientConfig) Validate() error
type SqliteMigrationOption
- func WithModule(module string) SqliteMigrationOption

Constants ¶

View Source

const (
	DriverName = "sqlite"

	DefaultIdleConns          = 1
	DefaultMaxConns           = 1
	DefaultConnLifeTimeSecond = 3600
	DefaultConnIdleTimeSecond = 1800

	ErrEmptyDSN            = utils.Error("Empty DSN")
	ErrNilConfig           = utils.Error("Config is nil")
	ErrInvalidIdleConns    = utils.Error("Invalid idleConns")
	ErrInvalidMaxConns     = utils.Error("Invalid maxConns")
	ErrInvalidConnLifeTime = utils.Error("connLifeTime must be >= 1")
	ErrInvalidConnIdleTime = utils.Error("connIdleTime must be >= 1")
)

View Source

const (
	TblTypeTable = "table"
	TblTypeView  = "view"
)

View Source

const (
	MigrationTable = "db_migration"
)

Variables ¶

This section is empty.

Functions ¶

func ColumnExists ¶

func ColumnExists(ctx context.Context, client *db.SqlClient, tableName string, columnName string) (bool, error)

ColumnExists check if a column exists

func DialectOptions ¶

func DialectOptions() *goqu.SQLDialectOptions

func GetServerVersion ¶

func GetServerVersion(db *sqlx.DB, ctx context.Context) (string, error)

GetServerVersion fetch sqlite version

func NewClient ¶

func NewClient(config *ClientConfig) (*db.SqlClient, error)

func NewMigrationManager ¶

func NewMigrationManager(ctx context.Context, client *db.SqlClient, opts ...SqliteMigrationOption) (migrations.Manager, error)

func TableExists ¶

func TableExists(ctx context.Context, client *db.SqlClient, tableName string) (bool, error)

TableExists returns true if specified table exists

func ViewExists ¶

func ViewExists(ctx context.Context, client *db.SqlClient, tableName string) (bool, error)

ViewExists returns true if specified view exists

Types ¶

type ClientConfig ¶

type ClientConfig struct {
	DSN          string `json:"dsn"`
	MaxOpenConns int    `json:"maxOpenConns"`
	MaxIdleConns int    `json:"maxIdleConns"`
	ConnLifetime int    `json:"connLifetime"`
	ConnIdleTime int    `json:"connIdleTime"`
}

func NewClientConfig ¶

func NewClientConfig() *ClientConfig

func (ClientConfig) Apply ¶

func (c ClientConfig) Apply(db *sqlx.DB) error

func (ClientConfig) Validate ¶

func (c ClientConfig) Validate() error

type SqliteMigrationOption ¶

type SqliteMigrationOption func(s *sqliteMigrationManager) error

func WithModule ¶

func WithModule(module string) SqliteMigrationOption

Source Files ¶

View all Source files

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