Skip to content
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.

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

Allow home assistant backups to exclude database #4591

Merged
merged 2 commits into from
Oct 11, 2023
Merged

Conversation

mdegat01
Copy link
Contributor

@mdegat01 mdegat01 commented Sep 29, 2023

Proposed change

Recent releases of Home Assistant have improved the default database option to the point where its performance has surpassed that of the MariaDB add-on in most if not all cases. In addition to fixing the consistency issues created by backups.

One of the remaining reasons given by users for continuing to use the add-on over the default option is inability to exclude the often quite large database file from their backups, whereas an add-on can easily be excluded. This PR adds an option to exclude the database file when making a backup of Home Assistant. It also includes a new setting which allows the database to be excluded by default to handle times when there's no space for options (like the partial backup on update).

Limitation - it only works for the default database file. Users can move or rename this file using the database options, if they do so it will not be excluded as supervisor does not look at or understand Home Assistant config.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • 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
  • The code has been formatted using Black (black --fast supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints of add-on configuration are added/changed:

@mdegat01 mdegat01 requested review from pvizeli and agners September 29, 2023 19:17
@mdegat01 mdegat01 added missing-documentation Added to pull requests that needs a docs, but none is linked need-cli Added to pull requests that need cli changes but none is linked new-feature A new feature labels Sep 29, 2023
@mdegat01 mdegat01 removed the need-cli Added to pull requests that need cli changes but none is linked label Sep 29, 2023
@mdegat01 mdegat01 removed the missing-documentation Added to pull requests that needs a docs, but none is linked label Sep 30, 2023
Co-authored-by: Pascal Vizeli <[email protected]>
@pvizeli pvizeli merged commit 994c981 into main Oct 11, 2023
22 checks passed
@pvizeli pvizeli deleted the allow-backups-skip-db branch October 11, 2023 06:52
@github-actions github-actions bot locked and limited conversation to collaborators Oct 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants