go/scs
1
0
Fork 0
mirror of https://github.com/alexedwards/scs.git synced 2025-07-17 01:12:21 +02:00
Code Issues Releases Activity

Merge pull request #213 from rmmh/readme-store-documentation

Browse Source 
docs: expand table of built-in stores with more details
This commit is contained in:
Alex Edwards
2025-02-05 22:40:10 +01:00
committed by GitHub
parent fe56723ef1 01a88cfc91
commit adc38a57e9
1 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -149,26 +149,26 @@ By default SCS uses an in-memory store for session data. This is convenient (no
The session stores currently included are shown in the table below. Please click the links for usage instructions and examples. The session stores currently included are shown in the table below. Please click the links for usage instructions and examples.
| Package | | | Package | Backend | Embedded | In-Memory | Multi-Process |
| :---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | :---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------|----------|-----------|---------------|
| [badgerstore](https://github.com/alexedwards/scs/tree/master/badgerstore) | Badger based session store | | [badgerstore](https://github.com/alexedwards/scs/tree/master/badgerstore) | [BadgerDB](https://dgraph.io/docs/badger/) | Y | N | N |
| [boltstore](https://github.com/alexedwards/scs/tree/master/boltstore) | Bolt based session store | | [boltstore](https://github.com/alexedwards/scs/tree/master/boltstore) | [BBolt](https://go.etcd.io/bbolt) | Y | N | N |
| [bunstore](https://github.com/alexedwards/scs/tree/master/bunstore) | Bun based session store | | [bunstore](https://github.com/alexedwards/scs/tree/master/bunstore) | [Bun](https://bun.uptrace.dev/) ORM for PostgreSQL/MySQL/MSSQL/SQLite | N | N | Y |
| [buntdbstore](https://github.com/alexedwards/scs/tree/master/buntdbstore) | BuntDB based session store | | [buntdbstore](https://github.com/alexedwards/scs/tree/master/buntdbstore) | [BuntDB](https://github.com/tidwall/buntdb) | Y | Y | N |
| [cockroachdbstore](https://github.com/alexedwards/scs/tree/master/cockroachdbstore) | CockroachDB based session store | | [cockroachdbstore](https://github.com/alexedwards/scs/tree/master/cockroachdbstore) | [CockroachDB](https://www.cockroachlabs.com/) | N | N | Y |
| [consulstore](https://github.com/alexedwards/scs/tree/master/consulstore) | Consul based session store | | [consulstore](https://github.com/alexedwards/scs/tree/master/consulstore) | [Consul](https://www.consul.io/) | N | Y | Y |
| [etcdstore](https://github.com/alexedwards/scs/tree/master/etcdstore) | Etcd based session store | | [etcdstore](https://github.com/alexedwards/scs/tree/master/etcdstore) | [Etcd](https://etcd.io/) | N | N | Y |
| [firestore](https://github.com/alexedwards/scs/tree/master/firestore) | Google Cloud Firestore based session store | | [firestore](https://github.com/alexedwards/scs/tree/master/firestore) | [Google Cloud Firestore](https://cloud.google.com/firestore) | N | ? | Y |
| [gormstore](https://github.com/alexedwards/scs/tree/master/gormstore) | GORM based session store | | [gormstore](https://github.com/alexedwards/scs/tree/master/gormstore) | [GORM](https://gorm.io/index.html) ORM for PostgreSQL/MySQL/SQLite/MSSQL/TiDB | N | N | Y |
| [leveldbstore](https://github.com/alexedwards/scs/tree/master/leveldbstore) | LevelDB based session store | | [leveldbstore](https://github.com/alexedwards/scs/tree/master/leveldbstore) | [LevelDB](https://github.com/syndtr/goleveldb) | Y | N | N |
| [memstore](https://github.com/alexedwards/scs/tree/master/memstore) | In-memory session store (default) | | [memstore](https://github.com/alexedwards/scs/tree/master/memstore) | In-memory (default) | Y | Y | N |
| [mongodbstore](https://github.com/alexedwards/scs/tree/master/mongodbstore) | MongoDB based session store | | [mongodbstore](https://github.com/alexedwards/scs/tree/master/mongodbstore) | [MongoDB](https://www.mongodb.com/) | N | N | Y |
| [mssqlstore](https://github.com/alexedwards/scs/tree/master/mssqlstore) | MSSQL based session store | | [mssqlstore](https://github.com/alexedwards/scs/tree/master/mssqlstore) | [Microsoft SQL Server](https://www.microsoft.com/en-us/sql-server) | N | N | Y |
| [mysqlstore](https://github.com/alexedwards/scs/tree/master/mysqlstore) | MySQL based session store | | [mysqlstore](https://github.com/alexedwards/scs/tree/master/mysqlstore) | [MySQL](https://www.mysql.com/) | N | N | Y |
| [pgxstore](https://github.com/alexedwards/scs/tree/master/pgxstore) | PostgreSQL based session store (using the [pgx](https://github.com/jackc/pgx) driver) | | [pgxstore](https://github.com/alexedwards/scs/tree/master/pgxstore) | [PostgreSQL](https://www.postgresql.org/) (using the [pgx](https://github.com/jackc/pgx) driver) | N | N | Y |
| [postgresstore](https://github.com/alexedwards/scs/tree/master/postgresstore) | PostgreSQL based session store (using the [pq](https://github.com/lib/pq) driver) | | [postgresstore](https://github.com/alexedwards/scs/tree/master/postgresstore) | [PostgreSQL](https://www.postgresql.org/) (using the [pq](https://github.com/lib/pq) driver) | N | N | Y |
| [redisstore](https://github.com/alexedwards/scs/tree/master/redisstore) | Redis based session store | | [redisstore](https://github.com/alexedwards/scs/tree/master/redisstore) | [Redis](https://redis.io/) | N | Y | Y |
| [sqlite3store](https://github.com/alexedwards/scs/tree/master/sqlite3store) | SQLite3 based session store | | [sqlite3store](https://github.com/alexedwards/scs/tree/master/sqlite3store) | [SQLite3](https://sqlite.org/) (using the [mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) CGO-based driver) | Y | N | Y |
Custom session stores are also supported. Please [see here](#using-custom-session-stores) for more information. Custom session stores are also supported. Please [see here](#using-custom-session-stores) for more information.