homeassistant.helpers.recorder Namespace Reference

Classes
class	RecorderData

Functions
None	async_initialize_recorder (HomeAssistant hass)
bool	async_migration_in_progress (HomeAssistant hass)
bool	async_migration_is_live (HomeAssistant hass)
bool	async_wait_recorder (HomeAssistant hass)
Recorder	get_instance (HomeAssistant hass)
Generator[Session]	session_scope (*HomeAssistant|None hass=None, Session|None session=None, Callable[[Exception], bool]|None exception_filter=None, bool read_only=False)

Variables
	_LOGGER = logging.getLogger(__name__)

Detailed Description

Helpers to check recorder.

Function Documentation

async_initialize_recorder()

None homeassistant.helpers.recorder.async_initialize_recorder

(

HomeAssistant

hass

)

Initialize recorder data.

Definition at line 54 of file recorder.py.

async_migration_in_progress()

bool homeassistant.helpers.recorder.async_migration_in_progress

(

HomeAssistant

hass

)

Check to see if a recorder migration is in progress.

Definition at line 36 of file recorder.py.

async_migration_is_live()

bool homeassistant.helpers.recorder.async_migration_is_live

(

HomeAssistant

hass

)

Check to see if a recorder migration is live.

Definition at line 45 of file recorder.py.

async_wait_recorder()

bool homeassistant.helpers.recorder.async_wait_recorder

(

HomeAssistant

hass

)

Wait for recorder to initialize and return connection status.

Returns False immediately if the recorder is not enabled.

Definition at line 63 of file recorder.py.

get_instance()

Recorder homeassistant.helpers.recorder.get_instance

(

HomeAssistant

hass

)

Get the recorder instance.

Definition at line 74 of file recorder.py.

session_scope()

Generator[Session] homeassistant.helpers.recorder.session_scope	(	*HomeAssistant | None	hass = None,
		Session | None	session = None,
		Callable[[Exception], bool] | None	exception_filter = None,
		bool	read_only = False
	)

Provide a transactional scope around a series of operations.

read_only is used to indicate that the session is only used for reading
data and that no commit is required. It does not prevent the session
from writing and is not a security measure.

Definition at line 80 of file recorder.py.

Variable Documentation

_LOGGER

homeassistant.helpers.recorder._LOGGER = logging.getLogger(__name__)

private

Definition at line 21 of file recorder.py.