com.google.datastore.v1.client

Class LocalDevelopmentDatastore

java.lang.Object

com.google.datastore.v1.client.Datastore

com.google.datastore.v1.client.LocalDevelopmentDatastore

public class LocalDevelopmentDatastore
extends Datastore

An extension to Datastore that provides lifecycle management for a development datastore server. In order to use a development datastore for a JUnit 4 test you might do something like this:

 public class MyTest {

   static LocalDevelopmentDatastore datastore;

    @BeforeClass
   public static void startLocalDatastore() throws LocalDevelopmentDatastoreException {
     DatastoreOptions opts = new DatastoreOptions.Builder()
         .localHost("localhost:8080")
         .projectId("my-project-id")
         .build();
     datastore = LocalDevelopmentDatastoreFactory.get().create(opts);
     datastore.start("/usr/local/gcd-sdk", "my-project-id");
   }

    @Before
   public void setUp() throws LocalDevelopmentDatastoreException {
     datastore.clear();
   }

    @AfterClass
   public static void stopLocalDatastore() throws LocalDevelopmentDatastoreException {
     datastore.stop();
   }

    @Test
   public void testFoo1() { }

    @Test
   public void testFoo2() { }

 }
 

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all data in the Datastore.
void	start(String sdkPath, String projectId, String... cmdLineOptions) Starts the local datastore.
void	stop() Stops the local datastore.

Methods inherited from class com.google.datastore.v1.client.Datastore

allocateIds, beginTransaction, commit, getRpcCount, lookup, resetRpcCount, rollback, runQuery

Methods inherited from class java.lang.Object

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

Method Detail

clear

public void clear()
           throws LocalDevelopmentDatastoreException

Clears all data in the Datastore.

Throws:

LocalDevelopmentDatastoreException

start

public void start(String sdkPath,
                  String projectId,
                  String... cmdLineOptions)
           throws LocalDevelopmentDatastoreException

Starts the local datastore. It is the caller's responsibility to call stop(). Note that receiving an exception does not indicate that the server did not start. We recommend calling stop() to ensure the server is not running regardless of the result of this method.

Parameters:

sdkPath - The path to the GCD SDK, eg /usr/local/dev/gcd

projectId - The GCD project ID

cmdLineOptions - Command line options to pass to the script that launches the dev server

Throws:

LocalDevelopmentDatastoreException - If start(java.lang.String, java.lang.String, java.lang.String...) has already been called or the server does not start successfully.

stop

public void stop()
          throws LocalDevelopmentDatastoreException

Stops the local datastore. Multiple calls are allowed.

Throws:

LocalDevelopmentDatastoreException