From ad9a6223b42939e9223ab578a969d26397480f3e Mon Sep 17 00:00:00 2001 From: Anders Melchiorsen Date: Sat, 27 Jan 2018 22:44:54 +0100 Subject: [PATCH 1/3] Default recorder purge_interval to 1 --- source/_components/recorder.markdown | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 48ada639fde4..812be7e02f3a 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -35,13 +35,15 @@ recorder: description: The URL which points to your database. required: false type: URL - purge_interval: - description: Enable scheduled purge of older events and states. The purge task runs every `purge_interval` days from when the `recorder component` is first enabled. 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 `purge_interval` is set, `purge_keep_days` needs to be set as well. - required: Inclusive - type: int purge_keep_days: - description: Specify the number of history days to keep in recorder database after purge. If `purge_interval` is set, `purge_keep_days` needs to be set as well. - required: Inclusive + description: Specify the number of history days to keep in recorder database after purge. + required: false + 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. + required: false + default: 1 type: int exclude: description: Configure which components should be excluded @@ -76,7 +78,6 @@ Define domains and entities to `exclude` (aka. blacklist). This is convenient wh ```yaml # Example configuration.yaml entry with exclude recorder: - purge_interval: 2 purge_keep_days: 5 db_url: sqlite:///home/user/.homeassistant/test exclude: From 4a9f2c5c54f10830c35a52302f99ff01c7377b4d Mon Sep 17 00:00:00 2001 From: Anders Melchiorsen Date: Sat, 27 Jan 2018 23:22:37 +0100 Subject: [PATCH 2/3] Reflow --- source/_components/recorder.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 812be7e02f3a..fc812315f470 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -40,8 +40,7 @@ recorder: required: false 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. + 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. required: false default: 1 type: int From 153a707ef31d47eac6c8688c0a79922140224044 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 28 Jan 2018 09:59:15 +0100 Subject: [PATCH 3/3] :pencil2: Minor improvements --- source/_components/recorder.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index fc812315f470..38b9239ba591 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -36,11 +36,11 @@ recorder: required: false type: URL purge_keep_days: - description: Specify the number of history days to keep in recorder database after purge. + description: Specify the number of history days to keep in recorder database after a purge. required: false 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. + 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. required: false default: 1 type: int