README
¶
gormstore
A GORM based session store for SCS.
Setup
You should have a working database containing a sessions table with the definition (for PostgreSQL):
CREATE TABLE sessions (
token TEXT PRIMARY KEY,
data BYTEA NOT NULL,
expiry TIMESTAMPTZ NOT NULL
);
CREATE INDEX sessions_expiry_idx ON sessions (expiry);
For other stores you can find the setup here: MSSQL, MySQL, SQLite3.
If no table is present, a new one will be automatically created.
The database user for your application must have CREATE TABLE, SELECT, INSERT, UPDATE and DELETE permissions on this table.
Example
package main
import (
"io"
"log"
"net/http"
"github.com/alexedwards/scs/gormstore"
"github.com/alexedwards/scs/v2"
"gorm.io/driver/postgres"
"gorm.io/gorm"
)
var sessionManager *scs.SessionManager
func main() {
// Establish connection to your store.
db, err := gorm.Open(postgres.Open("postgres://username:password@host/database"), &gorm.Config{}) // PostgreSQL
// db, err := gorm.Open(sqlserver.Open("sqlserver://username:password@host?database=dbname"), &gorm.Config{}) // MSSQL
// db, err := gorm.Open(mysql.Open("username:password@tcp(host)/dbname?parseTime=true"), &gorm.Config{}) // MySQL
// db, err := gorm.Open(sqlite.Open("sqlite3_database.db"), &gorm.Config{}) // SQLite3
if err != nil {
log.Fatal(err)
}
// Initialize a new session manager and configure it to use gormstore as the session store.
sessionManager = scs.New()
if sessionManager.Store, err = gormstore.New(db); err != nil {
log.Fatal(err)
}
mux := http.NewServeMux()
mux.HandleFunc("/put", putHandler)
mux.HandleFunc("/get", getHandler)
log.Println("OK")
http.ListenAndServe(":4000", sessionManager.LoadAndSave(mux))
}
func putHandler(w http.ResponseWriter, r *http.Request) {
sessionManager.Put(r.Context(), "message", "Hello from a session!")
}
func getHandler(w http.ResponseWriter, r *http.Request) {
msg := sessionManager.GetString(r.Context(), "message")
io.WriteString(w, msg)
}
Expired Session Cleanup
This 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. By default the cleanup runs every 5 minutes. You can change this by using the NewWithCleanupInterval() function to initialize your session store. For example:
// Run a cleanup every 30 minutes.
gormstore.NewWithCleanupInterval(db, 30*time.Minute)
// Disable the cleanup goroutine by setting the cleanup interval to zero.
gormstore.NewWithCleanupInterval(db, 0)
Terminating the Cleanup Goroutine
It's rare that the cleanup goroutine 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 session store 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 session store instance from being garbage collected even after the test function has finished. You can prevent this by either disabling the cleanup goroutine altogether (as described above) or by stopping it using the StopCleanup() method. For example:
func TestExample(t *testing.T) {
db, err := gorm.Open(postgres.Open("postgres://username:password@host/dbname", &gorm.Config{}))
if err != nil {
t.Fatal(err)
}
defer db.Close()
store, err := gormstore.New(db)
if err != nil {
t.Fatal(err)
}
defer store.StopCleanup()
sessionManager = scs.New()
sessionManager.Store = store
// Run test...
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GORMStore ¶
type GORMStore struct {
// contains filtered or unexported fields
}
GORMStore represents the session store.
func New ¶
New returns a new GORMStore instance, with a background cleanup goroutine that runs every 5 minutes to remove expired session data.
func NewWithCleanupInterval ¶
NewWithCleanupInterval returns a new GORMStore 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 (*GORMStore) All ¶
All returns a map containing the token and data for all active (i.e. not expired) sessions in the GORMStore instance.
func (*GORMStore) Commit ¶
Commit adds a session token and data to the GORMStore instance with the given expiry time. If the session token already exists, then the data and expiry time are updated.
func (*GORMStore) Delete ¶
Delete removes a session token and corresponding data from the GORMStore instance.
func (*GORMStore) Find ¶
Find returns the data for a given session token from the GORMStore instance. If the session token is not found or is expired, the returned exists flag will be set to false.
func (*GORMStore) StopCleanup ¶
func (g *GORMStore) StopCleanup()
StopCleanup terminates the background cleanup goroutine for the GORMStore instance. It's rare to terminate this; generally GORMStore 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 GORMStore is transient. An example is creating a new GORMStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the GORMStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.
Source Files