mysql

Documentation

Index

• Constants
• Variables
• func New(cfg *Options) sessions.Store
• func Reg(store sessions.Store, args ...string)
• func RegWithOptions(opts *Options, args ...string) sessions.Store
• type MySQLStore
  • func NewMySQLStore(cfg *Options) (*MySQLStore, error)
  • func NewMySQLStoreFromConnection(db *sql.DB, cfg *Options) (*MySQLStore, error)
  • func (m *MySQLStore) Cleanup(interval time.Duration) (chan<- struct{}, <-chan struct{})
  • func (m *MySQLStore) Close() (err error)
  • func (m *MySQLStore) Delete(ctx echo.Context, session *sessions.Session) error
  • func (m *MySQLStore) Get(ctx echo.Context, name string) (*sessions.Session, error)
  • func (m *MySQLStore) Init()
  • func (n *MySQLStore) MaxAge(ctx echo.Context) int
  • func (m *MySQLStore) New(ctx echo.Context, name string) (*sessions.Session, error)
  • func (m *MySQLStore) Reload(ctx echo.Context, session *sessions.Session) error
  • func (m *MySQLStore) Remove(sessionID string) error
  • func (m *MySQLStore) Save(ctx echo.Context, session *sessions.Session) error
  • func (m *MySQLStore) StopCleanup(quit chan<- struct{}, done <-chan struct{})
• type Options

Constants

const DDL = "CREATE TABLE IF NOT EXISTS %s (" +
	"	`id` char(64) NOT NULL," +
	"	`data` longblob NOT NULL," +
	"	`created` int(11) unsigned NOT NULL DEFAULT '0'," +
	"	`modified` int(11) unsigned NOT NULL DEFAULT '0'," +
	"	`expires` int(11) unsigned NOT NULL DEFAULT '0'," +
	"	PRIMARY KEY (`id`)" +
	"  ) ENGINE=InnoDB;"

Variables

var DefaultInterval = time.Minute * 5

var (
	DefaultKeyPrefix = `_`
)

Functions

func New

func New(cfg *Options) sessions.Store

func Reg

func Reg(store sessions.Store, args ...string)

func RegWithOptions

func RegWithOptions(opts *Options, args ...string) sessions.Store

Types

type MySQLStore

type MySQLStore struct {
	Codecs []securecookie.Codec
	// contains filtered or unexported fields
}

func NewMySQLStore

func NewMySQLStore(cfg *Options) (*MySQLStore, error)

NewMySQLStore takes the following paramaters endpoint - A sql.Open style endpoint tableName - table where sessions are to be saved. Required fields are created automatically if the table doesnot exist. path - path for Set-Cookie header maxAge codecs

func NewMySQLStoreFromConnection

func NewMySQLStoreFromConnection(db *sql.DB, cfg *Options) (*MySQLStore, error)

NewMySQLStoreFromConnection .

func (*MySQLStore) Cleanup

func (m *MySQLStore) Cleanup(interval time.Duration) (chan<- struct{}, <-chan struct{})

Cleanup runs a background goroutine every interval that deletes expired sessions from the database.

The design is based on https://github.com/yosssi/boltstore

func (*MySQLStore) Close

func (m *MySQLStore) Close() (err error)

func (*MySQLStore) Delete

func (m *MySQLStore) Delete(ctx echo.Context, session *sessions.Session) error

func (*MySQLStore) Get

func (m *MySQLStore) Get(ctx echo.Context, name string) (*sessions.Session, error)

func (*MySQLStore) Init

func (m *MySQLStore) Init()

func (*MySQLStore) MaxAge

func (n *MySQLStore) MaxAge(ctx echo.Context) int

func (*MySQLStore) New

func (m *MySQLStore) New(ctx echo.Context, name string) (*sessions.Session, error)

func (*MySQLStore) Reload

func (m *MySQLStore) Reload(ctx echo.Context, session *sessions.Session) error

func (*MySQLStore) Remove

func (m *MySQLStore) Remove(sessionID string) error

func (*MySQLStore) Save

func (m *MySQLStore) Save(ctx echo.Context, session *sessions.Session) error

func (*MySQLStore) StopCleanup

func (m *MySQLStore) StopCleanup(quit chan<- struct{}, done <-chan struct{})

StopCleanup stops the background cleanup from running.

type Options

type Options struct {
	Config        dbconfig.Config `json:"-"`
	Table         string          `json:"table"`
	KeyPairs      [][]byte        `json:"-"`
	MaxAge        int             `json:"maxAge"`
	CheckInterval time.Duration   `json:"checkInterval"`
}