Skip to content

feat(query): add isnull operator for NULL checks #528

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.

Sign up for GitHub

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
joshdimanteto merged 3 commits into from
Mar 5, 2026
Merged

feat(query): add isnull operator for NULL checks #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f21d3b2
feat(query): add isnull operator for NULL checks
joshdimanteto Feb 23, 2026
6fca27b
Merge branch 'remove-older-python-versions-#517' into add-isnull-wher…
joshdimanteto Feb 24, 2026
9062880
update example schema #527
joshdimanteto Feb 24, 2026
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
13 changes: 13 additions & 0 deletions datagateway_api/src/datagateway_api/icat/filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ def create_filter(self):
where_filter = self.create_condition(self.field, "=", self.value)
elif self.operation in ["ne", "neq"]:
where_filter = self.create_condition(self.field, "!=", self.value)
elif self.operation == "isnull":
if self.value:
where_filter = self.create_condition(self.field, "IS NULL", None)
else:
where_filter = self.create_condition(self.field, "IS NOT NULL", None)
elif self.operation == "like":
where_filter = self.create_condition(self.field, "like", f"%{self.value}%")
elif self.operation == "ilike":
Expand Down Expand Up @@ -139,6 +144,14 @@ def create_condition(attribute_name, operator, value):
"""

conditions = {}

# Handle unary operators (IS NULL, IS NOT NULL)
normalized_op = operator.strip().upper()
if normalized_op in ("IS NULL", "IS NOT NULL"):
conditions[attribute_name] = normalized_op
log.debug("Unary condition in ICAT where filter, %s", conditions)
return conditions

# Removing quote marks when doing conditions with IN expressions or when a
# distinct filter is used in a request
jpql_value = (
Expand Down
6 changes: 6 additions & 0 deletions datagateway_api/src/swagger/initialise_spec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,11 @@ def initialise_datagateway_api_spec(spec):
},
},
},
{
"type": "object",
"title": "IS NULL",
"properties": {"isnull": {"type": "boolean"}},
},
{
"type": "object",
"title": "Substring equality",
Expand Down Expand Up @@ -157,6 +162,7 @@ def initialise_datagateway_api_spec(spec):
"examples": {
"eq": {"value": [{"id": {"eq": 1}}]},
"ne": {"value": [{"id": {"ne": 1}}]},
"isnull": {"value": [{"publicationDate": {"isnull": True}}]},
"like": {"value": [{"name": {"like": "dog"}}]},
"lt": {"value": [{"id": {"lt": 10}}]},
"lte": {"value": [{"id": {"lte": 50}}]},
Expand Down
2 changes: 2 additions & 0 deletions test/integration/datagateway_api/icat/filters/test_where_filter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ class TestICATWhereFilter:
[
pytest.param("eq", 5, ["%s = '5'"], id="equal"),
pytest.param("ne", 5, ["%s != '5'"], id="not equal (ne)"),
pytest.param("isnull", True, ["%s IS NULL"], id="isnull (true)"),
pytest.param("isnull", False, ["%s IS NOT NULL"], id="isnull (false)"),
pytest.param("neq", 5, ["%s != '5'"], id="not equal (neq)"),
pytest.param("like", 5, ["%s like '%%5%%'"], id="like"),
pytest.param("ilike", 5, ["UPPER(%s) like UPPER('%%5%%')"], id="ilike"),
Expand Down
Loading