homeassistant.components.recorder Namespace Reference

Namespaces
	auto_repairs
	backup
	basic_websocket_api
	const
	core
	db_schema
	entity_registry
	executor
	filters
	history
	migration
	models
	pool
	purge
	queries
	repack
	services
	statistics
	system_health
	table_managers
	tasks
	util
	websocket_api

Functions
None	_async_setup_integration_platform (HomeAssistant hass, Recorder instance)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	is_entity_recorded (HomeAssistant hass, str entity_id)
Any	validate_db_url (str db_url)

Variables
	_LOGGER
	ALLOW_IN_MEMORY_DB
	CONF_AUTO_PURGE
	CONF_AUTO_REPACK
	CONF_COMMIT_INTERVAL
	CONF_DB_MAX_RETRIES
	CONF_DB_RETRY_WAIT
	CONF_DB_URL
	CONF_EVENT_TYPES
	CONF_EXCLUDE
	CONF_PURGE_INTERVAL
	CONF_PURGE_KEEP_DAYS
	CONFIG_SCHEMA
	default
	DEFAULT_COMMIT_INTERVAL
	DEFAULT_DB_FILE
	DEFAULT_DB_INTEGRITY_CHECK
	DEFAULT_DB_MAX_RETRIES
	DEFAULT_DB_RETRY_WAIT
	DEFAULT_URL
	DOMAIN
	EXCLUDE_SCHEMA
	extra
	FILTER_SCHEMA

Detailed Description

Support for recording details.

Function Documentation

_async_setup_integration_platform()

None homeassistant.components.recorder._async_setup_integration_platform ( HomeAssistant  hass, Recorder   instance  )

private

Set up a recorder integration platform.

Definition at line 180 of file __init__.py.

async_setup()

bool homeassistant.components.recorder.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the recorder.

Definition at line 134 of file __init__.py.

is_entity_recorded()

bool homeassistant.components.recorder.is_entity_recorded	(	HomeAssistant	hass,
		str	entity_id
	)

Check if an entity is being recorded.

Async friendly.

Definition at line 125 of file __init__.py.

validate_db_url()

Any homeassistant.components.recorder.validate_db_url

(

str

db_url

)

Validate database URL.

Definition at line 78 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.recorder._LOGGER

private

Definition at line 45 of file __init__.py.

ALLOW_IN_MEMORY_DB

homeassistant.components.recorder.ALLOW_IN_MEMORY_DB

Definition at line 75 of file __init__.py.

CONF_AUTO_PURGE

homeassistant.components.recorder.CONF_AUTO_PURGE

Definition at line 55 of file __init__.py.

CONF_AUTO_REPACK

homeassistant.components.recorder.CONF_AUTO_REPACK

Definition at line 56 of file __init__.py.

CONF_COMMIT_INTERVAL

homeassistant.components.recorder.CONF_COMMIT_INTERVAL

Definition at line 63 of file __init__.py.

CONF_DB_MAX_RETRIES

homeassistant.components.recorder.CONF_DB_MAX_RETRIES

Definition at line 58 of file __init__.py.

CONF_DB_RETRY_WAIT

homeassistant.components.recorder.CONF_DB_RETRY_WAIT

Definition at line 59 of file __init__.py.

CONF_DB_URL

homeassistant.components.recorder.CONF_DB_URL

Definition at line 57 of file __init__.py.

CONF_EVENT_TYPES

homeassistant.components.recorder.CONF_EVENT_TYPES

Definition at line 62 of file __init__.py.

CONF_EXCLUDE

homeassistant.components.recorder.CONF_EXCLUDE

Definition at line 71 of file __init__.py.

CONF_PURGE_INTERVAL

homeassistant.components.recorder.CONF_PURGE_INTERVAL

Definition at line 61 of file __init__.py.

CONF_PURGE_KEEP_DAYS

homeassistant.components.recorder.CONF_PURGE_KEEP_DAYS

Definition at line 60 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.recorder.CONFIG_SCHEMA

Definition at line 90 of file __init__.py.

default

homeassistant.components.recorder.default

Definition at line 71 of file __init__.py.

DEFAULT_COMMIT_INTERVAL

homeassistant.components.recorder.DEFAULT_COMMIT_INTERVAL

Definition at line 53 of file __init__.py.

DEFAULT_DB_FILE

homeassistant.components.recorder.DEFAULT_DB_FILE

Definition at line 49 of file __init__.py.

DEFAULT_DB_INTEGRITY_CHECK

homeassistant.components.recorder.DEFAULT_DB_INTEGRITY_CHECK

Definition at line 50 of file __init__.py.

DEFAULT_DB_MAX_RETRIES

homeassistant.components.recorder.DEFAULT_DB_MAX_RETRIES

Definition at line 51 of file __init__.py.

DEFAULT_DB_RETRY_WAIT

homeassistant.components.recorder.DEFAULT_DB_RETRY_WAIT

Definition at line 52 of file __init__.py.

DEFAULT_URL

homeassistant.components.recorder.DEFAULT_URL

Definition at line 48 of file __init__.py.

DOMAIN

homeassistant.components.recorder.DOMAIN

Definition at line 92 of file __init__.py.

EXCLUDE_SCHEMA

homeassistant.components.recorder.EXCLUDE_SCHEMA

Definition at line 66 of file __init__.py.

extra

homeassistant.components.recorder.extra

Definition at line 120 of file __init__.py.

FILTER_SCHEMA

homeassistant.components.recorder.FILTER_SCHEMA

Definition at line 70 of file __init__.py.