@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

Google Cloud Datastore Client Library for Node.js

Looking for more Google APIs than just Datastore? You might want to check out google-cloud.

• API Documentation
• Official Documentation

Follow the activation instructions to use the Google Cloud Datastore API with your project.

$ npm install --save @google-cloud/datastore

var datastore = require('@google-cloud/datastore')({
  projectId: 'grape-spaceship-123',
  keyFilename: '/path/to/keyfile.json'
});

var key = datastore.key(['Product', 'Computer']);

datastore.get(key, function(err, entity) {
  console.log(err || entity);
});

// Save data to Datastore.
var blogPostData = {
  title: 'How to make the perfect homemade pasta',
  author: 'Andrew Chilton',
  isDraft: true
};

var blogPostKey = datastore.key('BlogPost');

datastore.save({
  key: blogPostKey,
  data: blogPostData
}, function(err) {
  // `blogPostKey` has been updated with an ID so you can do more operations
  // with it, such as an update.
  blogPostData.isDraft = false;

  datastore.save({
    key: blogPostKey,
    data: blogPostData
  }, function(err) {
    if (!err) {
      // The blog post is now published!
    }
  });
});

Authentication

It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services.

On Google Compute Engine

If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you set up the GCE instance, you add the correct scopes for the APIs you want to access.

// Authenticating on a global basis.
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'

var datastore = require('@google-cloud/datastore')({
  projectId: projectId
});

// ...you're good to go!

Elsewhere

If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account:

• Visit the Google Developers Console.
• Create a new project or click on an existing project.
• Navigate to APIs & auth > APIs section and turn on the following APIs (you may need to enable billing in order to use these services):

• Google Cloud Datastore API

• Navigate to APIs & auth > Credentials and then:

• If you want to use a new service account, click on Create new Client ID and select Service account. After the account is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests.
• If you want to generate a new key for an existing service account, click on Generate new JSON key and download the JSON key file.

var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'

var datastore = require('@google-cloud/datastore')({
  projectId: projectId,

  // The path to your key file:
  keyFilename: '/path/to/keyfile.json'

  // Or the contents of the key file:
  credentials: require('./path/to/keyfile.json')
});

// ...you're good to go!