@google-cloud/datastore

What is @google-cloud/datastore?

@google-cloud/datastore is a Node.js client library for Google Cloud Datastore, a NoSQL document database built for automatic scaling, high performance, and ease of application development. It allows you to interact with Google Cloud Datastore to perform operations such as creating, reading, updating, and deleting entities.

What are @google-cloud/datastore's main functionalities?

Create an Entity

This code sample demonstrates how to create and save a new entity in Google Cloud Datastore. It creates a 'Task' entity with a description and saves it to the datastore.

const { Datastore } = require('@google-cloud/datastore');
const datastore = new Datastore();

const taskKey = datastore.key('Task');

const task = {
  key: taskKey,
  data: {
    description: 'Buy milk'
  }
};

datastore.save(task)
  .then(() => {
    console.log(`Task ${taskKey.id} created successfully.`);
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

Retrieve an Entity

This code sample demonstrates how to retrieve an entity from Google Cloud Datastore using its key. It fetches a 'Task' entity by its ID and logs the result.

const { Datastore } = require('@google-cloud/datastore');
const datastore = new Datastore();

const taskKey = datastore.key(['Task', 'taskId']);

datastore.get(taskKey)
  .then(([task]) => {
    if (!task) {
      console.log('No task found.');
      return;
    }
    console.log('Task:', task);
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

Update an Entity

This code sample demonstrates how to update an existing entity in Google Cloud Datastore. It updates the description of a 'Task' entity.

const { Datastore } = require('@google-cloud/datastore');
const datastore = new Datastore();

const taskKey = datastore.key(['Task', 'taskId']);

const task = {
  key: taskKey,
  data: {
    description: 'Buy milk and bread'
  }
};

datastore.update(task)
  .then(() => {
    console.log(`Task ${taskKey.id} updated successfully.`);
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

Delete an Entity

This code sample demonstrates how to delete an entity from Google Cloud Datastore. It deletes a 'Task' entity by its key.

const { Datastore } = require('@google-cloud/datastore');
const datastore = new Datastore();

const taskKey = datastore.key(['Task', 'taskId']);

datastore.delete(taskKey)
  .then(() => {
    console.log(`Task ${taskKey.id} deleted successfully.`);
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

Other packages similar to @google-cloud/datastore

mongoose

Mongoose is an ODM (Object Data Modeling) library for MongoDB and Node.js. It provides a schema-based solution to model your application data. While @google-cloud/datastore is used for Google Cloud Datastore, Mongoose is specifically designed for MongoDB, offering a rich set of features for data modeling and validation.

firebase-admin

Firebase Admin SDK allows server-side access to Firebase services, including Firestore, which is a NoSQL document database similar to Google Cloud Datastore. While @google-cloud/datastore is specific to Google Cloud's Datastore, Firebase Admin SDK provides access to Firestore, which is part of the Firebase platform, offering real-time data synchronization and offline capabilities.

dynamodb

AWS SDK for JavaScript provides access to Amazon DynamoDB, a fully managed NoSQL database service. Similar to Google Cloud Datastore, DynamoDB is designed for high availability and scalability. The main difference is the cloud provider, with DynamoDB being part of AWS and @google-cloud/datastore being part of Google Cloud.

README

Google Cloud Datastore: Node.js Client

Cloud Datastore Client Library for Node.js

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

• 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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

• Select or create a Cloud Platform project.
• Enable the Google Cloud Datastore API.
• Set up authentication 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. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Concepts	source code
Error	source code
Export	source code
Import	source code
Indexes.get	source code
Indexes.list	source code
Create a union between two filters	source code
Run query explain (regular query)	source code
Run query explain (aggregate query)	source code
Run query explain analyze (regular query)	source code
Run query explain analyze (aggregate query)	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.

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. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/datastore@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be 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 stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

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

License

Apache Version 2.0

See LICENSE

Changelog

9.2.1 (2024-11-06)

Bug Fixes

• Address edge cases for excluding large properties when using save (#1356) (ceaff7e)
• Create a release (#1353) (536873e)