https://github.com/orian/pgstore
Postgres implementaiton of Gorilla/sessions.Store interface
https://github.com/orian/pgstore
Last synced: 3 months ago
JSON representation
Postgres implementaiton of Gorilla/sessions.Store interface
- Host: GitHub
- URL: https://github.com/orian/pgstore
- Owner: orian
- License: mit
- Created: 2019-08-03T11:49:18.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-03T12:37:55.000Z (almost 7 years ago)
- Last Synced: 2026-04-08T20:54:10.305Z (3 months ago)
- Language: Go
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pgstore
A session store backend for [gorilla/sessions](http://www.gorillatoolkit.org/pkg/sessions) - [src](https://github.com/gorilla/sessions).
## Installation
make get-deps
## Documentation
Available on [godoc.org](http://www.godoc.org/github.com/orian/gorilla-sessions-pgstore).
See http://www.gorillatoolkit.org/pkg/sessions for full documentation on underlying interface.
### Example
[embedmd]:# (examples/sessions.go)
```go
package examples
import (
"log"
"net/http"
"time"
"github.com/orian/pgstore"
_ "github.com/lib/pq"
)
// ExampleHandler is an example that displays the usage of PGStore.
func ExampleHandler(w http.ResponseWriter, r *http.Request) {
// Fetch new store.
store, err := pgstore.NewPGStore("postgres://user:password@127.0.0.1:5432/database?sslmode=verify-full", []byte("secret-key"))
if err != nil {
log.Fatalf(err.Error())
}
defer store.Close()
// Run a background goroutine to clean up expired sessions from the database.
defer store.StopCleanup(store.Cleanup(time.Minute * 5))
// Get a session.
session, err := store.Get(r, "session-key")
if err != nil {
log.Fatalf(err.Error())
}
// Add a value.
session.Values["foo"] = "bar"
// Save.
if err = session.Save(r, w); err != nil {
log.Fatalf("Error saving session: %v", err)
}
// Delete session.
session.Options.MaxAge = -1
if err = session.Save(r, w); err != nil {
log.Fatalf("Error saving session: %v", err)
}
}
```
## Breaking changes
* 2019-08-03 - Removed `pq` from direct dependencies, it's a caller
responsibility to import to import Postgre's driver.
* 2016-07-19 - `NewPGStore` and `NewPGStoreFromPool` now returns `(*PGStore, error)`
## Thanks
This repo is based on:
* [pgstore](https://github.com/antonlindstrom/pgstore) - base repo I've forked this from, thank you
[Anton Lindström](https://github.com/antonlindstrom).
* [redistore](https://github.com/boj/redistore)
* [mysqlstore](https://github.com/srinathgs/mysqlstore)
* [babou dbstore](https://github.com/drbawb/babou/blob/master/lib/session/dbstore.go)
Thank you all for sharing your code!
What makes this backend different is that it's for PostgreSQL.
We've recently refactored this backend to use the standard database/sql driver instead of Gorp. This removes a dependency and makes this package very lightweight and makes database interactions very transparent. Lastly, from the standpoint of unit testing where you want to mock the database layer instead of requiring a real database, you can now easily use a package like [go-SQLMock](https://github.com/DATA-DOG/go-sqlmock) to do just that.