Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add sample code for multiple inequalities filter #1577

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.datastore.filters;

// sample-metadata:
// title: Range and inequality filters on multiple properties
// description: The following query uses range filters on
// priority and days to return all tasks with priority greater
// than four and with less than three days to complete.

import com.google.cloud.datastore.Datastore;
import com.google.cloud.datastore.DatastoreOptions;
import com.google.cloud.datastore.Entity;
import com.google.cloud.datastore.Query;
import com.google.cloud.datastore.QueryResults;
import com.google.cloud.datastore.StructuredQuery.CompositeFilter;
import com.google.cloud.datastore.StructuredQuery.PropertyFilter;
kevkim-codes marked this conversation as resolved.
Show resolved Hide resolved
import java.util.ArrayList;
import java.util.List;

public class MultiIneqFilter {
public static void invoke() throws Exception {
Datastore datastore = DatastoreOptions.getDefaultInstance().getService();

// [START datastore_query_filter_compound_multi_ineq]
Query<Entity> query =
Query.newEntityQueryBuilder()
.setKind("Task")
.setFilter(
CompositeFilter.and(
PropertyFilter.gt("priority", 4), PropertyFilter.lt("days", 3)))
.build();
// [END datastore_query_filter_compound_multi_ineq]

// Get the results back from Datastore.
QueryResults<Entity> results = datastore.run(query);

if (!results.hasNext()) {
throw new Exception("query yielded no results");
}

List<Entity> entities = new ArrayList<>();
while (results.hasNext()) {
entities.add(results.next());
}

return entities;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.datastore.filters;

import com.google.cloud.datastore.Datastore;
import com.google.cloud.datastore.DatastoreOptions;
import com.google.cloud.datastore.Entity;
import com.google.cloud.datastore.Key;
import com.google.cloud.datastore.Query;
import com.google.cloud.datastore.StructuredQuery.CompositeFilter;
import com.google.cloud.datastore.StructuredQuery.PropertyFilter;
import com.rule.SystemsOutRule;
import java.util.ArrayList;
import java.util.List;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
@SuppressWarnings("checkstyle:abbreviationaswordinname")
public class MultiIneqFilterSampleIT {
private final Datastore datastore = DatastoreOptions.getDefaultInstance().getService();
private Key taskKey1;
private Key taskKey2;
private Key taskKey3;

@Rule
public final SystemsOutRule systemsOutRule = new SystemsOutRule();

@Before
public void setUp() {
taskKey1 = datastore.newKeyFactory().setKind("Task").newKey("key1");
Entity task1 = Entity.newBuilder(taskKey1)
.set("category", "Personal")
.set("done", false)
.set("priority", 4)
.set("days", 3)
.set("description", "Learn Cloud Datastore")
.build();

taskKey2 = datastore.newKeyFactory().setKind("Task").newKey("key2");
Entity task2 = Entity.newBuilder(taskKey2)
.set("category", "Personal")
.set("done", false)
.set("priority", 5)
.set("days", 5)
.set("description", "Integrate Cloud Datastore")
.build();

taskKey3 = datastore.newKeyFactory().setKind("Task").newKey("key3");
Entity task3 = Entity.newBuilder(taskKey3)
.set("category", "Personal")
.set("done", false)
.set("priority", 5)
.set("days", 2)
.set("description", "Set Up Cloud Datastore")
.build();

datastore.put(task1);
datastore.put(task2);
datastore.put(task3);
kevkim-codes marked this conversation as resolved.
Show resolved Hide resolved
}

@After
public void tearDown() {
datastore.delete(taskKey1);
datastore.delete(taskKey2);
datastore.delete(taskKey3);
}

@Test
public void testMultiIneqFilter() throws Exception {
List<Entity> results = MultiIneqFilter.invoke();

assertEquals(3, results.size());
assertEquals("Learn Cloud Datastore", results.get(0).getString("description"));
}
}
Loading