Wondering what’s next for npm?Check out our public roadmap! »

    @google-cloud/connect-datastore
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.2 • Public • Published

    Google Inc. logo

    Google Cloud Datastore Sessions

    NPM

    @google-cloud/connect-datastore is a Google Cloud Datastore session store backed by @google-cloud/datastore.

    Note: Cloud Datastore 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.

    Installation

    npm install @google-cloud/connect-datastore
    

    Configuration

    You must have a Google Cloud project and credentials.

    See gcloud node's documentation on setting up authentication.

    Usage Example

    const {Datastore} = require('@google-cloud/datastore');
    const {DatastoreStore} = require('@google-cloud/connect-datastore');
    const express = require('express');
    const session = require('express-session');
    
    const app = express();
    
    app.use(session({
      store: new DatastoreStore({
        kind: 'express-sessions',
    
        // Optional: expire the session after this many milliseconds.
        // note: datastore does not automatically delete all expired sessions
        // you may want to run separate cleanup requests to remove expired sessions
        // 0 means do not expire
        expirationMs: 0,
    
        dataset: new Datastore({
    
          // For convenience, @google-cloud/datastore automatically looks for the
          // GCLOUD_PROJECT environment variable. Or you can explicitly pass in a
          // project ID here:
          projectId: process.env.GCLOUD_PROJECT,
    
          // For convenience, @google-cloud/datastore automatically looks for the
          // GOOGLE_APPLICATION_CREDENTIALS environment variable. Or you can
          // explicitly pass in that path to your key file here:
          keyFilename: process.env.GOOGLE_APPLICATION_CREDENTIALS
        })
      }),
      secret: 'my-secret'
    }));

    Expiration

    If a session is fetched with the delta between the createdAt time and current time greater than expirationMs, the session will not be returned and will instead be destroyed.

    Datastore does not support a ttl, and tokens are only deleted if a session is fetched. You will likely want to implement logic to occasionally delete expired sessions.

    Contributing

    License

    Keywords

    none

    Install

    npm i @google-cloud/connect-datastore

    DownloadsWeekly Downloads

    727

    Version

    5.0.2

    License

    Apache-2.0

    Unpacked Size

    33.4 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar