103 lines
4.0 KiB
Python
103 lines
4.0 KiB
Python
"""Purge old data helper."""
|
|
from datetime import timedelta
|
|
import logging
|
|
import time
|
|
|
|
from sqlalchemy.exc import OperationalError, SQLAlchemyError
|
|
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
from .models import Events, RecorderRuns, States
|
|
from .util import execute, session_scope
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def purge_old_data(instance, purge_days: int, repack: bool) -> bool:
|
|
"""Purge events and states older than purge_days ago.
|
|
|
|
Cleans up an timeframe of an hour, based on the oldest record.
|
|
"""
|
|
purge_before = dt_util.utcnow() - timedelta(days=purge_days)
|
|
_LOGGER.debug("Purging states and events before target %s", purge_before)
|
|
|
|
try:
|
|
with session_scope(session=instance.get_session()) as session:
|
|
# Purge a max of 1 hour, based on the oldest states or events record
|
|
batch_purge_before = purge_before
|
|
|
|
query = session.query(States).order_by(States.last_updated.asc()).limit(1)
|
|
states = execute(query, to_native=True, validate_entity_ids=False)
|
|
if states:
|
|
batch_purge_before = min(
|
|
batch_purge_before,
|
|
states[0].last_updated + timedelta(hours=1),
|
|
)
|
|
|
|
query = session.query(Events).order_by(Events.time_fired.asc()).limit(1)
|
|
events = execute(query, to_native=True)
|
|
if events:
|
|
batch_purge_before = min(
|
|
batch_purge_before,
|
|
events[0].time_fired + timedelta(hours=1),
|
|
)
|
|
|
|
_LOGGER.debug("Purging states and events before %s", batch_purge_before)
|
|
|
|
deleted_rows = (
|
|
session.query(States)
|
|
.filter(States.last_updated < batch_purge_before)
|
|
.delete(synchronize_session=False)
|
|
)
|
|
_LOGGER.debug("Deleted %s states", deleted_rows)
|
|
|
|
deleted_rows = (
|
|
session.query(Events)
|
|
.filter(Events.time_fired < batch_purge_before)
|
|
.delete(synchronize_session=False)
|
|
)
|
|
_LOGGER.debug("Deleted %s events", deleted_rows)
|
|
|
|
# If states or events purging isn't processing the purge_before yet,
|
|
# return false, as we are not done yet.
|
|
if batch_purge_before != purge_before:
|
|
_LOGGER.debug("Purging hasn't fully completed yet")
|
|
return False
|
|
|
|
# Recorder runs is small, no need to batch run it
|
|
deleted_rows = (
|
|
session.query(RecorderRuns)
|
|
.filter(RecorderRuns.start < purge_before)
|
|
.delete(synchronize_session=False)
|
|
)
|
|
_LOGGER.debug("Deleted %s recorder_runs", deleted_rows)
|
|
|
|
if repack:
|
|
# Execute sqlite or postgresql vacuum command to free up space on disk
|
|
if instance.engine.driver in ("pysqlite", "postgresql"):
|
|
_LOGGER.debug("Vacuuming SQL DB to free space")
|
|
instance.engine.execute("VACUUM")
|
|
# Optimize mysql / mariadb tables to free up space on disk
|
|
elif instance.engine.driver in ("mysqldb", "pymysql"):
|
|
_LOGGER.debug("Optimizing SQL DB to free space")
|
|
instance.engine.execute("OPTIMIZE TABLE states, events, recorder_runs")
|
|
|
|
except OperationalError as err:
|
|
# Retry when one of the following MySQL errors occurred:
|
|
# 1205: Lock wait timeout exceeded; try restarting transaction
|
|
# 1206: The total number of locks exceeds the lock table size
|
|
# 1213: Deadlock found when trying to get lock; try restarting transaction
|
|
if instance.engine.driver in ("mysqldb", "pymysql") and err.orig.args[0] in (
|
|
1205,
|
|
1206,
|
|
1213,
|
|
):
|
|
_LOGGER.info("%s; purge not completed, retrying", err.orig.args[1])
|
|
time.sleep(instance.db_retry_wait)
|
|
return False
|
|
|
|
_LOGGER.warning("Error purging history: %s", err)
|
|
except SQLAlchemyError as err:
|
|
_LOGGER.warning("Error purging history: %s", err)
|
|
return True
|