Skip the sqlite quick_check on clean restarts (#38972)
This commit is contained in:
1 parent
05d54a60b0
commit
7c346c2f7c
3 files changed
+130
-6
No files matched your search
@@ -30,11 +30,18 @@ _LOGGER = logging.getLogger(__name__)
|
||||
|
||||
DB_TIMEZONE = "+00:00"
|
||||
|
||||
TABLE_EVENTS = "events"
|
||||
TABLE_STATES = "states"
|
||||
TABLE_RECORDER_RUNS = "recorder_runs"
|
||||
TABLE_SCHEMA_CHANGES = "schema_changes"
|
||||
|
||||
ALL_TABLES = [TABLE_EVENTS, TABLE_STATES, TABLE_RECORDER_RUNS, TABLE_SCHEMA_CHANGES]
|
||||
|
||||
|
||||
class Events(Base): # type: ignore
|
||||
"""Event history data."""
|
||||
|
||||
__tablename__ = "events"
|
||||
__tablename__ = TABLE_EVENTS
|
||||
event_id = Column(Integer, primary_key=True)
|
||||
event_type = Column(String(32))
|
||||
event_data = Column(Text)
|
||||
@@ -88,7 +95,7 @@ class Events(Base): # type: ignore
|
||||
class States(Base): # type: ignore
|
||||
"""State change history."""
|
||||
|
||||
__tablename__ = "states"
|
||||
__tablename__ = TABLE_STATES
|
||||
state_id = Column(Integer, primary_key=True)
|
||||
domain = Column(String(64))
|
||||
entity_id = Column(String(255))
|
||||
@@ -153,7 +160,7 @@ class States(Base): # type: ignore
|
||||
class RecorderRuns(Base): # type: ignore
|
||||
"""Representation of recorder run."""
|
||||
|
||||
__tablename__ = "recorder_runs"
|
||||
__tablename__ = TABLE_RECORDER_RUNS
|
||||
run_id = Column(Integer, primary_key=True)
|
||||
start = Column(DateTime(timezone=True), default=dt_util.utcnow)
|
||||
end = Column(DateTime(timezone=True))
|
||||
@@ -191,7 +198,7 @@ class RecorderRuns(Base): # type: ignore
|
||||
class SchemaChanges(Base): # type: ignore
|
||||
"""Representation of schema version changes."""
|
||||
|
||||
__tablename__ = "schema_changes"
|
||||
__tablename__ = TABLE_SCHEMA_CHANGES
|
||||
change_id = Column(Integer, primary_key=True)
|
||||
schema_version = Column(Integer)
|
||||
changed = Column(DateTime(timezone=True), default=dt_util.utcnow)
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
"""SQLAlchemy util functions."""
|
||||
from contextlib import contextmanager
|
||||
from datetime import timedelta
|
||||
import logging
|
||||
import os
|
||||
import time
|
||||
@@ -9,6 +10,7 @@ from sqlalchemy.exc import OperationalError, SQLAlchemyError
|
||||
import homeassistant.util.dt as dt_util
|
||||
|
||||
from .const import DATA_INSTANCE, SQLITE_URL_PREFIX
|
||||
from .models import ALL_TABLES, process_timestamp
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
@@ -16,6 +18,11 @@ RETRIES = 3
|
||||
QUERY_RETRY_WAIT = 0.1
|
||||
SQLITE3_POSTFIXES = ["", "-wal", "-shm"]
|
||||
|
||||
# This is the maximum time after the recorder ends the session
|
||||
# before we no longer consider startup to be a "restart" and we
|
||||
# should do a check on the sqlite3 database.
|
||||
MAX_RESTART_TIME = timedelta(minutes=6)
|
||||
|
||||
|
||||
@contextmanager
|
||||
def session_scope(*, hass=None, session=None):
|
||||
@@ -116,13 +123,42 @@ def validate_or_move_away_sqlite_database(dburl: str) -> bool:
|
||||
return True
|
||||
|
||||
|
||||
def last_run_was_recently_clean(cursor):
|
||||
"""Verify the last recorder run was recently clean."""
|
||||
|
||||
cursor.execute("SELECT end FROM recorder_runs ORDER BY start DESC LIMIT 1;")
|
||||
end_time = cursor.fetchone()
|
||||
|
||||
if not end_time or not end_time[0]:
|
||||
return False
|
||||
|
||||
last_run_end_time = process_timestamp(dt_util.parse_datetime(end_time[0]))
|
||||
now = dt_util.utcnow()
|
||||
|
||||
_LOGGER.debug("The last run ended at: %s (now: %s)", last_run_end_time, now)
|
||||
|
||||
if last_run_end_time + MAX_RESTART_TIME < now:
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def basic_sanity_check(cursor):
|
||||
"""Check tables to make sure select does not fail."""
|
||||
|
||||
for table in ALL_TABLES:
|
||||
cursor.execute(f"SELECT * FROM {table} LIMIT 1;") # sec: not injection
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def validate_sqlite_database(dbpath: str) -> bool:
|
||||
"""Run a quick check on an sqlite database to see if it is corrupt."""
|
||||
import sqlite3 # pylint: disable=import-outside-toplevel
|
||||
|
||||
try:
|
||||
conn = sqlite3.connect(dbpath)
|
||||
conn.cursor().execute("PRAGMA QUICK_CHECK")
|
||||
run_checks_on_open_db(dbpath, conn.cursor())
|
||||
conn.close()
|
||||
except sqlite3.DatabaseError:
|
||||
_LOGGER.exception("The database at %s is corrupt or malformed.", dbpath)
|
||||
@@ -131,6 +167,20 @@ def validate_sqlite_database(dbpath: str) -> bool:
|
||||
return True
|
||||
|
||||
|
||||
def run_checks_on_open_db(dbpath, cursor):
|
||||
"""Run checks that will generate a sqlite3 exception if there is corruption."""
|
||||
if basic_sanity_check(cursor) and last_run_was_recently_clean(cursor):
|
||||
_LOGGER.debug(
|
||||
"The quick_check will be skipped as the system was restarted cleanly and passed the basic sanity check"
|
||||
)
|
||||
return
|
||||
|
||||
_LOGGER.debug(
|
||||
"A quick_check is being performed on the sqlite3 database at %s", dbpath
|
||||
)
|
||||
cursor.execute("PRAGMA QUICK_CHECK")
|
||||
|
||||
|
||||
def _move_away_broken_database(dbfile: str) -> None:
|
||||
"""Move away a broken sqlite3 database."""
|
||||
|
||||
|
||||
Reference in new issue
Block a user