firestore

Documentation

Index

• type FireStore
  • func New(client *firestore.Client) *FireStore
  • func NewWithCleanupInterval(client *firestore.Client, cleanupInterval time.Duration) *FireStore
  • func (m *FireStore) AllCtx(ctx context.Context) (map[string][]byte, error)
  • func (m *FireStore) Commit(token string, b []byte, expiry time.Time) error
  • func (m *FireStore) CommitCtx(ctx context.Context, token string, b []byte, expiry time.Time) error
  • func (m *FireStore) Delete(token string) error
  • func (m *FireStore) DeleteCtx(ctx context.Context, token string) error
  • func (m *FireStore) Find(token string) ([]byte, bool, error)
  • func (m *FireStore) FindCtx(ctx context.Context, token string) ([]byte, bool, error)
  • func (m *FireStore) StopCleanup()

Types

type FireStore

type FireStore struct {
	*firestore.Client
	Sessions *firestore.CollectionRef
	// contains filtered or unexported fields
}

FireStore represents the session store.

func New

func New(client *firestore.Client) *FireStore

New returns a new FireStore instance, with a background cleanup goroutine that runs every 5 minutes to remove expired session data.

func NewWithCleanupInterval

func NewWithCleanupInterval(client *firestore.Client, cleanupInterval time.Duration) *FireStore

NewWithCleanupInterval returns a new FireStore 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 (*FireStore) AllCtx

func (m *FireStore) AllCtx(ctx context.Context) (map[string][]byte, error)

AllCtx returns a map containing the token and data for all active (i.e. not expired) sessions in the firestore instance.

func (*FireStore) Commit

func (m *FireStore) Commit(token string, b []byte, expiry time.Time) error

func (*FireStore) CommitCtx

func (m *FireStore) CommitCtx(ctx context.Context, token string, b []byte, expiry time.Time) error

CommitCtx adds a session token and data to the FireStore instance with the given expiry time. If the session token already exists, then the data and expiry time are updated.

func (*FireStore) Delete

func (m *FireStore) Delete(token string) error

func (*FireStore) DeleteCtx

func (m *FireStore) DeleteCtx(ctx context.Context, token string) error

DeleteCtx removes a session token and corresponding data from the FireStore instance.

func (*FireStore) Find

func (m *FireStore) Find(token string) ([]byte, bool, error)

func (*FireStore) FindCtx

func (m *FireStore) FindCtx(ctx context.Context, token string) ([]byte, bool, error)

FindCtx returns the data for a given session token from the FireStore instance. If the session token is not found or is expired, the returned exists flag will be set to false.

func (*FireStore) StopCleanup

func (m *FireStore) StopCleanup()

StopCleanup terminates the background cleanup goroutine for the FireStore instance. It's rare to terminate this; generally FireStore 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 FireStore is transient. An example is creating a new FireStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the MySQLStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.