feat(datastore): adds query filter OR (GoogleCloudPlatform#9315)

telpirion · web-flow · commit c4d9c24b9fdb · 2023-03-24T12:20:01.000-07:00
* feat(datastore): adds query filter OR

* missed import

* moar missed import

* lint

* lint

* per reviewer

* lint

* per reviewer

* per reviewer

* linter
diff --git a/datastore/cloud-client/query_filter_or.py b/datastore/cloud-client/query_filter_or.py
@@ -0,0 +1,48 @@
+# 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
+#
+#    https://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.
+
+"""
+Builds a union (OR) query filter.
+
+See https://cloud.google.com/python/docs/reference/datastore/latest before running code.
+"""
+
+
+# [START datastore_query_filter_or]
+from google.cloud import datastore
+from google.cloud.datastore import query
+
+
+def query_filter_or(project_id: str) -> None:
+    """Builds a union of two queries (OR) filter.
+
+    Arguments:
+        project_id: your Google Cloud Project ID
+    """
+    client = datastore.Client(project=project_id)
+
+    or_query = client.query(kind="Task")
+    or_filter = query.Or(
+        [
+            query.PropertyFilter("description", "=", "Buy milk"),
+            query.PropertyFilter("description", "=", "Feed cats"),
+        ]
+    )
+
+    or_query.add_filter(filter=or_filter)
+
+    results = or_query.fetch()
+    for result in results:
+        print(result["description"])
+# [END datastore_query_filter_or]
diff --git a/datastore/cloud-client/query_filter_or_test.py b/datastore/cloud-client/query_filter_or_test.py
@@ -0,0 +1,48 @@
+# 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
+#
+#    https://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.
+
+import os
+
+from google.cloud import datastore
+import pytest
+
+from query_filter_or import query_filter_or
+
+PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]
+
+
+@pytest.fixture()
+def entities():
+    client = datastore.Client(project=PROJECT_ID)
+
+    task_key = client.key("Task")
+    task1 = datastore.Entity(key=task_key)
+    task1["description"] = "Buy milk"
+    client.put(task1)
+
+    task_key2 = client.key("Task")
+    task2 = datastore.Entity(key=task_key2)
+    task2["description"] = "Feed cats"
+    client.put(task2)
+
+    yield entities
+
+    client.delete(task1)
+    client.delete(task2)
+
+
+def test_query_filter_or(capsys, entities):
+    query_filter_or(project_id=PROJECT_ID)
+    out, _ = capsys.readouterr()
+    assert "Feed cats" in out
diff --git a/datastore/cloud-client/requirements.txt b/datastore/cloud-client/requirements.txt
@@ -1 +1 @@
-google-cloud-datastore==2.7.1
+google-cloud-datastore==2.15.0

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-google-cloud-datastore==2.7.1`
	`1`	`+google-cloud-datastore==2.15.0`