sqldb

Documentation

Overview

Package sqldb interfaces the Katzenpost server with a SQL database.

Index

• type SQLDB
  • func New(glue glue.Glue) (*SQLDB, error)
  • func (d *SQLDB) Close()
  • func (d *SQLDB) IsSpoolOnly() bool
  • func (d *SQLDB) Spool() spool.Spool
  • func (d *SQLDB) UserDB() (userdb.UserDB, error)

Types

type SQLDB

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

SQLDB is a SQL database instance.

func New

func New(glue glue.Glue) (*SQLDB, error)

New constructs a new SQLDB instance.

func (*SQLDB) Close

func (d *SQLDB) Close()

Close closes the SQL database connection(s).

func (*SQLDB) IsSpoolOnly

func (d *SQLDB) IsSpoolOnly() bool

IsSpoolOnly returns true iff the database is configured to only support acting as a user message spool.

func (*SQLDB) Spool

func (d *SQLDB) Spool() spool.Spool

Spool returns a spool.Spool instance backed by the SQL database.

func (*SQLDB) UserDB

func (d *SQLDB) UserDB() (userdb.UserDB, error)

UserDB returns a userdb.UserDB instance backed by the SQL database.