https://github.com/goto-bus-stop/keyv-firestore

Firebase Cloud Firestore backend for Keyv, the simple persistent key-value storage module
https://github.com/goto-bus-stop/keyv-firestore

keyv keyv-storage-adapter

Last synced: 12 days ago
JSON representation

Firebase Cloud Firestore backend for Keyv, the simple persistent key-value storage module

• Host: GitHub
• URL: https://github.com/goto-bus-stop/keyv-firestore
• Owner: goto-bus-stop
• License: other
• Created: 2019-05-25T15:08:47.000Z (over 5 years ago)
• Default Branch: default
• Last Pushed: 2024-08-21T20:26:04.000Z (3 months ago)
• Last Synced: 2024-10-24T16:23:08.149Z (20 days ago)
• Topics: keyv, keyv-storage-adapter
• Language: JavaScript
• Size: 34.2 KB
• Stars: 22
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# keyv-firestore

Firebase Cloud Firestore backend for [Keyv](https://github.com/lukechilds/keyv), the simple persistent key-value storage module

[Install](#install) - [Usage](#usage) - [License: Apache-2.0](#license)

[![npm][npm-image]][npm-url]

[![ci][actions-image]][actions-url]

[![standard][standard-image]][standard-url]

[npm-image]: https://img.shields.io/npm/v/keyv-firestore.svg?style=flat-square

[npm-url]: https://www.npmjs.com/package/keyv-firestore

[actions-image]: https://img.shields.io/github/actions/workflow/status/goto-bus-stop/keyv-firestore/ci.yml?branch=default&style=flat-square

[actions-url]: https://github.com/goto-bus-stop/keyv-firestore/actions

[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square

[standard-url]: http://npm.im/standard

## Compatibility

`keyv-firestore` is tested with Keyv v3, v4, and v5, on Node.js 14 and up.

## Install

```

npm install keyv-firestore

```

## Usage

`keyv-firestore` uses nested collections for namespaces and keys. A root collection contains keys for each namespace, and each namespace key contains a single collection that holds key/value pairs. The path to a specific key is `root-collection/namespace/namespace/key`.

```js

var Keyv = require('keyv')

var KeyvFirestore = require('keyv-firestore')

const keyv = new Keyv({

  store: new KeyvFirestore({

    // the project id to use

    projectId: 'my-firebase-project',

    // REQUIRED: the root collection to store things in

    collection: 'firestore-db-collection'

  })

})

```

You can set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to configure credentials, or pass in a JavaScript object in the `credentials` option.

```js

const keyv = new Keyv({

  store: new KeyvFirestore({

    projectId: 'my-firebase-project',

    collection: 'firestore-db-collection',

    credentials: require('./path/to/google-credentials.json')

  })

})

```

## Tests

To be able to run tests locally, put a `.google-credentials.json` file in this repository's root directory.

## License

[Apache-2.0](LICENSE.md)