recorder component is storing details in a database which then are handled by the
Home Assistant uses SQLAlchemy as Object Relational Mapper (ORM). This means that you can now use any SQL backend for the recorder that is supported by SQLAlchemy, like MySQL, MariaDB, PostgreSQL, or MS SQL Server.
The default database engine is SQLite which doesn’t require any configuration. The database is stored in your Home Assistant configuration directory (
.homeassistant) and called
To setup the
recorder component in your installation, add the following to your
# Example configuration.yaml entry recorder:
(map)(Required)Enables the recorder component. Only allowed once.
(URL)(Optional)The URL which points to your database.
(int)(Optional)Specify the number of history days to keep in recorder database after a purge.
Default value: 10
(int)(Optional)How often (in days) the purge task runs. If a scheduled purge is missed (e.g., if Home Assistant was not running), the schedule will resume soon after Home Assistant restarts. You can use the service call
purgewhen required without impacting the purge schedule. If this is set to
0(zero), automatic purging is disabled.
Default value: 1
(map)(Optional)Configure which components should be excluded
(map)(Optional)Configure which components should be included in recordings. If set, all other entities will not be recorded.
Define domains and entities to
exclude (aka. blacklist). This is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like
weblink) or rarely change (
# Example configuration.yaml entry with exclude recorder: purge_keep_days: 5 db_url: sqlite:///home/user/.homeassistant/test exclude: domains: - automation - weblink - updater entities: - sun.sun # Don't record sun data - sensor.last_boot # Comes from 'systemmonitor' sensor platform - sensor.date
Define domains and entities to record by using the
include configuration (aka. whitelist). If you have a lot of entities in your system and your
exclude lists possibly get very large, it might be better just to define the entities or domains to record.
# Example configuration.yaml entry with include recorder: include: domains: - sensor - switch - media_player
include list to define the domains/entities to record, and exclude some of them with in the
exclude list. This makes sense if you for instance include the
sensor domain, but want to exclude some specific sensors. Instead of adding every sensor entity to the
entities list just include the
sensor domain and exclude the sensor entities you are not interested in.
# Example configuration.yaml entry with include and exclude recorder: include: domains: - sensor - switch - media_player exclude: entities: - sensor.last_boot - sensor.date
If you only want to hide events from e.g., your history, take a look at the
history component. Same goes for logbook. But if you have privacy concerns about certain events or neither want them in history or logbook, you should use the
include options of the
recorder component, that they aren’t even in your database. That way you can save storage and keep the database small by excluding certain often-logged events (like
Call the service
recorder.purge to start a purge task which deletes events and states older than x days, according to
keep_days service data.
|Service data attribute||Optional||Description|
||yes||The number of history days to keep in recorder database (defaults to the component
||yes||Rewrite the entire database, possibly saving some disk space (only supported for SQLite)|
recorder component is activated then some components support
restore_state which will restore the state of the entity after Home Assistant is started to the state before Home Assistant was stopped. Please make sure that you do not exclude the entities for which you want the state to be restored from your recordings. An incomplete list of components that currently support
|MS SQL Server||
If you use MariaDB 10 you need to add port 3307 to the SERVER_IP, e.g.,
+If you are running a database server instance on the same server as Home Assistant then you must ensure that this service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the service file.
$ sudo nano /email@example.com
and add the service for PostgreSQL:
Save the file then reload
$ sudo systemctl daemon-reload
Not all Python bindings for the chosen database engine can be installed directly. This section contains additional details which should help you to get it working.
If you are in a virtual environment, don’t forget to activate it before installing the
mysqlclient Python package described below.
pi@homeassistant:~ $ sudo su homeassistant -s /bin/bash homeassistant@homeassistant:~$ source /srv/homeassistant/bin/activate (homeassistant) homeassistant@homeassistant:~$ pip3 install mysqlclient
For MariaDB you may have to install a few dependencies. If you’re using MariaDB version 10.2, libmariadbclient-dev was renamed to libmariadb-dev, please install the correct package based on your MariaDB version.
On the Python side we use the
$ sudo apt-get install libmariadbclient-dev libssl-dev $ pip3 install mysqlclient
For MySQL you may have to install a few dependencies. You can choose between
$ sudo apt-get install default-libmysqlclient-dev libssl-dev $ pip3 install mysqlclient
After installing the dependencies, it is required to create the database manually. During the startup, Home Assistant will look for the database specified in the
db_url. If the database doesn’t exist, it will not automatically create it for you.
Once Home Assistant finds the database, with right level of permissions, all the required tables will then be automatically created and the data will be populated accordingly.
For PostgreSQL you may have to install a few dependencies:
$ sudo apt-get install postgresql-server-dev-X.Y $ pip3 install psycopg2
For MS SQL Server you may have to install a few dependencies:
$ sudo apt-get install freetds-dev $ pip3 install pymssql
If you are in a virtual environment, don’t forget to activate it before installing the pymssql package.
$ sudo su -s /bin/bash homeassistant $ source /srv/homeassistant/bin/activate $ pip3 install pymssql