@antstanley/firestore
    TypeScript icon, indicating that this package has built-in type declarations

    0.19.1 • Public • Published

    Google Cloud Platform logo

    Google Cloud Firestore: Node.js Server SDK

    release level npm version codecov

    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

    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.
    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

    Install

    npm i @antstanley/firestore

    DownloadsWeekly Downloads

    2

    Version

    0.19.1

    License

    Apache-2.0

    Unpacked Size

    3.02 MB

    Total Files

    178

    Last publish

    Collaborators

    • antstanley