tortoise / tortoise/tortoise-orm

group_by produces invalid query on invalid input

Open
#1,088 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5.6k
Forks
516
Avg merge
2d 21h
Merged PRs (30d)
9

Description

Describe the bug
If I make a complex query with conditions that will not work, then instead of erroring Tortoise will change parts of the query in order to produce a valid but incorrect query.

To Reproduce

With the given table definition:

class MangaStat(Model):
    rowid = IntField(pk=True)
    id = UUIDField(null=False, index=True)
    time = DatetimeField(null=False)

    rating = DecimalField(6, 4, default=0)
    followers = IntField(null=False, default=0)

I tried to execute the code:

query = await MangaStat.all().annotate(cnt=Count("id")).filter(cnt__gt=20000).group_by("time").order_by("-time").limit(2)

The resulting SQL was:

SELECT "time", "rowid", "id", "rating", "followers", COUNT(*) "cnt"
FROM "mangastat"
GROUP BY "rowid"
HAVING COUNT(*) > 20000
ORDER BY "time" DESC

Expected behavior
The query manager should have thrown an exception when trying to run an invalid query instead of trying to fix it.

Additional context
If I manually changed rowid to time in the GROUP BY cause I got an error as expected.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the provided MangaStat model and annotated group_by query as the reproduction case, then inspect the query manager's handling of invalid GROUP BY input. Done means the query raises an exception instead of changing the GROUP BY to rowid and producing an incorrect query.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
database
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.