Skip to content

Identify the joined row by primary key when detecting orphaned rows - #178764

Open
soldier2008 wants to merge 1 commit into
home-assistant:devfrom
soldier2008:fix-recorder-orphan-detection
Open

Identify the joined row by primary key when detecting orphaned rows#178764
soldier2008 wants to merge 1 commit into
home-assistant:devfrom
soldier2008:fix-recorder-orphan-detection

Conversation

@soldier2008

@soldier2008 soldier2008 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Proposed change

Before deleting from event_data and state_attributes, purge subtracts the ids that are still referenced. Where a range scan is slow, currently PostgreSQL and older MariaDB, that question is answered by joining against one arbitrary row per id, picked by a correlated subquery on Events.time_fired_ts and States.last_updated_ts.

Both columns are nullable. When the picked row has no timestamp the equality never holds, the join matches nothing, and an id that events or states still point at is reported as unused. Purge then deletes it and a database enforcing the foreign key rejects the statement. One such row is enough to hide the id even when other rows with a timestamp reference it, since nothing pins down which row the subquery picks.

Selecting the primary key instead keeps the query shape, the correlation and the indexes it uses, and cannot be null. Rows without a timestamp exist on databases predating the timestamp migration, which is what the WHERE time_fired_ts is NULL backfill in migration.py is for.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue: Purge does not work #177871
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

The correlated subquery that picks one row per data_id and attributes_id
selected a timestamp column, and both are nullable. When the picked row
had no timestamp the equality never held, the join matched nothing, and a
row still referenced by events or states was reported as unused. Purge
then tried to delete it, which a database enforcing the foreign key
rejects.

Selecting the primary key keeps the query shape and cannot be null.
@soldier2008
soldier2008 requested a review from a team as a code owner August 11, 2026 17:04
Copilot AI balanced review requested due to automatic review settings August 11, 2026 17:04
@home-assistant

Copy link
Copy Markdown
Contributor

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (recorder) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of recorder can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign recorder Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Fixes recorder purge queries so referenced shared data is not misidentified as orphaned when timestamps are null.

Changes:

  • Uses non-null primary keys in correlated subqueries.
  • Adds regression tests for nullable timestamps.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
homeassistant/components/recorder/queries.py Identifies joined rows by primary key.
tests/components/recorder/test_queries.py Tests referenced IDs with null timestamps.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@@ -0,0 +1,94 @@
"""Tests for the recorder queries."""
data_id = data.data_id
for time_fired_ts in timestamps:
session.add(
Events(event_type_id=1, data_id=data_id, time_fired_ts=time_fired_ts)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants