Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LibsqlStore ¶
type LibsqlStore struct {
// contains filtered or unexported fields
}
SQLite3Store represents the session store.
func New ¶
func New(db *sql.DB) *LibsqlStore
New returns a new SQLite3Store instance, with a background cleanup goroutine that runs every 5 minutes to remove expired session data.
func NewWithCleanupInterval ¶
func NewWithCleanupInterval(db *sql.DB, cleanupInterval time.Duration) *LibsqlStore
NewWithCleanupInterval returns a new LibsqlStore 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 (*LibsqlStore) All ¶
func (p *LibsqlStore) All() (map[string][]byte, error)
All returns a map containing the token and data for all active (i.e. not expired) sessions in the LibsqlStore instance.
func (*LibsqlStore) Commit ¶
Commit adds a session token and data to the LibsqlStore instance with the given expiry time. If the session token already exists, then the data and expiry time are updated.
func (*LibsqlStore) Delete ¶
func (p *LibsqlStore) Delete(token string) error
Delete removes a session token and corresponding data from the LibsqlStore instance.
func (*LibsqlStore) Find ¶
func (p *LibsqlStore) Find(token string) (b []byte, exists bool, err error)
Find returns the data for a given session token from the LibsqlStore instance. If the session token is not found or is expired, the returned exists flag will be set to false.
func (*LibsqlStore) StopCleanup ¶
func (p *LibsqlStore) StopCleanup()
StopCleanup terminates the background cleanup goroutine for the LibsqlStore instance. It's rare to terminate this; generally LibsqlStore 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 LibsqlStore is transient. An example is creating a new LibsqlStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the LibsqlStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.
Source Files