home-assistant.io/source/_integrations/sql.markdown

title	description	ha_category	ha_release	ha_iot_class	ha_config_flow	ha_codeowners	ha_domain	ha_platforms	ha_integration_type
SQL	Instructions how to integrate SQL sensors into Home Assistant.	Sensor Utility	0.63	Local Polling	true	@dgomes @gjohansson-ST	sql	sensor	integration

The sql sensor platform enables you to use values from an SQL database supported by the sqlalchemy library, to populate a sensor state (and attributes). This can be used to present statistics about Home Assistant sensors if used with the recorder integration database. It can also be used with an external data source.

This integration can be configured using both config flow and by YAML.

{% include integrations/config_flow.md %}

Configuration by YAML

To configure this sensor, define the sensor connection variables and a list of queries to your configuration.yaml file. A sensor will be created for each query.

To enable it, add the following lines to your configuration.yaml file (example by required fields):

{% raw %}

# Example configuration.yaml
sql:
  - name: Sun state
    query: >
      SELECT *
      FROM states
      WHERE entity_id = 'sun.sun'
      ORDER BY state_id
      DESC LIMIT 1;
    column: "state"

{% endraw %}

{% configuration %} sql: description: Integration. required: true type: map keys: db_url: description: The URL which points to your database. See supported engines. required: false default: "Defaults to the default recorder db_url (not the current db_url of recorder)." type: string name: description: The name of the sensor. required: true type: string query: description: An SQL QUERY string, should return 1 result at most. required: true type: string column: description: The field name to select. required: true type: string unit_of_measurement: description: Defines the units of measurement of the sensor, if any. required: false type: string value_template: description: Defines a template to extract a value from the payload. required: false type: template unique_id: description: Provide a unique id for this sensor. required: false type: string {% endconfiguration %}

Information

See supported engines for which you can connect with this integration.

The SQL integration will connect to the default SQLite if "Database URL" has not been specified. If you use a different database recorder (eg MariaDB or others), you will have to specify the "Database URL" manually during integration setup.

There is no explicit configuration required for attributes. The integration will set all additional columns returned by the query as attributes.

Note that in all cases only the first row returned will be used.

Examples

In this section, you find some real-life examples of how to use this sensor.

Current state of an entity

This example shows the previously recorded state of the sensor sensor.temperature_in.

sensor:
  - platform: random
    name: Temperature in
    unit_of_measurement: "°C"

The query will look like this:

SELECT * FROM states WHERE entity_id = 'sensor.temperature_in' ORDER BY state_id DESC LIMIT 1;

Use state as column for value.

Previous state of an entity

Based on previous example with temperature, the query to get the former state is :

SELECT * FROM (SELECT * FROM states WHERE entity_id = 'sensor.temperature_in' ORDER BY state_id DESC LIMIT 2) two_entity ORDER BY state_id ASC LIMIT 1;

Use state as column for value.

Database size

Postgres

SELECT (pg_database_size('dsmrreader')/1024/1024) as db_size;

Use db_size as column for value.

MariaDB/MySQL

Change table_schema="homeassistant" to the name that you use as the database name, to ensure that your sensor will work properly.

SELECT table_schema "database", Round(Sum(data_length + index_length) / POWER(1024,2), 1) "value" FROM information_schema.tables WHERE table_schema="homeassistant" GROUP BY table_schema;

Use value as column for value.

SQLite

If you are using the recorder integration then you don't need to specify the location of the database. For all other cases, add sqlite:////path/to/database.db as Database URL.

SELECT ROUND(page_count * page_size / 1024 / 1024, 1) as size FROM pragma_page_count(), pragma_page_size();

Use size as column for value.

MS SQL

Use the same Database URL as for the recorder integration. Change DB_NAME to the name that you use as the database name, to ensure that your sensor will work properly. Be sure username has enough rights to access the sys tables.

Example Database URL: "mssql+pyodbc://username:password@SERVER_IP:1433/DB_NAME?charset=utf8&driver=FreeTDS"

Connecting with MSSQL requires "pyodbc" to be installed on your system, which can only be done on systems using the Home Assistant Core installation type to be able to install the necessary dependencies.

"pyodbc" has special requirements which need to be pre-installed before installation, see the "pyodbc" wiki for installation instructions

SELECT TOP 1 SUM(m.size) * 8 / 1024 as size FROM sys.master_files m INNER JOIN sys.databases d ON d.database_id=m.database_id WHERE d.name='DB_NAME';

Use size as column for value.