Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crowbarz/ha-sql_json
Updated SQL integration for Home Assistant that supports JSON attributes
https://github.com/crowbarz/ha-sql_json
hacs home-assistant integration json sql
Last synced: 7 days ago
JSON representation
Updated SQL integration for Home Assistant that supports JSON attributes
- Host: GitHub
- URL: https://github.com/crowbarz/ha-sql_json
- Owner: crowbarz
- Created: 2020-10-16T08:59:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-17T09:10:21.000Z (over 1 year ago)
- Last Synced: 2024-02-14T21:26:24.364Z (9 months ago)
- Topics: hacs, home-assistant, integration, json, sql
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sql_json
Updated SQL integration for Home Assistant that supports JSON attributes.
This quick mod of the [core SQL integration](https://www.home-assistant.io/integrations/sql/) converts an SQL query result that parse as JSON to an object, allowing the result dataset to be accessed by templates and other integrations, as well as displayed in Lovelace cards.
## Installation using [HACS](https://hacs.xyz/)
1. [Install HACS](https://hacs.xyz/docs/installation/manual) if not already installed
1. Select **Community > Integrations > +** (in the bottom right corner)
1. Search for `sql_json` and select **Install this repository in HACS**
## Configuration
This integration is configured identically to the [core SQL integration](https://www.home-assistant.io/integrations/sql/). Replace the platform with `sql_json` to switch the query to use this integration.
The query may be a Jinja2 template, which will be rendered whenever the query is executed.
Note that there is a hard limit of [255 characters](https://github.com/home-assistant/core/blob/9ee97cb213d659aa9b6149484c0a42522decba78/homeassistant/core.py#L136) for states in Home Assistant, although attributes may contain [any amount of data as long as it is JSON serialisable](https://developers.home-assistant.io/docs/dev_101_states).
## Accessing JSON result data
JSON result data can be accessed in Jinja2 templates by using `state_attr`. For example:
```jinja
Entity with most events (last 24 hours): {{ state_attr(state_attr('sensor.recorder_top_events', 'json')[0].entity_id, 'friendly_name') }}
```
It is already possible to access data elements within a JSON result with the core SQL integration in templates using the [`from_json` filter](https://www.home-assistant.io/docs/configuration/templating/), however doing this causes the JSON string to be deserialised every time that the template is evaluated which is exponentially inefficient for large query results.
## Configuration example
The following configuration snippet defines a sensor that the recorder database for the top 10 entities with the most events during the 24 hours prior to the time that the sensor is updated. The automation updates the sensor at 01:30 daily. Set `db_url` to the database URL used for your recorder instance in `secrets.yaml`.
This configuration has been tested on HA 2023.4.
```yaml
# Example configuration.yaml
sensor:
- platform: sql_json
scan_interval: 2592000 ## 30 days
db_url: !secret db_url
queries:
- name: Recorder Top Events
query: |
SELECT CONCAT('[', GROUP_CONCAT(event_json), ']') as json
FROM (
SELECT JSON_OBJECT('entity_id', entity_id, 'count', event_count) AS event_json
FROM (
SELECT states_meta.entity_id, COUNT(*) AS event_count
FROM states
LEFT JOIN states_meta ON states.metadata_id = states_meta.metadata_id
WHERE last_updated_ts BETWEEN UNIX_TIMESTAMP()-86400 AND UNIX_TIMESTAMP()
GROUP BY states.metadata_id
ORDER BY event_count DESC
LIMIT 10
) AS json_output
) AS json_list;
value_template: '{{ value_json[0].count }}'
unit_of_measurement: events
column: json
automation:
- id: update_recorder_top_events_daily
alias: Update Recorder Top Events daily
mode: single
trigger:
platform: time
at: 01:30:00
action:
- service: homeassistant.update_entity
entity_id: sensor.recorder_top_events
```
The entities returned by the SQL query can then be displayed in a Lovelace card:
**NOTE**: requires the [`flex-table-card`](https://github.com/custom-cards/flex-table-card) Lovelace card to be installed.
```yaml
type: vertical-stack
cards:
- type: sensor
entity: sensor.recorder_top_events
graph: line
hours_to_show: 720
name: Top Events by Entity (30 days)
icon: 'mdi:comment-text-multiple-outline'
- type: 'custom:flex-table-card'
columns:
- data: json
modify: x.entity_id
name: Entity ID
- data: json
modify: x.count
name: events/day
- data: json
modify: (x.count/24).toFixed(2)
name: events/h
entities:
include: sensor.recorder_top_events
```