Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.recorder.migration.BaseRunTimeMigration Class Reference
Inheritance diagram for homeassistant.components.recorder.migration.BaseRunTimeMigration:
[legend]
Collaboration diagram for homeassistant.components.recorder.migration.BaseRunTimeMigration:
[legend]

Public Member Functions

bool migrate_data (self, Recorder instance)
 
None queue_migration (self, Recorder instance, Session session)
 
- Public Member Functions inherited from homeassistant.components.recorder.migration.BaseMigration
None __init__ (self, int schema_version, dict[str, int] migration_changes)
 
DataMigrationStatus migrate_data_impl (self, Recorder instance)
 
None migration_done (self, Recorder instance, Session session)
 
bool needs_migrate (self, Recorder instance, Session session)
 
DataMigrationStatus needs_migrate_impl (self, Recorder instance, Session session)
 

Static Public Attributes

 task = MigrationTask
 
- Static Public Attributes inherited from homeassistant.components.recorder.migration.BaseMigration
int migration_version = 1
 
 None
 
int required_schema_version = 0
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.recorder.migration.BaseMigration
 migration_changes
 
 schema_version
 

Detailed Description

Base class for run time migrations.

Definition at line 2368 of file migration.py.

Member Function Documentation

◆ migrate_data()

bool homeassistant.components.recorder.migration.BaseRunTimeMigration.migrate_data (   self,
Recorder  instance 
)
Migrate some data, returns True if migration is completed.

Reimplemented from homeassistant.components.recorder.migration.BaseMigration.

Definition at line 2381 of file migration.py.

◆ queue_migration()

None homeassistant.components.recorder.migration.BaseRunTimeMigration.queue_migration (   self,
Recorder  instance,
Session  session 
)
Start migration if needed.

Definition at line 2373 of file migration.py.

Member Data Documentation

◆ task

homeassistant.components.recorder.migration.BaseRunTimeMigration.task = MigrationTask
static

Definition at line 2371 of file migration.py.


The documentation for this class was generated from the following file: