Google Cloud Firestore: Node.js Client
Node.js idiomatic client for Cloud Firestore .
Client API Reference
- About the NPM package
- Classes
- RPC Message Types
- Other Abstract Types
- Index of all
Quickstart
Before you begin
-
Select or create a Cloud Platform project.
-
Enable the Google Cloud Firestore API.
-
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.
document.set({
title: 'Welcome to Firestore',
body: 'Hello World',
}).then(() => {
// Document created successfully.
});
// Update an existing document.
document.update({
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.
Versioning
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
Contributing
Contributions welcome! See the Contributing Guide .
License
Apache Version 2.0
See LICENSE