homeassistant.components.recorder.migration.EventsContextIDMigration Class Reference

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

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

Public Member Functions
DataMigrationStatus	migrate_data_impl (self, Recorder instance)
StatementLambdaElement	needs_migrate_query (self)
Public Member Functions inherited from homeassistant.components.recorder.migration.BaseMigrationWithQuery
DataMigrationStatus	needs_migrate_impl (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)
None	migration_done (self, Recorder instance, Session session)
bool	needs_migrate (self, Recorder instance, Session session)
Public Member Functions inherited from homeassistant.components.recorder.migration.BaseOffLineMigration
None	migrate_all (self, Recorder instance, Callable[[], Session] session_maker)
bool	migrate_data (self, Recorder instance)

Static Public Attributes
tuple	index_to_drop = ("events", "ix_events_context_id")
string	migration_id = "event_context_id_as_binary"
int	migration_version = 2
	required_schema_version = CONTEXT_ID_AS_BINARY_SCHEMA_VERSION
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

Migration to migrate events context_ids to binary format.

Definition at line 2446 of file migration.py.

Member Function Documentation

migrate_data_impl()

DataMigrationStatus homeassistant.components.recorder.migration.EventsContextIDMigration.migrate_data_impl	(		self,
		Recorder	instance
	)

Migrate events context_ids to use binary format, return True if completed.

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

Definition at line 2454 of file migration.py.

needs_migrate_query()

StatementLambdaElement homeassistant.components.recorder.migration.EventsContextIDMigration.needs_migrate_query

(

self

)

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

Reimplemented from homeassistant.components.recorder.migration.BaseMigrationWithQuery.

Definition at line 2484 of file migration.py.

Member Data Documentation

index_to_drop

tuple homeassistant.components.recorder.migration.EventsContextIDMigration.index_to_drop = ("events", "ix_events_context_id")

static

Definition at line 2452 of file migration.py.

migration_id

string homeassistant.components.recorder.migration.EventsContextIDMigration.migration_id = "event_context_id_as_binary"

static

Definition at line 2450 of file migration.py.

migration_version

int homeassistant.components.recorder.migration.EventsContextIDMigration.migration_version = 2

static

Definition at line 2451 of file migration.py.

required_schema_version

homeassistant.components.recorder.migration.EventsContextIDMigration.required_schema_version = CONTEXT_ID_AS_BINARY_SCHEMA_VERSION

static

Definition at line 2449 of file migration.py.

---

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

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