homeassistant.components.recorder.migration.BaseMigrationWithQuery Class Reference

Inheritance diagram for homeassistant.components.recorder.migration.BaseMigrationWithQuery:

Collaboration diagram for homeassistant.components.recorder.migration.BaseMigrationWithQuery:

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

Additional Inherited Members
Public Attributes inherited from homeassistant.components.recorder.migration.BaseMigration
	migration_changes
	schema_version
Static Public Attributes inherited from homeassistant.components.recorder.migration.BaseMigration
int	migration_version = 1
	None
int	required_schema_version = 0

Detailed Description

Base class for run time migrations.

Definition at line 2386 of file migration.py.

Member Function Documentation

needs_migrate_impl()

DataMigrationStatus homeassistant.components.recorder.migration.BaseMigrationWithQuery.needs_migrate_impl	(		self,
		Recorder	instance,
		Session	session
	)

Return if the migration needs to run.

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

Definition at line 2393 of file migration.py.

needs_migrate_query()

StatementLambdaElement homeassistant.components.recorder.migration.BaseMigrationWithQuery.needs_migrate_query

(

self

)

Return the query to check if the migration needs to run.

Reimplemented in homeassistant.components.recorder.migration.EntityIDPostMigration, homeassistant.components.recorder.migration.EntityIDMigration, homeassistant.components.recorder.migration.EventTypeIDMigration, homeassistant.components.recorder.migration.EventsContextIDMigration, and homeassistant.components.recorder.migration.StatesContextIDMigration.

Definition at line 2390 of file migration.py.

---

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

• core/homeassistant/components/recorder/migration.py