Google Cloud Firestore Session
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.
A comprehensive list of changes in each version may be found in the CHANGELOG.
- Google Cloud Firestore Session Node.js Client API Reference
- Google Cloud Firestore Session Documentation
- github.com/googleapis/nodejs-firestore-session
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
Quickstart
Before you begin
- Select or create a Cloud Platform project.
- Enable the Google Cloud Firestore Session API.
- 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');
app.use(
session({
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
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Quickstart | source code |
The Google Cloud Firestore Session Node.js Client API Reference documentation also contains samples.
Supported Node.js Versions
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed via npm dist-tags.
The dist-tags follow the naming convention legacy-(version)
.
Legacy Node.js versions are supported as a best effort:
- Legacy versions will not be tested in continuous integration.
- Some security patches may not be able to be backported.
- Dependencies will not be kept up-to-date, and features will not be backported.
Legacy tags available
legacy-8
: install client libraries from this dist-tag for versions compatible with Node.js 8.
Versioning
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
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md
, the samples/README.md
,
and a variety of configuration files in this repository (including .nycrc
and tsconfig.json
)
are generated from a central template. To edit one of these files, make an edit
to its templates in
directory.
License
Apache Version 2.0
See LICENSE