mysqlstore

README

mysqlstore

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

Usage

Installation

Either:

$ go get github.com/alexedwards/scs/engine/mysqlstore

Or (recommended) use use gvt to vendor the engine/mysqlstore and session sub-packages:

$ gvt fetch github.com/alexedwards/scs/engine/mysqlstore
$ gvt fetch github.com/alexedwards/scs/session

Setup

You should have a working MySQL database 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);

Example

package main

import (
    "database/sql"
    "io"
    "log"
    "net/http"
    "time"

    "github.com/alexedwards/scs/engine/mysqlstore"
    "github.com/alexedwards/scs/session"
)

func main() {
    // Establish a database/sql pool
    db, err := sql.Open("mysql", "user:pass@/db")
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()

    // Create a new MySQLStore instance using the existing database/sql pool, 
    // with a cleanup interval of 5 minutes.
    engine := mysqlstore.New(db, 5*time.Minute)

    sessionManager := session.Manage(engine)
    http.HandleFunc("/put", putHandler)
    http.HandleFunc("/get", getHandler)
    http.ListenAndServe(":4000", sessionManager(http.DefaultServeMux))
}

func putHandler(w http.ResponseWriter, r *http.Request) {
    err := session.PutString(r, "message", "Hello world!")
    if err != nil {
        http.Error(w, err.Error(), 500)
    }
}

func getHandler(w http.ResponseWriter, r *http.Request) {
    msg, err := session.GetString(r, "message")
    if err != nil {
        http.Error(w, err.Error(), 500)
    }
    io.WriteString(w, msg)
}

Cleaning up expired session data

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

You can specify how frequently to run the cleanup when creating a new MySQLStore instance:

// Run a cleanup every 30 minutes.
mysqlstore.New(db, 30*time.Minute)

// Setting the cleanup interval to zero prevents the cleanup from being run.
mysqlstore.New(db, 0)

Terminating the cleanup goroutine

It's rare that the cleanup goroutine for a MySQLStore instance needs to be terminated. It is generally intended to be long-lived and run for the lifetime of your application.

However, there may be occasions when your use of a MySQLStore instance is transient. A common example would be using it in a short-lived 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().

For example:

func TestExample(t *testing.T) {
    db, err := sql.Open("mysql", "user:pass@/db")
    if err != nil {
        t.Fatal(err)
    }
    defer db.Close()

    engine := New(db, time.Second)
    defer engine.StopCleanup()

    // Run test...
}

Notes

The mysqlstore package is underpinned by the go-sql-driver/mysql driver.

Full godoc documentation: https://godoc.org/github.com/alexedwards/scs/engine/mysqlstore.

Documentation

Overview

Package mysqlstore is a MySQL-based storage engine 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.

Usage:

func main() {
    // Establish a database/sql pool
    db, err := sql.Open("mysql", "user:pass@/db")
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()

    // Create a new MySQLStore instance using the existing database/sql pool,
    // with a cleanup interval of 5 minutes.
    engine := mysqlstore.New(db, 5*time.Minute)

    sessionManager := session.Manage(engine)
    http.ListenAndServe(":4000", sessionManager(http.DefaultServeMux))
}

It is underpinned by the go-sql-driver/mysql driver (https://github.com/go-sql-driver/mysql).

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 storage engine.

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.

Example:

func TestExample(t *testing.T) {
	db, err := sql.Open("mysql", "user:pass@/db")
	if err != nil {
		t.Fatal(err)
	}
	defer db.Close()

	engine := mysqlstore.New(db, time.Second)
	defer engine.StopCleanup()

	// Run test...
}