Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    @google-cloud/datastorepublic

    Google Cloud Platform logo

    Google Cloud Datastore: Node.js Client

    release level CircleCI AppVeyor codecov

    Node.js idiomatic client for Cloud Datastore.

    Cloud Datastore is a NoSQL document database built for automatic scaling, high performance, and ease of application development. While the Cloud Datastore interface has many of the same features as traditional databases, as a NoSQL database it differs from them in the way it describes relationships between data objects.

    Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

    Table of contents:

    Quickstart

    Before you begin

    1. Select or create a Cloud Platform project.

      Go to the projects page

    2. Enable billing for your project.

      Enable billing

    3. Enable the Google Cloud Datastore API.

      Enable the API

    4. 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/datastore
    

    Using the client library

    // Imports the Google Cloud client library
    const Datastore = require('@google-cloud/datastore');
     
    // Your Google Cloud Platform project ID
    const projectId = 'YOUR_PROJECT_ID';
     
    // Creates a client
    const datastore = new Datastore({
      projectId: projectId,
    });
     
    // The kind for the new entity
    const kind = 'Task';
    // The name/ID for the new entity
    const name = 'sampletask1';
    // The Cloud Datastore key for the new entity
    const taskKey = datastore.key([kind, name]);
     
    // Prepares the new entity
    const task = {
      key: taskKey,
      data: {
        description: 'Buy milk',
      },
    };
     
    // Saves the entity
    datastore
      .save(task)
      .then(() => {
        console.log(`Saved ${task.key.name}${task.data.description}`);
      })
      .catch(err => {
        console.error('ERROR:', err);
      });

    Samples

    Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

    Sample Source Code Try it
    Tasks source code Open in Cloud Shell
    Concepts source code Open in Cloud Shell
    Errors and Error Handling source code Open in Cloud Shell

    The Cloud Datastore Node.js Client API Reference documentation also contains samples.

    Versioning

    This library follows Semantic Versioning.

    This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest 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 @google-cloud/datastore

    Downloadsweekly downloads

    35,375

    version

    1.4.0

    license

    Apache-2.0

    repository

    githubgithub

    last publish

    collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar