Skip to content

Add support for filter expression in GroupConcat #948

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Add support for filter expression in GroupConcat #948

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
537d035
Add support for filter expression in GroupConcat
caramdache Sep 14, 2022
452d3c8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 14, 2022
24c0e35
Update src/django_mysql/models/aggregates.py
caramdache Sep 14, 2022
97ea273
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 14, 2022
65b301c
Add missing name and allow_distinct variables
caramdache Sep 14, 2022
b3e4a2c
Add support for ordering and separator when filter is present
caramdache Sep 14, 2022
451597b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 14, 2022
96e7c9a
Fix bug introduced in legacy path
caramdache Sep 15, 2022
8c5c5e1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 15, 2022
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
12 changes: 11 additions & 1 deletion src/django_mysql/models/aggregates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ class GroupConcat(Aggregate):
def __init__(
self,
expression: Expression,
filter=None,
distinct: bool = False,
separator: str | None = None,
ordering: str | None = None,
Expand All @@ -38,7 +39,7 @@ def __init__(
# This can/will be improved to SetTextField or ListTextField
extra["output_field"] = CharField()

super().__init__(expression, **extra)
super().__init__(expression, filter=filter, **extra)

self.distinct = distinct
self.separator = separator
Expand All @@ -53,6 +54,15 @@ def as_sql(
connection: BaseDatabaseWrapper,
**extra_context: Any,
) -> tuple[str, tuple[Any, ...]]:
if self.filter:
extra_context["distinct"] = "DISTINCT " if self.distinct else ""
copy = self.copy()
copy.filter = None
source_expressions = copy.get_source_expressions()
condition = When(self.filter, then=source_expressions[0])
copy.set_source_expressions([Case(condition)] + source_expressions[1:])
return super(Aggregate, copy).as_sql(compiler, connection, **extra_context)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't looked into it, but it's a bit odd that you're skipping the existing implementation and calling super(). The implemetnation below covers the SQL oddities in GROUP_CONCAT, I think we'd still want to use it, just tweak adding the filter there.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we need keep the existing pathway in the long term. It's probably better to let Aggregate.as_sql() perform the work based on the template.

If you look at the code for Count, you'll see there are 2 paths, one when filter is set, the other when it's not. I think we should have a similar structure here, but avoid manual handcrafting as much as possible because this is likely fragile.


connection.ops.check_expression_support(self)
sql = ["GROUP_CONCAT("]
if self.distinct:
Expand Down