com.google.cloud.datastore.testing

Class LocalDatastoreHelper

java.lang.Object

com.google.cloud.datastore.testing.LocalDatastoreHelper

public class LocalDatastoreHelper
extends Object

Utility to start and stop local Google Cloud Datastore process.

Method Summary

Methods

Modifier and Type	Method and Description
double	consistency() Returns the consistency setting for the local Datastore emulator.
static LocalDatastoreHelper	create() Creates a local Datastore helper with a placeholder project ID and the default consistency setting of 0.9.
static LocalDatastoreHelper	create(double consistency) Creates a local Datastore helper with the specified settings for project ID and consistency.
DatastoreOptions	options() Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.
DatastoreOptions	options(String namespace) Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.
String	projectId() Returns the project ID associated with this local Datastore emulator.
static boolean	sendQuitRequest(int port)
void	start() Starts the local Datastore emulator.
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

sendQuitRequest

public static boolean sendQuitRequest(int port)

stop

public void stop()
          throws IOException,
                 InterruptedException

Throws:

IOException

InterruptedException

options

public DatastoreOptions options()

Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.

options

public DatastoreOptions options(String namespace)

Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost. The default namespace is set to namespace.

projectId

public String projectId()

Returns the project ID associated with this local Datastore emulator.

consistency

public double consistency()

Returns the consistency setting for the local Datastore emulator.

create

public static LocalDatastoreHelper create(double consistency)

Creates a local Datastore helper with the specified settings for project ID and consistency.

Parameters:

consistency - the fraction of Datastore writes that are immediately visible to global queries, with 0.0 meaning no writes are immediately visible and 1.0 meaning all writes are immediately visible. Note that setting this to 1.0 may mask incorrect assumptions about the consistency of non-ancestor queries; non-ancestor queries are eventually consistent.

create

public static LocalDatastoreHelper create()

Creates a local Datastore helper with a placeholder project ID and the default consistency setting of 0.9. Consistency refers to the fraction of Datastore writes that are immediately visible to global queries, with 0.0 meaning no writes are immediately visible and 1.0 meaning all writes are immediately visible.

start

public void start()
           throws IOException,
                  InterruptedException

Starts the local Datastore emulator. Leftover data from previous uses of the emulator will be removed.

Throws:

InterruptedException - if emulator-related tasks are interrupted

IOException - if there are socket exceptions or issues creating/deleting the temporary data folder