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

See Firestore and ClientConfig for client methods and configuration options.


Install the client library with <a href="https://www.npmjs.com/">npm</a>:
npm install --save @google-cloud/firestore

Import the client library
var Firestore = require('@google-cloud/firestore');

Create a client that uses <a href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application Default Credentials (ADC)</a>:
var firestore = new Firestore();

Create a client with <a href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit credentials</a>:
var firestore = new Firestore({ projectId:
  'your-project-id', keyFilename: '/path/to/keyfile.json'


Full quickstart example:

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');