jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-15 05:16:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update sqlite URI (fixes #5276) (#5334)

Browse Source
This commit is contained in:
Fabian Affolter 2018-05-09 11:29:18 +02:00 committed by GitHub
parent 422e716f06
commit 8b7bd01647
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 47 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
source/_components/recorder.markdown
View File

@ -26,51 +26,51 @@ recorder:
```
{% configuration %}
recorder:
description: Enables the recorder component. Only allowed once.
required: true
type: map
keys:
db_url:
description: The URL which points to your database.
required: false
type: URL
purge_keep_days:
description: Specify the number of history days to keep in recorder database after a purge.
required: false
default: 10
type: int
purge_interval:
description: 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](#service-purge) call `purge` when required without impacting the purge schedule. If this is set to `0` (zero), automatic purging is disabled.
required: false
default: 1
type: int
exclude:
description: Configure which components should be excluded
required: false
type: map
keys:
domains:
description: The list of domains to be excluded from recordings.
required: false
type: List
entities:
description: The list of entity ids to be excluded from recordings.
required: false
type: List
include:
description: Configure which components should be included in recordings. If set, all other entities will not be recorded.
required: false
type: map
keys:
domains:
description: The list of domains to be included in the recordings.
required: false
type: List
entities:
description: The list of entity ids to be included in the recordings.
required: false
type: List
recorder:
description: Enables the recorder component. Only allowed once.
required: true
type: map
keys:
db_url:
description: The URL which points to your database.
required: false
type: URL
purge_keep_days:
description: Specify the number of history days to keep in recorder database after a purge.
required: false
default: 10
type: int
purge_interval:
description: 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](#service-purge) call `purge` when required without impacting the purge schedule. If this is set to `0` (zero), automatic purging is disabled.
required: false
default: 1
type: int
exclude:
description: Configure which components should be excluded
required: false
type: map
keys:
domains:
description: The list of domains to be excluded from recordings.
required: false
type: List
entities:
description: The list of entity ids to be excluded from recordings.
required: false
type: List
include:
description: Configure which components should be included in recordings. If set, all other entities will not be recorded.
required: false
type: map
keys:
domains:
description: The list of domains to be included in the recordings.
required: false
type: List
entities:
description: The list of entity ids to be included in the recordings.
required: false
type: List
{% endconfiguration %}
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 (`updater` or `automation`).
@ -79,7 +79,7 @@ Define domains and entities to `exclude` (aka. blacklist). This is convenient wh
# Example configuration.yaml entry with exclude
recorder:
purge_keep_days: 5
db_url: sqlite:///home/user/.homeassistant/test
db_url: sqlite:////home/user/.homeassistant/test
exclude:
domains:
- automation
@ -145,7 +145,7 @@ If the `recorder` component is activated then some components support `restore_s
| Database engine | `db_url` |
| :---------------|:---------------------------------------------------------|
| SQLite | `sqlite:///PATH/TO/DB_NAME` |
| SQLite | `sqlite:////PATH/TO/DB_NAME` |
| MariaDB | `mysql://SERVER_IP/DB_NAME?charset=utf8` |
| MariaDB         | `mysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
| MySQL | `mysql://SERVER_IP/DB_NAME?charset=utf8` |