Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update Schedule examples

Browse Source
pull/1318/head
YozoraXCII 2 years ago
parent 3c32c8e6c2
commit 06431d7afe
1 changed files with 53 additions and 27 deletions
Show Stats Download Patch File Download Diff File

80
docs/metadata/details/schedule.md
Unescape View File

@ -1,8 +1,32 @@
# Schedule Setting
The script is designed to run continuously and certain attributes can be scheduled using these attributes.
Plex Meta Manager allows you to schedule certain libraries/files so that runs can be tailored to suit your needs.
This is particularly handy for users who have a lot of libraries or run a lot of Metadata/Operations on their libraries.
The scheduling options are:
| Name | Description | Format | Example |
|:-------------|:-------------------------------------------------------------------------------------------------|:----------------------|:----------------------------------|
| Hourly | Update only when the script is run in that hour | hourly(Hour of Day) | `hourly(17)` |
| Daily | Update once a day | daily | `daily` |
| Weekly | Update once a week on the specified day | weekly(Day of Week) | `weekly(sunday)` |
| Monthly | Update once a month on the specified day | monthly(Day of Month) | `monthly(1)` |
| Yearly | Update once a year on the specified day | yearly(MM/DD) | `yearly(01/30)` |
| Range | Updates whenever the date is within the range | range(MM/DD-MM/DD) | `range(12/01-12/31)` |
| Never | Never updates | never | `never` |
| Non Existing | Updates if it doesn't exist | non_existing | `non_existing` |
| All | Requires that all comma separated scheduling options inside its brackets be meet in order to run | all[Options] | `all[weekly(sunday), hourly(17)]` |
* `daily` is the default when `schedule` is not specified.
* You can run the script multiple times per day but using the `--time` command line argument detailed on the [Run Commands & Environmental Variables Page](../../home/environmental.md#time-to-run).
* You can have multiple scheduling options as a list.
* You can use the `delete_not_scheduled` setting to delete Collections that are skipped due to not being scheduled.
## Examples
Below is an example of a library which has been scheduled to run every Sunday. This will schedule everything within the library (in this case Metadata files and Operations) for the same day.
Below is an example of a scheduled library:
```yaml
libraries:
@ -18,9 +42,9 @@ libraries:
mass_critic_rating_update: tmdb
```
Below is an example of scheduling Metadata Files, Playlist Files, and Overlay Files:
Metadata Files, Playlist Files, and Overlay Files can all be individually scheduled, as seen below where different files are scheduled to run on each day of the week:
**Note: Overlay Files cannot be individually Scheduled.**
**Note: Overlay Files cannot be individually Scheduled, all Overlay Files must be scheduled for the same period.**
```yaml
libraries:
@ -30,7 +54,7 @@ libraries:
schedule: weekly(monday)
- pmm: imdb
schedule: weekly(tuesday)
- pmm: studio
- folder: config/Movies/
schedule: weekly(wednesday)
- pmm: genre
schedule: weekly(thursday)
@ -44,11 +68,9 @@ libraries:
playlist_files:
- file: config/Playlists.yml
schedule: weekly(sunday)
- file: config/Playlists2.yml
schedule: weekly(monday)
```
Below is an example of a scheduled collection:
Below is an example of a collection which has been scheduled to run on a Sunday. In this scenario, if you run PMM on a Monday, this collection will be skipped but any other collections which do not have a scheduled defined will be run.
```yaml
collections:
@ -64,7 +86,7 @@ collections:
- monthly(15)
```
Below is an example of a scheduled pinning collection:
You can also schedule items to be "pinned" to your homescreen on a schedule. For example, this collection will be pinned to your homescreen for the month of December and on January 1st will no longer be pinned (you must run PMM on 1st January for the removal of the pin to happen)
```yaml
collections:
@ -74,21 +96,25 @@ collections:
visible_home: range(12/01-12/31)
```
The scheduling options are:
| Name | Description | Format | Example |
|:-------------|:-------------------------------------------------------------------------------------------------|:----------------------|:----------------------------------|
| Hourly | Update only when the script is run in that hour | hourly(Hour of Day) | `hourly(17)` |
| Daily | Update once a day | daily | `daily` |
| Weekly | Update once a week on the specified day | weekly(Day of Week) | `weekly(sunday)` |
| Monthly | Update once a month on the specified day | monthly(Day of Month) | `monthly(1)` |
| Yearly | Update once a year on the specified day | yearly(MM/DD) | `yearly(01/30)` |
| Range | Updates whenever the date is within the range | range(MM/DD-MM/DD) | `range(12/01-12/31)` |
| Never | Never updates | never | `never` |
| Non Existing | Updates if it doesn't exist | non_existing | `non_existing` |
| All | Requires that all comma separated scheduling options inside its brackets be meet in order to run | all[Options] | `all[weekly(sunday), hourly(17)]` |
* `daily` is the default when `schedule` is not specified.
* You can run the script multiple times per day but using the `--time` command line argument detailed on the [Run Commands & Environmental Variables Page](../../home/environmental.md#time-to-run).
* You can have multiple scheduling options as a list.
* You can use the `delete_not_scheduled` setting to delete Collections that are skipped due to not being scheduled.
Whilst it isn't possible to schedule individual Operations, you can create additional placeholder library names and point them to the original library using `library_name`. This can be used to achieve individually scheduled operations, as seen below:
```yaml
libraries:
Movies:
metadata_path:
- file: config/Movies.yml
Movies Operations (Monday): # Name doesn't matter
library_name: Movies # Must match your library name in Plex
schedule: weekly(monday)
operations:
mass_user_rating_update: imdb
Movies Operations (Wednesday): # Name doesn't matter
library_name: Movies # Must match your library name in Plex
schedule: weekly(wednesday)
operations:
mass_audience_rating_update: tmdb
Movies Operations (Friday): # Name doesn't matter
library_name: Movies # Must match your library name in Plex
schedule: weekly(friday)
operations:
mass_critic_rating_update: trakt
```

Write Preview
Loading…
Cancel
Save