sqlite3

Documentation

Overview

Package sqlite3 implements the sq driver for SQLite. The backing SQL driver is mattn/sqlite3.

Index

• Constants
• func DBTypeForKind(knd kind.Kind) string
• func MungeLocation(loc string) (string, error)
• func NewScratchSource(ctx context.Context, fpath string) (src *source.Source, clnup func() error, err error)
• func PathFromLocation(src *source.Source) (string, error)
• type Provider
  • func (p *Provider) DriverFor(typ drivertype.Type) (driver.Driver, error)

Constants

const (

	// Prefix is the scheme+separator value "sqlite3://".
	Prefix = "sqlite3://"
)

Functions

func DBTypeForKind

func DBTypeForKind(knd kind.Kind) string

DBTypeForKind returns the database type for kind. For example: Int --> INTEGER

func MungeLocation

func MungeLocation(loc string) (string, error)

MungeLocation takes a location argument (as received from the user) and builds a sqlite3 location URL. Each of these forms are allowed:

sqlite3:///path/to/sakila.db	--> sqlite3:///path/to/sakila.db
sqlite3:sakila.db 						--> sqlite3:///current/working/dir/sakila.db
sqlite3:/sakila.db 						--> sqlite3:///sakila.db
sqlite3:./sakila.db 					--> sqlite3:///current/working/dir/sakila.db
sqlite3:sakila.db 						--> sqlite3:///current/working/dir/sakila.db
sakila.db											--> sqlite3:///current/working/dir/sakila.db
/path/to/sakila.db						--> sqlite3:///path/to/sakila.db

The final form is particularly nice for shell completion etc.

Note that this function is OS-dependent, due to the use of pkg filepath. Thus, on Windows, this is seen:

C:/Users/sq/sakila.db 				--> sqlite3://C:/Users/sq/sakila.db

But that input location gets mangled on non-Windows OSes. This probably isn't a problem in practice, but longer-term it may make sense to rewrite MungeLocation to be OS-independent.

func NewScratchSource

func NewScratchSource(ctx context.Context, fpath string) (src *source.Source, clnup func() error, err error)

NewScratchSource returns a new scratch src. The supplied fpath must be the absolute path to the location to create the SQLite DB file, typically in the user cache dir. The returned clnup func will delete the dB file.

func PathFromLocation

func PathFromLocation(src *source.Source) (string, error)

PathFromLocation returns the absolute file path from the source location, which should have the "sqlite3://" prefix.

Types

type Provider

type Provider struct {
	Log *slog.Logger
}

Provider is the SQLite3 implementation of driver.Provider.

func (*Provider) DriverFor

func (p *Provider) DriverFor(typ drivertype.Type) (driver.Driver, error)

DriverFor implements driver.Provider.