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

    4.15.1 • Public • Published

    Google Cloud Platform logo

    Cloud Firestore: Node.js Client

    release level npm version codecov

    This is the Node.js Server SDK for Google Cloud 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. To access these databases, use the Datastore SDK.

    A comprehensive list of changes in each version may be found in the CHANGELOG.

    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

    1. Select or create a Cloud Platform project.
    2. Enable the Cloud Firestore API.
    3. 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/firestore

    Using the client library

    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/ directory. Each sample's README.md has instructions for running its sample.

    Sample Source Code Try it
    Limit-to-last-query source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell
    Solution-counters source code Open in Cloud Shell

    The Cloud Firestore 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

    Install

    npm i @google-cloud/firestore

    DownloadsWeekly Downloads

    944,462

    Version

    4.15.1

    License

    Apache-2.0

    Unpacked Size

    5.53 MB

    Total Files

    123

    Last publish

    Collaborators

    • google-wombot