sqlitestore

README

sqlitestore

Gorilla's Session Store Implementation for SQLite

Installation

Run go get github.com/michaeljs1990/sqlitestore from command line. Gets installed in $GOPATH

Usage

NewSqliteStore 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

Internally, sqlitestore uses this SQLite driver.

e.g.,

  package main

  import (
    "fmt"
    "github.com/michaeljs1990/sqlitestore"
    "net/http"
  )
  
  var store sqlitestore.Sqlite
  func init() {
     var err error
     store, err = sqlitestore.NewSqliteStore("./database", "sessions", "/", 3600, []byte("<SecretKey>"))
     if err != nil {
         panic(err)
     } 
  }
  
  func sessTest(w http.ResponseWriter, r *http.Request) {
    session, err := store.Get(r, "foobar")
    session.Values["bar"] = "baz"
    session.Values["baz"] = "foo"
    err = session.Save(r, w)
    fmt.Printf("%#v\n", session)
    fmt.Println(err)
  }

func main() {
	http.HandleFunc("/", sessTest)
	http.ListenAndServe(":8080", nil)
}

Documentation

Overview

Gorilla Sessions backend for MySQL.

Copyright (c) 2013 Contributors. See the list of contributors in the CONTRIBUTORS file for details.

This software is licensed under a MIT style license available in the LICENSE file.

Index

• type SqliteStore
  • func NewSqliteStore(endpoint string, tableName string, path string, maxAge int, keyPairs ...[]byte) (*SqliteStore, error)
  • func NewSqliteStoreFromConnection(db *sql.DB, tableName string, path string, maxAge int, keyPairs ...[]byte) (*SqliteStore, error)
  • func (m *SqliteStore) Cleanup(interval time.Duration) (chan<- struct{}, <-chan struct{})
  • func (m *SqliteStore) Close()
  • func (m *SqliteStore) Delete(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
  • func (m *SqliteStore) Get(r *http.Request, name string) (*sessions.Session, error)
  • func (m *SqliteStore) New(r *http.Request, name string) (*sessions.Session, error)
  • func (m *SqliteStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
  • func (m *SqliteStore) StopCleanup(quit chan<- struct{}, done <-chan struct{})

Types

type SqliteStore

type SqliteStore struct {
	Codecs  []securecookie.Codec
	Options *sessions.Options
	// contains filtered or unexported fields
}

func NewSqliteStore

func NewSqliteStore(endpoint string, tableName string, path string, maxAge int, keyPairs ...[]byte) (*SqliteStore, error)

func NewSqliteStoreFromConnection

func NewSqliteStoreFromConnection(db *sql.DB, tableName string, path string, maxAge int, keyPairs ...[]byte) (*SqliteStore, error)

func (*SqliteStore) Cleanup

func (m *SqliteStore) 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 (*SqliteStore) Close

func (m *SqliteStore) Close()

func (*SqliteStore) Delete

func (m *SqliteStore) Delete(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

func (*SqliteStore) Get

func (m *SqliteStore) Get(r *http.Request, name string) (*sessions.Session, error)

func (*SqliteStore) New

func (m *SqliteStore) New(r *http.Request, name string) (*sessions.Session, error)

func (*SqliteStore) Save

func (m *SqliteStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

func (*SqliteStore) StopCleanup

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

StopCleanup stops the background cleanup from running.