Google Cloud Platform logo

Google Cloud Firestore Session

release level npm version codecov

An express session store backed by Google Cloud Firestore.

@google-cloud/connect-firestore is an express session store backed by Google Cloud Firestore.

Note: Cloud Firestore is a persistent, distributed, transactional database. Often, it's more appropriate to choose a different storage solution for sessions such as Memcache or Redis as their designs offer much faster operation in this use case.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable the Google Cloud Firestore Session API.
  3. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/connect-firestore

Using the client library

const {Firestore} = require('@google-cloud/firestore');
const express = require('express');
const session = require('express-session');
const app = express();

const {FirestoreStore} = require('@google-cloud/connect-firestore');

    store: new FirestoreStore({
      dataset: new Firestore({
        kind: 'express-sessions',
    secret: 'my-secret',
    resave: false,
    saveUninitialized: true,

app.get('/', (req, res) => {
  if (!req.session.views) {
    req.session.views = 0;
  const views = req.session.views++;
  res.send(`Views ${views}`);

app.listen(4830, () => {
  console.log(`Example app listening on port 4830!`);


Samples are in the samples/ directory. The samples' has instructions for running the samples.

Sample Source Code Try it
Quickstart source code Open in Cloud Shell

The Google Cloud Firestore Session Node.js Client API Reference documentation also contains samples.


This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.


Apache Version 2.0


result-matching ""

    No results matching ""