Hide
Cloud Datastore

Sign Up

This page describes how to activate the Google Cloud Datastore API, the quotas associated with this API, and how to enable billing. The activation process varies based on your existing setup and environment.

Limitations

Cloud Datastore does not work with projects created with the older Google APIs console. So, if you have an existing API project, you will need to create a new one in the Google Developers Console in order to use the Cloud Datastore API.

When you activate the Cloud Datastore API on a brand new Google Developers Console project, a special built-in version is deployed that becomes the default version. If you subsequently deploy an App Engine app to that project, the Cloud Datastore built-in continues to be the default version, so requests to your app will instead be sent to the Cloud Datastore built-in. You can use the Admin Console to manually set your app as the default version.

Accessing the Datastore API from a Compute Engine instance

This section shows how to activate and access the Google Cloud Datastore API from a Compute Engine VM instance in a new or existing Cloud project.

  1. Use the Enable Datastore API Wizard to activate the Datastore API. The wizard allows you to activate the API for an existing project, or create a new project and activate it for that.
  2. Use the Enable Google Compute Engine Wizard to activate the Google Compute Engine API for the project you selected or created in the previous step.
  3. Enable billing for the project under My Project > Billing & settings.
  4. If you haven't already done this, install the gcloud compute and authenticate it to Google Compute Engine.
  5. Add a Google Compute Engine instance and start it, following the instructions for starting an instance in the Google Compute Engine documentation. In addition to the project ID and the instance name, you must also specify both the datastore and userinfo.email scopes as shown here:

    $ PROJECT_ID=<project-id>        # replace <project-id> with the Project ID you created previously.
    $ INSTANCE_NAME=<instance-name>  # replace <instance-name> with the name you want to use for your instance.
    $ gcloud compute instances create $INSTANCE_NAME --project $PROJECT_ID --scopes datastore userinfo-email
    
  6. Confirm that your instance is running.

  7. To use this new Compute Engine instance, connect to it using ssh.

At this point all services and authorizations are configured for your project and you can start writing code or exploring the API.

Accessing the Datastore API from another platform

This section shows how to activate and access the Google Cloud Datastore API from an external application running on a platform outside of Google Cloud.

  1. Use the Enable Datastore API Wizard to activate the Datastore API. The wizard allows you to activate the API for an existing project, or create a new project and activate it for that.
  2. In the left sidebar, under APIs & auth, select Credentials.
  3. Click on Create new Client ID.
  4. Select Service account and then click Create Client ID. Your browser will download the private key.
  5. Your Service Account is the Email address displayed under the Service Account section.
  6. Your Private Key is the file you just downloaded.
  7. Your Dataset ID is your new or existing Cloud Project ID.

At this point all services and authorizations are configured for your project and you can start writing code or exploring the API.

Accessing an existing App Engine Datastore from a Compute Engine instance

This section shows how to activate and access an existing App Engine Datastore from an Compute Engine instance. This scenario is focused on users who want to share data between an existing App Engine application and a Compute Engine instance.

  1. Visit the App Engine Admin Console.
  2. Select the Application ID for which the Google Cloud Datastore API should be enabled.
  3. In the left sidebar, click the Application Settings.
  4. In the Basics section, find the Google APIs Console Project Number and click it to go to the dashboard of the project containing the App Engine application.

    Note: New App Engine applications are automatically created with a Cloud project, which is required if your App Engine app needs to work with other Cloud products or use other Google APIs. However, older legacy App Engine applications were not created with a Cloud project. If your application does not have an associated project, create one (and populate the Google APIs Console Project Number field) by following the instructions How do I create a Cloud project for App Engine.

  5. Use the Enable Datastore API Wizard to activate the Datastore API for the project that contains the App Engine application.

  6. Use the Enable Google Compute Engine Wizard to activate the Google Compute Engine API for the project.
  7. Check that billing is enabled for the project under My Project > Billing & settings.
  8. If you haven't already done this, install the gcloud compute and authenticate it to Google Compute Engine.
  9. Add a Google Compute Engine instance and start it, following the instructions for starting an instance in the Google Compute Engine documentation. In addition to the project ID and the instance name, you must also specify both the datastore and userinfo.email scopes as shown here:

    $ PROJECT_ID=<project-id>        # replace <project-id> with the Project ID you created previously.
    $ INSTANCE_NAME=<instance-name>  # replace <instance-name> with the name you want to use for your instance.
    $ gcloud compute instances create $INSTANCE_NAME --project $PROJECT_ID --scopes datastore userinfo-email
    
  10. Confirm that your instance is running.

  11. To use this new Compute Engine instance, connect to it using ssh.
  12. Your Dataset ID is the same identifier as your App Engine Application ID.

At this point all services and authorizations are configured for your project and you can start writing code or exploring the API.

Accessing an existing App Engine Datastore from another platform

This section shows how to activate and access an existing App Engine Datastore from an external application running on a platform outside of Google Cloud.

  1. Visit the App Engine Admin Console.
  2. Select the Application ID for which the Google Cloud Datastore API should be enabled.
  3. In the left sidebar, click the Application Settings.
  4. In the Basics section, find the Google APIs Console Project Number and click it to go to the dashboard of the project containing the App Engine application.

    Note: New App Engine applications are automatically created with a Cloud project, which is required if your App Engine app needs to work with other Cloud products or use other Google APIs. However, older legacy App Engine applications were not created with a Cloud project. If your application does not have an associated project, create one (and populate the Google APIs Console Project Number field) by following the instructions How do I create a Cloud project for App Engine.

  5. Use the Enable Datastore API Wizard to activate the Datastore API for the project that contains the App Engine application.

  6. Check that billing is enabled for the project under My Project > Billing & settings.
  7. In the left sidebar, under APIs & auth, select Credentials.
  8. Click on Create new Client ID.
  9. Select Service account and then click Create Client ID. Your browser will download the private key.
  10. Your Service Account is the Email address displayed under the Service Account section.
  11. Your Private Key is the file you just downloaded.
  12. Your Dataset ID is your App Engine Application ID.

At this point all services and authorizations are configured for your project and you can start writing code or exploring the API.

Quotas and billing

A certain amount of free quota is available, as described in Pricing and Quota. This means you aren't required to enable billing to get started or to use Cloud Datastore up to the free quota limits. However, if you need more resources than is provided by the free quota, you must enable billing and set a budget for your project.

Enabling billing and setting a budget

In order to gain access to higher quotas than the free quotas, you must enable billing and you must also set a budget.

The budget is a daily limit: it sets the maximum dollar amount of resources you will be charged for each day. After this limit is reached, no further costs will be incurred, but also, no further billable Cloud Datastore operations will be allowed. You'll need to specify a budget because the initial default budget is always 0, which means by default you cannot exceed the free quota, even with billing enabled.

To enable billing and set a budget:

  1. Navigate to Google Developers Console.
  2. Select the project.
  3. If you haven't created any billing accounts yet,
    1. Click the gear icon in the upper right.
    2. Click Billing accounts > New billing account and follow the prompts to create a new billing account.
  4. Click the gear icon in the upper right and click Project billing settings > Enable billing.
  5. Select the billing account you want to use and click OK to enable billing.
  6. In the left navigation panel, click Compute > App Engine > Settings > Edit.
  7. Specify the daily budget amount in USD and click Save.