-
Notifications
You must be signed in to change notification settings - Fork 50
docs: adds OR filter sample #1032
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
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
1f34f87
docs: adds OR filter sample
telpirion 906f62a
cleanup
telpirion ba7925a
per linter
telpirion 4f69893
more linting
telpirion 3f95c56
per reviewers
telpirion 8dbf300
per linter
telpirion 84d1e7f
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] d6b349b
per reviewer; add test setup/teardown
telpirion 3a0ec9f
better exception check
telpirion 639b970
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] 67fc3e3
Merge branch 'or-filter' of https://github.com/googleapis/java-datast…
gcf-owl-bot[bot] 26923ab
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] 09643ab
Merge branch 'or-filter' of https://github.com/googleapis/java-datast…
gcf-owl-bot[bot] 6bac4d9
per linter
telpirion File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
samples/snippets/src/main/java/com/example/datastore/filters/OrFilterQuery.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * Copyright 2023 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: Create a union between two filters | ||
| // description: Create a union between two filters (logical OR operator) | ||
|
|
||
| // [START datastore_query_filter_or] | ||
| 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.Filter; | ||
| import com.google.cloud.datastore.StructuredQuery.PropertyFilter; | ||
|
|
||
| public class OrFilterQuery { | ||
| public static void invoke() throws Exception { | ||
|
|
||
| // Instantiates a client | ||
| Datastore datastore = DatastoreOptions.getDefaultInstance().getService(); | ||
| String propertyName = "description"; | ||
|
|
||
| // Create the two filters | ||
| Filter orFilter = | ||
| CompositeFilter.or( | ||
| PropertyFilter.eq(propertyName, "Feed cats"), | ||
| PropertyFilter.eq(propertyName, "Buy milk")); | ||
|
|
||
| // Build the query | ||
| Query<Entity> query = Query.newEntityQueryBuilder().setKind("Task").setFilter(orFilter).build(); | ||
|
|
||
| // Get the results back from Datastore | ||
| QueryResults<Entity> results = datastore.run(query); | ||
|
|
||
| if (!results.hasNext()) { | ||
| throw new Exception("query yielded no results"); | ||
| } | ||
|
|
||
| while (results.hasNext()) { | ||
| Entity entity = results.next(); | ||
| System.out.printf("Entity: %s%n", entity); | ||
| } | ||
| } | ||
| } | ||
| // [END datastore_query_filter_or] | ||
70 changes: 70 additions & 0 deletions
70
samples/snippets/src/test/java/com/example/datastore/OrFilterQuerySampleIT.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* | ||
| * Copyright 2023 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; | ||
|
|
||
| import com.example.datastore.filters.OrFilterQuery; | ||
| 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.rule.SystemsOutRule; | ||
| 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 OrFilterQuerySampleIT { | ||
|
|
||
| private final Datastore datastore = DatastoreOptions.getDefaultInstance().getService(); | ||
| private final String fieldName = "description"; | ||
|
|
||
| private Key taskKey1; | ||
| private Key taskKey2; | ||
|
|
||
| @Rule public final SystemsOutRule systemsOutRule = new SystemsOutRule(); | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| taskKey1 = datastore.newKeyFactory().setKind("Task").newKey("sampleTask"); | ||
| Entity task1 = Entity.newBuilder(taskKey1).set(fieldName, "Buy milk").build(); | ||
|
|
||
| taskKey2 = datastore.newKeyFactory().setKind("Task").newKey("sampleTask2"); | ||
| Entity task2 = Entity.newBuilder(taskKey2).set(fieldName, "Feed cats").build(); | ||
|
|
||
| datastore.put(task1); | ||
| datastore.put(task2); | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() { | ||
| datastore.delete(taskKey1); | ||
| datastore.delete(taskKey2); | ||
| } | ||
|
|
||
| @Test | ||
| public void testOrFilterQuery() throws Exception { | ||
| // Act | ||
| OrFilterQuery.invoke(); | ||
|
|
||
| // Assert | ||
| systemsOutRule.assertContains("Entity"); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.