Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.sql Namespace Reference

Namespaces

 config_flow
 
 const
 
 models
 
 sensor
 
 util
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None async_update_listener (HomeAssistant hass, ConfigEntry entry)
 
None remove_configured_db_url_if_not_needed (HomeAssistant hass, ConfigEntry entry)
 
str validate_sql_select (str value)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA
 
 QUERY_SCHEMA
 

Detailed Description

The sql component.

Function Documentation

◆ async_setup()

bool homeassistant.components.sql.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up SQL from yaml config.

Definition at line 93 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.sql.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up SQL from a config entry.

Definition at line 106 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.sql.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload SQL config entry.

Definition at line 123 of file __init__.py.

◆ async_update_listener()

None homeassistant.components.sql.async_update_listener ( HomeAssistant  hass,
ConfigEntry  entry 
)
Update listener for options.

Definition at line 88 of file __init__.py.

◆ remove_configured_db_url_if_not_needed()

None homeassistant.components.sql.remove_configured_db_url_if_not_needed ( HomeAssistant  hass,
ConfigEntry   entry 
)
Remove db url from config if it matches recorder database.

Definition at line 76 of file __init__.py.

◆ validate_sql_select()

str homeassistant.components.sql.validate_sql_select ( str  value)
Validate that value is a SQL SELECT query.

Definition at line 41 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.sql._LOGGER = logging.getLogger(__name__)
private

Definition at line 38 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.sql.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Optional(DOMAIN): vol.All(cv.ensure_list, [QUERY_SCHEMA])},
3  extra=vol.ALLOW_EXTRA,
4 )

Definition at line 70 of file __init__.py.

◆ QUERY_SCHEMA

homeassistant.components.sql.QUERY_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_COLUMN_NAME): cv.string,
4  vol.Required(CONF_NAME): cv.template,
5  vol.Required(CONF_QUERY): vol.All(cv.string, validate_sql_select),
6  vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
7  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
8  vol.Optional(CONF_UNIQUE_ID): cv.string,
9  vol.Optional(CONF_DB_URL): cv.string,
10  vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
11  vol.Optional(CONF_STATE_CLASS): STATE_CLASSES_SCHEMA,
12  vol.Optional(CONF_AVAILABILITY): cv.template,
13  vol.Optional(CONF_ICON): cv.template,
14  vol.Optional(CONF_PICTURE): cv.template,
15  }
16 )

Definition at line 53 of file __init__.py.