What is @google-cloud/firestore?
The @google-cloud/firestore npm package is a client library for accessing Google Cloud Firestore, a NoSQL document database built for automatic scaling, high performance, and ease of application development. It provides functionality to perform various operations such as adding, updating, deleting documents, querying collections, and managing transactions.
What are @google-cloud/firestore's main functionalities?
Adding Documents
This code sample demonstrates how to add a document to a Firestore collection. It creates a new document with a specified ID ('alovelace') and sets the data for the document.
const { Firestore } = require('@google-cloud/firestore');
const firestore = new Firestore();
const document = firestore.collection('users').doc('alovelace');
document.set({
first: 'Ada',
last: 'Lovelace',
born: 1815
});
Updating Documents
This code sample shows how to update an existing document in a Firestore collection. It updates the 'born' field of the document with the ID 'alovelace'.
const { Firestore } = require('@google-cloud/firestore');
const firestore = new Firestore();
const document = firestore.collection('users').doc('alovelace');
document.update({
born: 1816
});
Deleting Documents
This code sample illustrates how to delete a document from a Firestore collection. It deletes the document with the ID 'alovelace'.
const { Firestore } = require('@google-cloud/firestore');
const firestore = new Firestore();
const document = firestore.collection('users').doc('alovelace');
document.delete();
Querying Collections
This code sample demonstrates how to query documents in a Firestore collection that meet certain criteria. It retrieves all documents where the 'born' field is greater than 1800.
const { Firestore } = require('@google-cloud/firestore');
const firestore = new Firestore();
firestore.collection('users').where('born', '>', 1800).get()
.then(snapshot => {
snapshot.forEach(doc => console.log(doc.id, '=>', doc.data()));
});
Managing Transactions
This code sample shows how to use transactions to read and write data atomically. It reads a document and then updates it within a transaction, ensuring that the operation is atomic.
const { Firestore } = require('@google-cloud/firestore');
const firestore = new Firestore();
let documentRef = firestore.collection('users').doc('alovelace');
firestore.runTransaction(transaction => {
return transaction.get(documentRef).then(doc => {
if (!doc.exists) {
throw 'Document does not exist!';
}
let newBorn = doc.data().born + 1;
transaction.update(documentRef, { born: newBorn });
});
}).then(() => console.log('Transaction successfully committed!'))
.catch(error => console.log('Transaction failed: ', error));
Other packages similar to @google-cloud/firestore
mongoose
Mongoose is an npm package that provides a straight-forward, schema-based solution to model application data. It includes built-in type casting, validation, query building, and business logic hooks. It is designed for MongoDB, a different NoSQL database, and therefore has a different API and set of features compared to @google-cloud/firestore.
couchbase
Couchbase is an npm package for interacting with Couchbase Server, which is a NoSQL document database. It allows for flexible data modeling, full-text search, analytics, and query capabilities. The API and capabilities are different from @google-cloud/firestore as Couchbase is a different database with its own set of features and design considerations.
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.
Table of contents:
Quickstart
Read more about the client libraries for Cloud APIs, including the older
Google APIs Client Libraries, in Client Libraries Explained.
Before you begin
-
Select or create a Cloud Platform project.
Go to the projects page
-
Enable the Google Cloud Firestore API.
Enable the 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');
document.set({
title: 'Welcome to Firestore',
body: 'Hello World',
}).then(() => {
});
document.update({
body: 'My first Firestore app',
}).then(() => {
});
document.get().then(doc => {
});
document.delete().then(() => {
});
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