Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googleapis/nodejs-firestore

Node.js client for Google Cloud Firestore: a NoSQL document database built for automatic scaling, high performance, and ease of application development.
https://github.com/googleapis/nodejs-firestore

database firestore nodejs nosql

Last synced: about 1 month ago
JSON representation

Node.js client for Google Cloud Firestore: a NoSQL document database built for automatic scaling, high performance, and ease of application development.

Host: GitHub
URL: https://github.com/googleapis/nodejs-firestore
Owner: googleapis
License: apache-2.0
Created: 2017-07-26T20:51:49.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2024-05-22T18:49:16.000Z (4 months ago)
Last Synced: 2024-05-22T19:47:58.212Z (4 months ago)
Topics: database, firestore, nodejs, nosql
Language: JavaScript
Homepage: https://cloud.google.com/firestore/
Size: 11.5 MB
Stars: 634
Watchers: 64
Forks: 145
Open Issues: 86
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

        [//]: # "This README.md file is auto-generated, all changes to this file will be lost."

[//]: # "To regenerate it, use `python -m synthtool`."



# [Cloud Firestore: Node.js Client](https://github.com/googleapis/nodejs-firestore)

[![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/firestore.svg)](https://www.npmjs.org/package/@google-cloud/firestore)

This is the Node.js Server SDK for [Google Cloud Firestore](https://firebase.google.com/docs/firestore/). Google Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.

This Cloud Firestore Server SDK uses Google’s Cloud Identity and Access Management for authentication and should only be used in trusted environments. Your Cloud Identity credentials allow you bypass all access restrictions and provide read and write access to all data in your Cloud Firestore project.

The Cloud Firestore Server SDKs are designed to manage the full set of data in your Cloud Firestore project and work best with reliable network connectivity. Data operations performed via these SDKs directly access the Cloud Firestore backend and all document reads and writes are optimized for high throughput.

Applications that use Google's Server SDKs should not be used in end-user environments, such as on phones or on publicly hosted websites. If you are developing a Web or Node.js application that accesses Cloud Firestore on behalf of end users, use the firebase Client SDK.

**Note:** This Cloud Firestore Server SDK does not support Firestore databases created in [Datastore mode](https://cloud.google.com/datastore/docs/firestore-or-datastore#in_datastore_mode). To access these databases, use the [Datastore SDK](https://www.npmjs.com/package/@google-cloud/datastore).

A comprehensive list of changes in each version may be found in

[the CHANGELOG](https://github.com/googleapis/nodejs-firestore/blob/main/CHANGELOG.md).

* [Cloud Firestore Node.js Client API Reference][client-docs]

* [Cloud Firestore Documentation][product-docs]

* [github.com/googleapis/nodejs-firestore](https://github.com/googleapis/nodejs-firestore)

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 Cloud Firestore 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/firestore

```

### Using the client library

```javascript

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

// Create a new client

const firestore = new Firestore();

async function quickstart() {

  // Obtain a document reference.

  const document = firestore.doc('posts/intro-to-firestore');

  // Enter new data into the document.

  await document.set({

    title: 'Welcome to Firestore',

    body: 'Hello World',

  });

  console.log('Entered new data into the document');

  // Update an existing document.

  await document.update({

    body: 'My first Firestore app',

  });

  console.log('Updated an existing document');

  // Read the document.

  const doc = await document.get();

  console.log('Read the document');

  // Delete the document.

  await document.delete();

  console.log('Deleted the document');

}

quickstart();

```

## Samples

Samples are in the [`samples/`](https://github.com/googleapis/nodejs-firestore/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.

| Sample                      | Source Code                       | Try it |

| --------------------------- | --------------------------------- | ------ |

| Limit-to-last-query | [source code](https://github.com/googleapis/nodejs-firestore/blob/main/samples/limit-to-last-query.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-firestore&page=editor&open_in_editor=samples/limit-to-last-query.js,samples/README.md) |

| Quickstart | [source code](https://github.com/googleapis/nodejs-firestore/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&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |

| Solution-counters | [source code](https://github.com/googleapis/nodejs-firestore/blob/main/samples/solution-counters.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-firestore&page=editor&open_in_editor=samples/solution-counters.js,samples/README.md) |

The [Cloud Firestore 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/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/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/blob/main/LICENSE)

[client-docs]: https://cloud.google.com/nodejs/docs/reference/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