Google Cloud Datastore: Node.js Client
Cloud Datastore Client Library for Node.js
- Google Cloud Datastore Node.js Client API Reference
- Google Cloud Datastore Documentation
- github.com/googleapis/nodejs-datastore
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
- Select or create a Cloud Platform project.
- Enable the Google Cloud Datastore API.
- 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 datastore.save(task);
console.log(`Saved ${task.key.name}: ${task.data.description}`);
}
quickstart();
Troubleshooting
Emulator returning DEADLINE_EXCEEDED
, java.lang.OutOfMemoryError
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
Samples are in the samples/
directory. The samples' README.md
has instructions for running the samples., Sample, Source Code, Try it, ---------------------------, ---------------------------------, ------, Concepts, source code, , Error, source code,
, Quickstart, source code,
, Add Task, source code,
, Delete Task, source code,
, Legacy Samples, source code,
, List Tasks, source code,
, Update Task, source code,
, The Google 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