mysqlstore

Documentation

Overview

Package mysqlstore is a MySQL-based session store for the SCS session package.

A working MySQL database is required, containing a sessions table with the definition:

CREATE TABLE sessions (
  token CHAR(43) PRIMARY KEY,
  data BLOB NOT NULL,
  expiry TIMESTAMP(6) NOT NULL
);
CREATE INDEX sessions_expiry_idx ON sessions (expiry);

The mysqlstore package provides a background 'cleanup' goroutine to delete expired session data. This stops the database table from holding on to invalid sessions forever and growing unnecessarily large.

Index

• type MySQLStore
  • func New(db *sql.DB, cleanupInterval time.Duration) *MySQLStore
  • func (m *MySQLStore) Delete(token string) error
  • func (m *MySQLStore) Find(token string) ([]byte, bool, error)
  • func (m *MySQLStore) Save(token string, b []byte, expiry time.Time) error
  • func (m *MySQLStore) StopCleanup()

Types

type MySQLStore

type MySQLStore struct {
	*sql.DB
	// contains filtered or unexported fields
}

MySQLStore represents the currently configured session session store.

func New

func New(db *sql.DB, cleanupInterval time.Duration) *MySQLStore

New returns a new MySQLStore instance.

The cleanupInterval parameter controls how frequently expired session data is removed by the background cleanup goroutine. Setting it to 0 prevents the cleanup goroutine from running (i.e. expired sessions will not be removed).

func (*MySQLStore) Delete

func (m *MySQLStore) Delete(token string) error

Delete removes a session token and corresponding data from the MySQLStore instance.

func (*MySQLStore) Find

func (m *MySQLStore) Find(token string) ([]byte, bool, error)

Find returns the data for a given session token from the MySQLStore instance. If the session token is not found or is expired, the returned exists flag will be set to false.

func (*MySQLStore) Save

func (m *MySQLStore) Save(token string, b []byte, expiry time.Time) error

Save adds a session token and data to the MySQLStore instance with the given expiry time. If the session token already exists then the data and expiry time are updated.

func (*MySQLStore) StopCleanup

func (m *MySQLStore) StopCleanup()

StopCleanup terminates the background cleanup goroutine for the MySQLStore instance. It's rare to terminate this; generally MySQLStore instances and their cleanup goroutines are intended to be long-lived and run for the lifetime of your application.

There may be occasions though when your use of the MySQLStore is transient. An example is creating a new MySQLStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the MySQLStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.