Google Cloud Platform logo

Google Cloud Firestore: Node.js Client

release level CircleCI AppVeyor codecov

Node.js idiomatic client for Cloud Firestore.

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

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable the Google Cloud Firestore API.

    Enable the 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 --save @google-cloud/firestore

Using the client library

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

const firestore = new Firestore({
  projectId: 'YOUR_PROJECT_ID',
  keyFilename: '/path/to/keyfile.json',

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

// Enter new data into the document.
  title: 'Welcome to Firestore',
  body: 'Hello World',
}).then(() => {
  // Document created successfully.

// Update an existing document.
  body: 'My first Firestore app',
}).then(() => {
  // Document updated successfully.

// Read the document.
document.get().then(doc => {
  // Document read successfully.

// Delete the document.
document.delete().then(() => {
  // Document deleted successfully.

The Cloud Firestore Node.js Client API Reference documentation also contains samples.


This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.


Apache Version 2.0