[//]: # "This README.md file is auto-generated, all changes to this file will be lost." [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo # [Google Cloud Firestore Session](https://github.com/googleapis/nodejs-firestore-session) [![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/connect-firestore.svg)](https://www.npmjs.org/package/@google-cloud/connect-firestore) > An [express](http://expressjs.com/) session store backed by [Google Cloud Firestore][product-docs]. **@google-cloud/connect-firestore** is an [express](http://expressjs.com/) session store backed by [Google Cloud Firestore][product-docs]. **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](https://github.com/googleapis/nodejs-firestore-session/blob/main/CHANGELOG.md). * [Google Cloud Firestore Session Node.js Client API Reference][client-docs] * [Google Cloud Firestore Session Documentation][product-docs] * [github.com/googleapis/nodejs-firestore-session](https://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][explained]. [explained]: https://cloud.google.com/apis/docs/client-libraries-explained **Table of contents:** * [Quickstart](#quickstart) * [Before you begin](#before-you-begin) * [Installing the client library](#installing-the-client-library) * [Using the client library](#using-the-client-library) * [Samples](#samples) * [Versioning](#versioning) * [Contributing](#contributing) * [License](#license) ## Quickstart ### Before you begin 1. [Select or create a Cloud Platform project][projects]. 1. [Enable the Google Cloud Firestore Session API][enable_api]. 1. [Set up authentication with a service account][auth] so you can access the API from your local workstation. ### Installing the client library ```bash npm install @google-cloud/connect-firestore ``` ### Using the client library ```javascript 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/`](https://github.com/googleapis/nodejs-firestore-session/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Quickstart | [source code](https://github.com/googleapis/nodejs-firestore-session/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-firestore-session&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) | The [Google Cloud Firestore Session Node.js Client API Reference][client-docs] documentation also contains samples. ## Supported Node.js Versions Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule). Libraries are compatible with all current _active_ and _maintenance_ versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version. Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings: * Legacy versions are not tested in continuous integration. * Some security patches and features cannot be backported. * Dependencies cannot be kept up-to-date. Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). The dist-tags follow the naming convention `legacy-(version)`. For example, `npm install @google-cloud/connect-firestore@legacy-8` installs client libraries for versions compatible with Node.js 8. ## Versioning This library follows [Semantic Versioning](http://semver.org/). This library is considered to be **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 **stable** libraries are addressed with the highest priority. More Information: [Google Cloud Platform Launch Stages][launch_stages] [launch_stages]: https://cloud.google.com/terms/launch-stages ## Contributing Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-firestore-session/blob/main/CONTRIBUTING.md). 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](https://github.com/googleapis/synthtool). ## License Apache Version 2.0 See [LICENSE](https://github.com/googleapis/nodejs-firestore-session/blob/main/LICENSE) [client-docs]: https://cloud.google.com/nodejs/docs/reference/connect-firestore/latest [product-docs]: https://cloud.google.com/firestore [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png [projects]: https://console.cloud.google.com/project [billing]: https://support.google.com/cloud/answer/6293499#enable-billing [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=firestore.googleapis.com [auth]: https://cloud.google.com/docs/authentication/getting-started