Skip to content

Commit b7a5c2f

Browse files
mziccardmziccard
committed
Update Datastore examples, snippets and READMEs to use renamed getters/setters/builders
1 parent c1deb59 commit b7a5c2f

16 files changed

Lines changed: 344 additions & 182 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,9 @@ import com.google.cloud.datastore.Key;
282282
import com.google.cloud.datastore.KeyFactory;
283283
284284
Datastore datastore = DatastoreOptions.defaultInstance().service();
285-
KeyFactory keyFactory = datastore.newKeyFactory().kind("keyKind");
285+
KeyFactory keyFactory = datastore.newKeyFactory().setKind("keyKind");
286286
Key key = keyFactory.newKey("keyName");
287-
Entity entity = Entity.builder(key)
287+
Entity entity = Entity.newBuilder(key)
288288
.set("name", "John Doe")
289289
.set("age", 30)
290290
.set("access_time", DateTime.now())
@@ -303,12 +303,12 @@ import com.google.cloud.datastore.Key;
303303
import com.google.cloud.datastore.KeyFactory;
304304
305305
Datastore datastore = DatastoreOptions.defaultInstance().service();
306-
KeyFactory keyFactory = datastore.newKeyFactory().kind("keyKind");
306+
KeyFactory keyFactory = datastore.newKeyFactory().setKind("keyKind");
307307
Key key = keyFactory.newKey("keyName");
308308
Entity entity = datastore.get(key);
309309
if (entity != null) {
310310
System.out.println("Updating access_time for " + entity.getString("name"));
311-
entity = Entity.builder(entity)
311+
entity = Entity.newBuilder(entity)
312312
.set("access_time", DateTime.now())
313313
.build();
314314
datastore.update(entity);

‎TESTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ You can test against a temporary local Datastore by following these steps:
8484

8585
2. Create and use a `Datastore` object with the options given by the `LocalDatastoreHelper` instance. For example:
8686
```java
87-
Datastore localDatastore = helper.options().service();
87+
Datastore localDatastore = helper.getOptions().service();
8888
```
8989

9090
3. Run your tests.

‎google-cloud-datastore/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Then add the following code to put an entity in Datastore.
9292
```java
9393
KeyFactory keyFactory = datastore.newKeyFactory().kind("Person");
9494
Key key = keyFactory.newKey("[email protected]");
95-
Entity entity = Entity.builder(key)
95+
Entity entity = Entity.newBuilder(key)
9696
.set("name", "John Doe")
9797
.set("age", 51)
9898
.set("favorite_food", "pizza")
@@ -126,9 +126,9 @@ import com.google.cloud.datastore.StructuredQuery.PropertyFilter;
126126
Then add the following code to your program:
127127

128128
```java
129-
Query<Entity> query = Query.entityQueryBuilder()
130-
.kind("Person")
131-
.filter(PropertyFilter.eq("favorite_food", "pizza"))
129+
Query<Entity> query = Query.newEntityQueryBuilder()
130+
.setKind("Person")
131+
.setFilter(PropertyFilter.eq("favorite_food", "pizza"))
132132
.build();
133133
QueryResults<Entity> results = datastore.run(query);
134134
while (results.hasNext()) {

‎google-cloud-datastore/src/main/java/com/google/cloud/datastore/Datastore.java‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ interface TransactionCallable<T> {
7676
* <pre> {@code
7777
* String keyName1 = "my_key_name_1";
7878
* String keyName2 = "my_key_name_2";
79-
* Key key1 = datastore.newKeyFactory().kind("MyKind").newKey(keyName1);
80-
* Key key2 = datastore.newKeyFactory().kind("MyKind").newKey(keyName2);
79+
* Key key1 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName1);
80+
* Key key2 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName2);
8181
* Batch batch = datastore.newBatch();
82-
* Entity entity1 = Entity.builder(key1).set("name", "John").build();
83-
* Entity entity2 = Entity.builder(key2).set("title", "title").build();
82+
* Entity entity1 = Entity.newBuilder(key1).set("name", "John").build();
83+
* Entity entity2 = Entity.newBuilder(key2).set("title", "title").build();
8484
* batch.add(entity1);
8585
* batch.add(entity2);
8686
* batch.submit();
@@ -96,7 +96,7 @@ interface TransactionCallable<T> {
9696
*
9797
* <p>Example of allocating an id.
9898
* <pre> {@code
99-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
99+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
100100
* IncompleteKey incompleteKey = keyFactory.newKey();
101101
*
102102
* // let cloud datastore automatically assign an id
@@ -112,7 +112,7 @@ interface TransactionCallable<T> {
112112
*
113113
* <p>Example of allocating multiple ids in a single batch.
114114
* <pre> {@code
115-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
115+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
116116
* IncompleteKey incompleteKey1 = keyFactory.newKey();
117117
* IncompleteKey incompleteKey2 = keyFactory.newKey();
118118
*
@@ -132,13 +132,13 @@ interface TransactionCallable<T> {
132132
* <pre> {@code
133133
* String keyName1 = "my_key_name_1";
134134
* String keyName2 = "my_key_name_2";
135-
* Key key1 = datastore.newKeyFactory().kind("MyKind").newKey(keyName1);
136-
* Entity.Builder entityBuilder1 = Entity.builder(key1);
135+
* Key key1 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName1);
136+
* Entity.Builder entityBuilder1 = Entity.newBuilder(key1);
137137
* entityBuilder1.set("propertyName", "updatedValue1");
138138
* Entity entity1 = entityBuilder1.build();
139139
*
140-
* Key key2 = datastore.newKeyFactory().kind("MyKind").newKey(keyName2);
141-
* Entity.Builder entityBuilder2 = Entity.builder(key2);
140+
* Key key2 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName2);
141+
* Entity.Builder entityBuilder2 = Entity.newBuilder(key2);
142142
* entityBuilder2.set("propertyName", "updatedValue2");
143143
* Entity entity2 = entityBuilder2.build();
144144
*
@@ -156,8 +156,8 @@ interface TransactionCallable<T> {
156156
* <p>Example of putting a single entity.
157157
* <pre> {@code
158158
* String keyName = "my_key_name";
159-
* Key key = datastore.newKeyFactory().kind("MyKind").newKey(keyName);
160-
* Entity.Builder entityBuilder = Entity.builder(key);
159+
* Key key = datastore.newKeyFactory().setKind("MyKind").newKey(keyName);
160+
* Entity.Builder entityBuilder = Entity.newBuilder(key);
161161
* entityBuilder.set("propertyName", "value");
162162
* Entity entity = entityBuilder.build();
163163
* datastore.put(entity);
@@ -175,13 +175,13 @@ interface TransactionCallable<T> {
175175
* <pre> {@code
176176
* String keyName1 = "my_key_name1";
177177
* String keyName2 = "my_key_name2";
178-
* Key key1 = datastore.newKeyFactory().kind("MyKind").newKey(keyName1);
179-
* Entity.Builder entityBuilder1 = Entity.builder(key1);
178+
* Key key1 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName1);
179+
* Entity.Builder entityBuilder1 = Entity.newBuilder(key1);
180180
* entityBuilder1.set("propertyName", "value1");
181181
* Entity entity1 = entityBuilder1.build();
182182
*
183-
* Key key2 = datastore.newKeyFactory().kind("MyKind").newKey(keyName2);
184-
* Entity.Builder entityBuilder2 = Entity.builder(key2);
183+
* Key key2 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName2);
184+
* Entity.Builder entityBuilder2 = Entity.newBuilder(key2);
185185
* entityBuilder2.set("propertyName", "value2");
186186
* Entity entity2 = entityBuilder2.build();
187187
*
@@ -200,8 +200,8 @@ interface TransactionCallable<T> {
200200
* <pre> {@code
201201
* String keyName1 = "my_key_name1";
202202
* String keyName2 = "my_key_name2";
203-
* Key key1 = datastore.newKeyFactory().kind("MyKind").newKey(keyName1);
204-
* Key key2 = datastore.newKeyFactory().kind("MyKind").newKey(keyName2);
203+
* Key key1 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName1);
204+
* Key key2 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName2);
205205
* datastore.delete(key1, key2);
206206
* }</pre>
207207
*
@@ -228,7 +228,7 @@ interface TransactionCallable<T> {
228228
* <p>Example of getting an entity.
229229
* <pre> {@code
230230
* String keyName = "my_key_name";
231-
* Key key = datastore.newKeyFactory().kind("MyKind").newKey(keyName);
231+
* Key key = datastore.newKeyFactory().setKind("MyKind").newKey(keyName);
232232
* Entity entity = datastore.get(key);
233233
* // Do something with the entity
234234
* }</pre>
@@ -248,7 +248,7 @@ interface TransactionCallable<T> {
248248
* <pre> {@code
249249
* String firstKeyName = "my_first_key_name";
250250
* String secondKeyName = "my_second_key_name";
251-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
251+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
252252
* Key firstKey = keyFactory.newKey(firstKeyName);
253253
* Key secondKey = keyFactory.newKey(secondKeyName);
254254
* Iterator<Entity> entitiesIterator = datastore.get(Lists.newArrayList(firstKey, secondKey));
@@ -274,7 +274,7 @@ interface TransactionCallable<T> {
274274
* <pre> {@code
275275
* String firstKeyName = "my_first_key_name";
276276
* String secondKeyName = "my_second_key_name";
277-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
277+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
278278
* Key firstKey = keyFactory.newKey(firstKeyName);
279279
* Key secondKey = keyFactory.newKey(secondKeyName);
280280
* List<Entity> entities = datastore.fetch(Lists.newArrayList(firstKey, secondKey));
@@ -293,8 +293,8 @@ interface TransactionCallable<T> {
293293
* <p>Example of running a query to find all entities of one kind.
294294
* <pre> {@code
295295
* String kind = "my_kind";
296-
* StructuredQuery<Entity> query = Query.entityQueryBuilder()
297-
* .kind(kind)
296+
* StructuredQuery<Entity> query = Query.newEntityQueryBuilder()
297+
* .setKind(kind)
298298
* .build();
299299
* QueryResults<Entity> results = datastore.run(query);
300300
* List<Entity> entities = Lists.newArrayList();
@@ -310,9 +310,9 @@ interface TransactionCallable<T> {
310310
* String kind = "my_kind";
311311
* String property = "my_property";
312312
* String value = "my_value";
313-
* StructuredQuery<Entity> query = Query.entityQueryBuilder()
314-
* .kind(kind)
315-
* .filter(PropertyFilter.eq(property, value))
313+
* StructuredQuery<Entity> query = Query.newEntityQueryBuilder()
314+
* .setKind(kind)
315+
* .setFilter(PropertyFilter.eq(property, value))
316316
* .build();
317317
* QueryResults<Entity> results = datastore.run(query);
318318
* List<Entity> entities = Lists.newArrayList();

‎google-cloud-datastore/src/main/java/com/google/cloud/datastore/Query.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ public static GqlQuery.Builder<?> gqlQueryBuilder(String gql) {
205205
* <pre> {@code
206206
* String kind = "my_kind";
207207
* String gqlQuery = "select * from " + kind;
208-
* Query<?> query = Query.gqlQueryBuilder(gqlQuery).build();
208+
* Query<?> query = Query.newGqlQueryBuilder(gqlQuery).build();
209209
* QueryResults<?> results = datastore.run(query);
210210
* // Use results
211211
* }</pre>
@@ -242,7 +242,7 @@ public static <V> GqlQuery.Builder<V> gqlQueryBuilder(ResultType<V> resultType,
242242
* <pre> {@code
243243
* String kind = "my_kind";
244244
* String gqlQuery = "select * from " + kind;
245-
* Query<Entity> query = Query.gqlQueryBuilder(Query.ResultType.ENTITY, gqlQuery).build();
245+
* Query<Entity> query = Query.newGqlQueryBuilder(Query.ResultType.ENTITY, gqlQuery).build();
246246
* QueryResults<Entity> results = datastore.run(query);
247247
* // Use results
248248
* }</pre>
@@ -259,7 +259,7 @@ public static <V> GqlQuery.Builder<V> newGqlQueryBuilder(ResultType<V> resultTyp
259259
* <p>Example of creating and running an entity query.
260260
* <pre> {@code
261261
* String kind = "my_kind";
262-
* Query<Entity> query = Query.entityQueryBuilder().kind(kind).build();
262+
* Query<Entity> query = Query.entityQueryBuilder().setKind(kind).build();
263263
* QueryResults<Entity> results = datastore.run(query);
264264
* // Use results
265265
* }</pre>
@@ -276,7 +276,7 @@ public static EntityQuery.Builder entityQueryBuilder() {
276276
* <p>Example of creating and running an entity query.
277277
* <pre> {@code
278278
* String kind = "my_kind";
279-
* Query<Entity> query = Query.entityQueryBuilder().kind(kind).build();
279+
* Query<Entity> query = Query.newEntityQueryBuilder().setKind(kind).build();
280280
* QueryResults<Entity> results = datastore.run(query);
281281
* // Use results
282282
* }</pre>
@@ -292,7 +292,7 @@ public static EntityQuery.Builder newEntityQueryBuilder() {
292292
* <p>Example of creating and running a key query.
293293
* <pre> {@code
294294
* String kind = "my_kind";
295-
* Query<Key> query = Query.keyQueryBuilder().kind(kind).build();
295+
* Query<Key> query = Query.keyQueryBuilder().setKind(kind).build();
296296
* QueryResults<Key> results = datastore.run(query);
297297
* // Use results
298298
* }</pre>
@@ -309,7 +309,7 @@ public static KeyQuery.Builder keyQueryBuilder() {
309309
* <p>Example of creating and running a key query.
310310
* <pre> {@code
311311
* String kind = "my_kind";
312-
* Query<Key> query = Query.keyQueryBuilder().kind(kind).build();
312+
* Query<Key> query = Query.newKeyQueryBuilder().setKind(kind).build();
313313
* QueryResults<Key> results = datastore.run(query);
314314
* // Use results
315315
* }</pre>
@@ -327,7 +327,7 @@ public static KeyQuery.Builder newKeyQueryBuilder() {
327327
* String kind = "my_kind";
328328
* String property = "my_property";
329329
* Query<ProjectionEntity> query = Query.projectionEntityQueryBuilder()
330-
* .kind(kind)
330+
* .setKind(kind)
331331
* .addProjection(property)
332332
* .build();
333333
* QueryResults<ProjectionEntity> results = datastore.run(query);
@@ -347,8 +347,8 @@ public static ProjectionEntityQuery.Builder projectionEntityQueryBuilder() {
347347
* <pre> {@code
348348
* String kind = "my_kind";
349349
* String property = "my_property";
350-
* Query<ProjectionEntity> query = Query.projectionEntityQueryBuilder()
351-
* .kind(kind)
350+
* Query<ProjectionEntity> query = Query.newProjectionEntityQueryBuilder()
351+
* .setKind(kind)
352352
* .addProjection(property)
353353
* .build();
354354
* QueryResults<ProjectionEntity> results = datastore.run(query);

‎google-cloud-datastore/src/main/java/com/google/cloud/datastore/Transaction.java‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ interface Response {
7979
* <p>Example of getting an entity for a given key.
8080
* <pre> {@code
8181
* String keyName = "my_key_name";
82-
* Key key = datastore.newKeyFactory().kind("MyKind").newKey(keyName);
82+
* Key key = datastore.newKeyFactory().setKind("MyKind").newKey(keyName);
8383
* Entity entity = transaction.get(key);
8484
* transaction.commit();
8585
* // Do something with the entity
@@ -100,7 +100,7 @@ interface Response {
100100
* <pre> {@code
101101
* String firstKeyName = "my_first_key_name";
102102
* String secondKeyName = "my_second_key_name";
103-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
103+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
104104
* Key firstKey = keyFactory.newKey(firstKeyName);
105105
* Key secondKey = keyFactory.newKey(secondKeyName);
106106
* Iterator<Entity> entitiesIterator = transaction.get(firstKey, secondKey);
@@ -128,7 +128,7 @@ interface Response {
128128
* <pre> {@code
129129
* String firstKeyName = "my_first_key_name";
130130
* String secondKeyName = "my_second_key_name";
131-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
131+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
132132
* Key firstKey = keyFactory.newKey(firstKeyName);
133133
* Key secondKey = keyFactory.newKey(secondKeyName);
134134
* List<Entity> entities = transaction.fetch(firstKey, secondKey);
@@ -153,12 +153,12 @@ interface Response {
153153
* <p>Example of running a query to find all entities with an ancestor.
154154
* <pre> {@code
155155
* String parentKeyName = "my_parent_key_name";
156-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("ParentKind");
156+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("ParentKind");
157157
* Key parentKey = keyFactory.newKey(parentKeyName);
158158
* // Build a query
159-
* Query<Entity> query = Query.entityQueryBuilder()
160-
* .kind("MyKind")
161-
* .filter(PropertyFilter.hasAncestor(parentKey))
159+
* Query<Entity> query = Query.newEntityQueryBuilder()
160+
* .setKind("MyKind")
161+
* .setFilter(PropertyFilter.hasAncestor(parentKey))
162162
* .build();
163163
* QueryResults<Entity> results = transaction.run(query);
164164
* List<Entity> entities = Lists.newArrayList();
@@ -181,9 +181,9 @@ interface Response {
181181
* <p>Example of committing a transaction.
182182
* <pre> {@code
183183
* // create an entity
184-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
184+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
185185
* Key key = datastore.allocateId(keyFactory.newKey());
186-
* Entity entity = Entity.builder(key).set("description", "commit()").build();
186+
* Entity entity = Entity.newBuilder(key).set("description", "commit()").build();
187187
*
188188
* // add the entity and commit
189189
* try {
@@ -204,9 +204,9 @@ interface Response {
204204
* <p>Example of rolling back a transaction.
205205
* <pre> {@code
206206
* // create an entity
207-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
207+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
208208
* Key key = datastore.allocateId(keyFactory.newKey());
209-
* Entity entity = Entity.builder(key).set("description", "rollback()").build();
209+
* Entity entity = Entity.newBuilder(key).set("description", "rollback()").build();
210210
*
211211
* // add the entity and rollback
212212
* transaction.put(entity);
@@ -224,9 +224,9 @@ interface Response {
224224
* <p>Example of verifying if a transaction is active.
225225
* <pre> {@code
226226
* // create an entity
227-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
227+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
228228
* Key key = datastore.allocateId(keyFactory.newKey());
229-
* Entity entity = Entity.builder(key).set("description", "active()").build();
229+
* Entity entity = Entity.newBuilder(key).set("description", "active()").build();
230230
* // calling transaction.active() now would return true
231231
* try {
232232
* // add the entity and commit
@@ -253,9 +253,9 @@ interface Response {
253253
* <p>Example of verifying if a transaction is active.
254254
* <pre> {@code
255255
* // create an entity
256-
* KeyFactory keyFactory = datastore.newKeyFactory().kind("MyKind");
256+
* KeyFactory keyFactory = datastore.newKeyFactory().setKind("MyKind");
257257
* Key key = datastore.allocateId(keyFactory.newKey());
258-
* Entity entity = Entity.builder(key).set("description", "active()").build();
258+
* Entity entity = Entity.newBuilder(key).set("description", "active()").build();
259259
* // calling transaction.active() now would return true
260260
* try {
261261
* // add the entity and commit
@@ -264,7 +264,7 @@ interface Response {
264264
* } finally {
265265
* // if committing succeeded
266266
* // then transaction.active() will be false
267-
* if (transaction.active()) {
267+
* if (transaction.isActive()) {
268268
* // otherwise it's true and we need to rollback
269269
* transaction.rollback();
270270
* }

0 commit comments

Comments
 (0)