qlstore

Documentation

Overview

Package qlstore is a ql-based session store for the SCS session package.

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

CREATE TABLE sessions (
	token string,
	data blob,
	expiry time
)
CREATE INDEX sessions_expiry_idx ON sessions (expiry);

The qlstore 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.

Index

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

Functions

func Table

func Table() string

Table provides SQL for creating a session table in ql database

Types

type QLStore

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

QLStore represents the currently configured session session store.

func New

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

New returns a new QLStore 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 (*QLStore) Delete

func (q *QLStore) Delete(token string) error

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

func (*QLStore) Find

func (q *QLStore) Find(token string) ([]byte, bool, error)

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

func (*QLStore) Save

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

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

func (*QLStore) StopCleanup

func (q *QLStore) StopCleanup()

StopCleanup terminates the background cleanup goroutine for the QLStore instance. It's rare to terminate this; generally QLStore 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 QLStore is transient. An example is creating a new QLStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the QLStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.