by googleapis

googleapis / nodejs-datastore

Node.js client for Google Cloud Datastore: a highly-scalable NoSQL database for your web and mobile ...

151 Stars 79 Forks Last release: 14 days ago (v6.2.0) Apache License 2.0 625 Commits 63 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Google Cloud Platform logo

Google Cloud Datastore: Node.js Client

release level npm version codecov

Cloud Datastore Client Library for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

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

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable the Google Cloud Datastore 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 @google-cloud/datastore

Using the client library

// Imports the Google Cloud client library
const {Datastore} = require('@google-cloud/datastore');

// Creates a client const datastore = new Datastore();

async function quickstart() { // 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 await; console.log(Saved ${}: ${}); } quickstart();


Emulator returning

Reference Issue: #95

When using the emulator, you may experience errors such as "DEADLINE_EXCEEDED" within your application, corresponding to an error in the emulator: "java.lang.OutOfMemoryError". These errors are unique to the emulator environment and will not persist in production.

A workaround is available, provided by @ohmpatel1997 here.


Samples are in the

directory. The samples'
has instructions for running the samples.

| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Concepts | source code | Open in Cloud Shell | | Error | source code | Open in Cloud Shell | | Export | source code | Open in Cloud Shell | | Import | source code | Open in Cloud Shell | | Indexes.get | source code | Open in Cloud Shell | | Indexes.list | source code | Open in Cloud Shell | | Quickstart | source code | Open in Cloud Shell | | Add Task | source code | Open in Cloud Shell | | Delete Task | source code | Open in Cloud Shell | | Legacy Samples | source code | Open in Cloud Shell | | List Tasks | source code | Open in Cloud Shell | | Update Task | source code | Open in Cloud Shell |

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

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targetting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention


Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8
    : install client libraries from this dist-tag for versions compatible with Node.js 8.


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


Contributions welcome! See the Contributing Guide.

Please note that this
, the
, and a variety of configuration files in this repository (including
) are generated from a central template. To edit one of these files, make an edit to its template in this directory.


Apache Version 2.0


We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.