Plex-Meta-Manager/docs/metadata/details/schedule.md

# Schedule Detail

The script is designed to run continuously and certain attributes can be scheduled using these attributes.

Below is an example of a scheduled library: 
```yaml
libraries:
  Movies:
    schedule: weekly(sunday)
    metadata_path:
      - file: config/Movies.yml
      - pmm: imdb
      - pmm: studio
      - pmm: genre
      - pmm: actor
    operations:
      mass_critic_rating_update: tmdb
```

Below is an example of a scheduled Metadata File, Overlay File, and Playlist File: 
```yaml
libraries:
  Movies:
    metadata_path:
      - file: config/Movies.yml
        schedule: weekly(monday)
      - pmm: imdb
        schedule: weekly(tuesday)
      - pmm: studio
        schedule: weekly(wednesday)
      - pmm: genre
        schedule: weekly(thursday)
      - pmm: actor
        schedule: weekly(friday)
    overlay_path:
      - pmm: imdb
        schedule: weekly(saturday)
    operations:
      mass_critic_rating_update: tmdb
playlist_files:
  - file: config/Playlists.yml
    schedule: weekly(sunday)
```

Below is an example of a scheduled collection: 
```yaml
collections:
  TMDb Trending Weekly:
    tmdb_trending_weekly: 30
    sync_mode: sync
    schedule: weekly(sunday)
  TMDb Top Rated:
    tmdb_top_rated: 30
    sync_mode: sync
    schedule: 
     - monthly(1)
     - monthly(15)
```

Below is an example of a scheduled pinning collection: 
```yaml
collections:
  Christmas Movies:
    imdb_list: https://www.imdb.com/list/ls000096828/
    sync_mode: sync
    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` isn't 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.
[100] add docs 2022-03-08 08:06:22 +00:00			`# Schedule Detail`

			`The script is designed to run continuously and certain attributes can be scheduled using these attributes.`

			`Below is an example of a scheduled library:`
			```yaml
			`libraries:`
			`Movies:`
			`schedule: weekly(sunday)`
			`metadata_path:`
			`- file: config/Movies.yml`
Replace all `- git: PMM` mentions with `- pmm:` 2022-10-03 20:12:01 +00:00			`- pmm: imdb`
			`- pmm: studio`
			`- pmm: genre`
			`- pmm: actor`
[100] add docs 2022-03-08 08:06:22 +00:00			`operations:`
			`mass_critic_rating_update: tmdb`
			```

[39] update wiki with recent changes 2022-04-26 05:34:06 +00:00			`Below is an example of a scheduled Metadata File, Overlay File, and Playlist File:`
			```yaml
			`libraries:`
			`Movies:`
			`metadata_path:`
			`- file: config/Movies.yml`
[40] fix overlay caching 2022-04-26 15:28:04 +00:00			`schedule: weekly(monday)`
Replace all `- git: PMM` mentions with `- pmm:` 2022-10-03 20:12:01 +00:00			`- pmm: imdb`
[40] fix overlay caching 2022-04-26 15:28:04 +00:00			`schedule: weekly(tuesday)`
Replace all `- git: PMM` mentions with `- pmm:` 2022-10-03 20:12:01 +00:00			`- pmm: studio`
[40] fix overlay caching 2022-04-26 15:28:04 +00:00			`schedule: weekly(wednesday)`
Replace all `- git: PMM` mentions with `- pmm:` 2022-10-03 20:12:01 +00:00			`- pmm: genre`
[40] fix overlay caching 2022-04-26 15:28:04 +00:00			`schedule: weekly(thursday)`
Replace all `- git: PMM` mentions with `- pmm:` 2022-10-03 20:12:01 +00:00			`- pmm: actor`
[40] fix overlay caching 2022-04-26 15:28:04 +00:00			`schedule: weekly(friday)`
[39] update wiki with recent changes 2022-04-26 05:34:06 +00:00			`overlay_path:`
Replace all `- git: PMM` mentions with `- pmm:` 2022-10-03 20:12:01 +00:00			`- pmm: imdb`
[40] fix overlay caching 2022-04-26 15:28:04 +00:00			`schedule: weekly(saturday)`
[39] update wiki with recent changes 2022-04-26 05:34:06 +00:00			`operations:`
			`mass_critic_rating_update: tmdb`
			`playlist_files:`
			`- file: config/Playlists.yml`
			`schedule: weekly(sunday)`
			```

[100] add docs 2022-03-08 08:06:22 +00:00			`Below is an example of a scheduled collection:`
			```yaml
			`collections:`
			`TMDb Trending Weekly:`
			`tmdb_trending_weekly: 30`
			`sync_mode: sync`
			`schedule: weekly(sunday)`
			`TMDb Top Rated:`
			`tmdb_top_rated: 30`
			`sync_mode: sync`
[90] schedule multiple alls 2022-05-12 14:09:08 +00:00			`schedule:`
			`- monthly(1)`
			`- monthly(15)`
[100] add docs 2022-03-08 08:06:22 +00:00			```

			`Below is an example of a scheduled pinning collection:`
			```yaml
			`collections:`
			`Christmas Movies:`
			`imdb_list: https://www.imdb.com/list/ls000096828/`
			`sync_mode: sync`
[13] fix tv ratings 2022-09-07 18:38:14 +00:00			`visible_home: range(12/01-12/31)`
[100] add docs 2022-03-08 08:06:22 +00:00			```

			`The scheduling options are:`

[68] #914 Added `non_existing` schedule option 2022-06-27 20:46:46 +00:00			`\| 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)]` \|
[100] add docs 2022-03-08 08:06:22 +00:00
			* `daily` is the default when `schedule` isn't 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).
[90] schedule multiple alls 2022-05-12 14:09:08 +00:00			`* 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.