@google-cloud/firestore

module

The default export of the @google-cloud/firestore package is the Firestore class.

See Firestore and ClientConfig for client methods and configuration options.

Examples

Install the client library with npm:

npm install --save @google-cloud/firestore

Import the client library

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

Create a client that uses Application Default Credentials (ADC):

var firestore = new Firestore();

Create a client with explicit credentials:

var firestore = new Firestore({
  projectId: 'your-project-id',
  keyFilename: '/path/to/keyfile.json'
});

Full quickstart example:

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.
});