README
¶
mysqlstore
Gorilla's Session Store Implementation for Sqlx
Installation
Run go get github.com/mbetel/mysqlxstore from command line. Gets installed in $GOPATH
Usage
NewMysqlxStore takes the following paramaters
endpoint - A sqlx.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, mysqlxstore uses this MySQL driver.
e.g.,
package main
import (
"fmt"
"github.com/mbetel/mysqlxstore"
"net/http"
)
var store *mysqlstore.MySQLXStore
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() {
var err error
store, err = mysqlstore.NewMySQLXStore("UN:PASS@tcp(<IP>:<PORT>)/<DB>?parseTime=true&loc=Local", <tablename>, "/", 3600, []byte("<SecretKey>"))
if err != nil {
panic(err)
}
defer store.Close()
http.HandleFunc("/", sessTest)
http.ListenAndServe(":8080", nil)
}
Documentation
¶
Index ¶
- type MySQLXStore
- func (m *MySQLXStore) Cleanup(interval time.Duration) (chan<- struct{}, <-chan struct{})
- func (m *MySQLXStore) Close()
- func (m *MySQLXStore) Delete(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
- func (m *MySQLXStore) Get(r *http.Request, name string) (*sessions.Session, error)
- func (m *MySQLXStore) New(r *http.Request, name string) (*sessions.Session, error)
- func (m *MySQLXStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
- func (m *MySQLXStore) StopCleanup(quit chan<- struct{}, done <-chan struct{})
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MySQLXStore ¶
type MySQLXStore struct {
Codecs []securecookie.Codec
Options *sessions.Options
// contains filtered or unexported fields
}
func NewMySQLXStore ¶
func (*MySQLXStore) Cleanup ¶
func (m *MySQLXStore) 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 (*MySQLXStore) Close ¶
func (m *MySQLXStore) Close()
func (*MySQLXStore) Delete ¶
func (m *MySQLXStore) Delete(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
func (*MySQLXStore) Save ¶
func (m *MySQLXStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
func (*MySQLXStore) StopCleanup ¶
func (m *MySQLXStore) StopCleanup(quit chan<- struct{}, done <-chan struct{})
StopCleanup stops the background cleanup from running.
Source Files
Click to show internal directories.
Click to hide internal directories.