sqliteStorage

Documentation

Index

• Variables
• func InitSchema(conn conn, pageSize int, triggers bool) error
• func NewDirectStorage(opts NewDirectStorageOpts) (_ storage.ClientImplCloser, err error)
• func NewPiecesStorage(opts NewPiecesStorageOpts) (_ storage.ClientImplCloser, err error)
• func NewProvider(pool ConnPool, opts ProviderOpts) (_ *provider, err error)
• func SetCapacity(conn conn, cap int64) error
• func UnlimitCapacity(conn conn) error
• type ConnPool
  • func NewPool(opts NewPoolOpts) (_ ConnPool, err error)
• type InitConnOpts
  • func (me InitConnOpts) JournalMode() string
• type InitDbOpts
• type InitPoolOpts
• type NewConnOpts
• type NewDirectStorageOpts
• type NewPiecesStorageOpts
• type NewPoolOpts
• type PoolConf
• type ProviderOpts

Variables

var UnexpectedJournalMode = errors.New("unexpected journal mode")

Functions

func InitSchema

func InitSchema(conn conn, pageSize int, triggers bool) error

func NewDirectStorage

func NewDirectStorage(opts NewDirectStorageOpts) (_ storage.ClientImplCloser, err error)

A convenience function that creates a connection pool, resource provider, and a pieces storage ClientImpl and returns them all with a Close attached.

func NewPiecesStorage

func NewPiecesStorage(opts NewPiecesStorageOpts) (_ storage.ClientImplCloser, err error)

A convenience function that creates a connection pool, resource provider, and a pieces storage ClientImpl and returns them all with a Close attached.

func NewProvider

func NewProvider(pool ConnPool, opts ProviderOpts) (_ *provider, err error)

Needs the ConnPool size so it can initialize all the connections with pragmas. Takes ownership of the ConnPool (since it has to initialize all the connections anyway).

func SetCapacity

func SetCapacity(conn conn, cap int64) error

Set the capacity limit to exactly this value.

func UnlimitCapacity

func UnlimitCapacity(conn conn) error

Remove any capacity limits.

Types

type ConnPool

type ConnPool interface {
	Get(context.Context) conn
	Put(conn)
	Close() error
	NumConns() int
}

func NewPool

func NewPool(opts NewPoolOpts) (_ ConnPool, err error)

type InitConnOpts

type InitConnOpts struct {
	SetSynchronous string
	SetJournalMode string
	MmapSizeOk     bool  // If false, a package-specific default will be used.
	MmapSize       int64 // If MmapSizeOk is set, use sqlite default if < 0, otherwise this value.
}

func (InitConnOpts) JournalMode

func (me InitConnOpts) JournalMode() string

type InitDbOpts

type InitDbOpts struct {
	DontInitSchema bool
	PageSize       int
	// If non-zero, overrides the existing setting.
	Capacity   int64
	NoTriggers bool
}

type InitPoolOpts

type InitPoolOpts struct {
	NumConns int
	InitConnOpts
}

type NewConnOpts

type NewConnOpts struct {
	// See https://www.sqlite.org/c3ref/open.html. NB: "If the filename is an empty string, then a
	// private, temporary on-disk database will be created. This private database will be
	// automatically deleted as soon as the database connection is closed."
	Path   string
	Memory bool
	// Whether multiple blobs will not be read simultaneously. Enables journal mode other than WAL,
	// and NumConns < 2.
	NoConcurrentBlobReads bool
}

type NewDirectStorageOpts

type NewDirectStorageOpts struct {
	NewConnOpts
	InitDbOpts
	InitConnOpts
	GcBlobs           bool
	CacheBlobs        bool
	BlobFlushInterval time.Duration
}

type NewPiecesStorageOpts

type NewPiecesStorageOpts struct {
	NewPoolOpts
	InitDbOpts
	ProvOpts    func(*ProviderOpts)
	StorageOpts func(*storage.ResourcePiecesOpts)
}

type NewPoolOpts

type NewPoolOpts struct {
	NewConnOpts
	InitConnOpts
	NumConns int
}

type PoolConf

type PoolConf struct {
	NumConns    int
	JournalMode string
}

There's some overlap here with NewPoolOpts, and I haven't decided what needs to be done. For now, the fact that the pool opts are a superset, means our helper NewPiecesStorage can just take the top-level option type.

type ProviderOpts

type ProviderOpts struct {
	BatchWrites bool
}