Skip to content

Library Operations

There are a variety of Library Operations that can be utilized in a library.

Within each library, operations can be defined by using the operations attribute, as demonstrated below.

When not using a list under operations the whole operations value is one block.

Example
libraries:
  Movies:
    collection_files:
      - pmm: imdb
    operations:
      mass_critic_rating_update: tmdb
      split_duplicates: true

Operation Blocks

You can create individual blocks of operations by using a list under operations with each item in the list being a "block" that can be individually scheduled.

Example
libraries:
  Movies:
    collection_files:
      - pmm: imdb
    operations:
      - schedule: weekly(friday)
        mass_critic_rating_update: tmdb
      - schedule: weekly(saturday)
        split_duplicates: true

Operation Attributes

assets_for_all - Used to search the asset directories for images for all items in the library.

Searches the asset directories for images for all items in the library.


Attribute: assets_for_all

Accepted Values: true or false

Example
libraries:
  Movies:
    operations:
      assets_for_all: false
delete_collections - Deletes collections based on a set of given attribute.

Deletes collections based on a set of given attributes. The Collection must match all set attributes to be deleted.


Attribute: delete_collections

Accepted Values: There are a few different options to determine how the delete_collections works.

managed: trueCollection must be Managed to be deleted
(collection has the PMM label)
managed: falseCollection must be Unmanaged to be deleted
(collection does not have the PMM label)
configured: trueCollection must be Configured to be deleted
(collection is in the config file of the specific PMM run)
configured: falseCollection must be Unconfigured to be deleted
(collection is not in the config file of the specific PMM run)
less: ###Collection must contain less than the given number of items to be deleted.
### is a Number greater than 0
Optional value which if undefined means collections will be deleted regardless of how many items they have

The collection does not need to be scheduled to be considered configured and only needs to be in the config file.

Example

Removes all Managed Collections (Collections with the PMM Label) that are not configured in the Current Run.

libraries:
  Movies:
    operations:
      delete_collections:
        configured: false
        managed: true
mass_genre_update - Updates the genres of every item in the library.

Updates every item's genres in the library to the chosen site's genres.


Attribute: mass_genre_update

Accepted Values:

tmdbUse TMDb for Genres
tvdbUse TVDb for Genres
imdbUse IMDb for Genres
omdbUse IMDb through OMDb for Genres
anidbUse AniDB Main Tags for Genres
anidb_3_0Use AniDB Main Tags and All 3 Star Tags and above for Genres
anidb_2_5Use AniDB Main Tags and All 2.5 Star Tags and above for Genres
anidb_2_0Use AniDB Main Tags and All 2 Star Tags and above for Genres
anidb_1_5Use AniDB Main Tags and All 1.5 Star Tags and above for Genres
anidb_1_0Use AniDB Main Tags and All 1 Star Tags and above for Genres
anidb_0_5Use AniDB Main Tags and All 0.5 Star Tags and above for Genres
malUse MyAnimeList for Genres
lockLock all Genre Field
unlockUnlock all Genre Field
removeRemove all Genres and Lock all Field
resetRemove all Genres and Unlock all Field

Example
libraries:
  Movies:
    operations:
      mass_genre_update: imdb
mass_content_rating_update - Updates the content rating of every item in the library.

Updates every item's content rating in the library to the chosen site's content rating.


Attribute: mass_content_rating_update

Accepted Values:

mdbUse MdbList for Content Ratings
mdb_commonsenseUse Common Sense Rating through MDbList for Content Ratings
mdb_commonsense0Use Common Sense Rating with Zero Padding through MDbList for Content Ratings
omdbUse IMDb through OMDb for Content Ratings
malUse MyAnimeList for Content Ratings
lockLock Content Rating Field
unlockUnlock Content Rating Field
removeRemove Content Rating and Lock Field
resetRemove Content Rating and Unlock Field

Example
libraries:
  Movies:
    operations:
      mass_content_rating_update: omdb
mass_original_title_update - Updates the original title of every item in the library.

Updates every item's original title in the library to the chosen site's original title.


Attribute: mass_original_title_update

Accepted Values:

anidbUse AniDB Main Title for Original Titles
anidb_officialUse AniDB Official Title based on the language attribute in the config file for Original Titles
malUse MyAnimeList Main Title for Original Titles
mal_englishUse MyAnimeList English Title for Original Titles
mal_japaneseUse MyAnimeList Japanese Title for Original Titles
lockLock Original Title Field
unlockUnlock Original Title Field
removeRemove Original Title and Lock Field
resetRemove Original Title and Unlock Field

Example
libraries:
  Anime:
    operations:
      mass_original_title_update: anidb_official
mass_studio_update - Updates the studio of every item in the library.

Updates every item's studio in the library to the chosen site's studio.


Attribute: mass_studio_update

Accepted Values:

anidbUse AniDB Animation Work for Studio
malUse MyAnimeList Studio for Studio
tmdbUse TMDb Studio for Studio
lockLock Original Title Field
unlockUnlock Original Title Field
removeRemove Original Title and Lock Field
resetRemove Original Title and Unlock Field

Example
libraries:
  Anime:
    operations:
      mass_studio_update: mal
mass_originally_available_update - Updates the originally available date of every item in the library.

Updates every item's originally available date in the library to the chosen site's date.

Tip

As plex does not allow this field to be empty, using remove or reset will set the date to the Plex default date, which is 1969-12-31


Attribute: mass_originally_available_update

Accepted Values:

tmdbUse TMDb Release Date
tvdbUse TVDb Release Date
omdbUse IMDb Release Date through OMDb
mdbUse MdbList Release Date
anidbUse AniDB Release Date
malUse MyAnimeList Release Date
lockLock Originally Available Field
unlockUnlock Originally Available Field
removeRemove Originally Available and Lock Field
resetRemove Originally Available and Unlock Field

Example
libraries:
  TV Shows:
    operations:
      mass_originally_available_update: tvdb
mass_***_rating_update - Updates the audience/critic/user rating of every item in the library.

Updates every item's audience/critic/user rating in the library to the chosen site's rating.

Important Note

This does not affect the icons displayed in the Plex UI. This will place the number of your choice in the relevant field in the Plex database. In other words, if Plex is configured to use Rotten Tomatoes ratings, then no matter what happens with this mass rating update operation, the icons in the Plex UI will remain Rotten Tomatoes. The human who decided to put TMDb ratings in the critic slot and Letterboxd ratings in the audience slot is the only party who knows that the ratings are no longer Rotten Tomatoes. One primary use of this feature is to put ratings overlays on posters. More information on what PMM can do with these ratings can be found here.


Attribute: mass_audience_rating_update/mass_critic_rating_update/mass_user_rating_update

Accepted Values:

tmdbUse TMDb Rating
imdbUse IMDb Rating
trakt_userUse Trakt User's Personal Rating
omdbUse IMDbRating through OMDb
mdbUse MdbList Score
mdb_averageUse MdbList Average Score
mdb_imdbUse IMDb Rating through MDbList
mdb_metacriticUse Metacritic Rating through MDbList
mdb_metacriticuserUse Metacritic User Rating through MDbList
mdb_traktUse Trakt Rating through MDbList
mdb_tomatoesUse Rotten Tomatoes Rating through MDbList
mdb_tomatoesaudienceUse Rotten Tomatoes Audience Rating through MDbList
mdb_tmdbUse TMDb Rating through MDbList
mdb_letterboxdUse Letterboxd Rating through MDbList
mdb_myanimelistUse MyAnimeList Rating through MDbList
anidb_ratingUse AniDB Rating
anidb_averageUse AniDB Average
anidb_scoreUse AniDB Review Score
malUse MyAnimeList Score
lockLock Rating Field
unlockUnlock Rating Field
removeRemove Rating and Lock Field
resetRemove Rating and Unlock Field

Example
libraries:
  Movies:
    operations:
      mass_audience_rating_update: mdb_average
      mass_critic_rating_update: mdb_metacritic
      mass_user_rating_update: imdb
mass_episode_***_rating_update - Updates the audience/critic/user rating of every episode in the library.

Updates every item's episode's audience/critic/user rating in the library to the chosen site's rating.

Important Note

This does not affect the icons displayed in the Plex UI. This will place the number of your choice in the relevant field in the Plex database. In other words, if Plex is configured to use Rotten Tomatoes ratings, then no matter what happens with this mass rating update operation, the icons in the Plex UI will remain Rotten Tomatoes. The human who decided to put TMDb ratings in the critic slot and Letterboxd ratings in the audience slot is the only party who knows that the ratings are no longer Rotten Tomatoes. One primary use of this feature is to put ratings overlays on posters. More information on what PMM can do with these ratings can be found here.


Attribute: mass_episode_audience_rating_update/mass_episode_critic_rating_update/mass_episode_user_rating_update

Accepted Values:

tmdbUse TMDb Rating
imdbUse IMDb Rating
lockLock Rating Field
unlockUnlock Rating Field
removeRemove Rating and Lock Field
resetRemove Rating and Unlock Field

Example
libraries:
  TV Shows:
    operations:
      mass_episode_audience_rating_update: tmdb
      mass_episode_critic_rating_update: remove
      mass_episode_user_rating_update: imdb
mass_poster_update - Updates the poster of every item in the library.

Updates every item's poster to the chosen sites poster. Will fall back to plex if the given option fails. Assets will be used over anything else.

Warning

When used in combination with Overlays, this could cause PMM to reset the poster and then reapply all overlays on each run, which will result in image bloat.


Attribute: mass_poster_update

Accepted Values:

sourceSource of the poster updatetmdb, plex, lock, or unlock
seasonsUpdate season posters while updating shows Default: truetrue (default) or false
episodesUpdate episode posters while updating shows Default: truetrue (default) or false

Example
libraries:
  TV Shows:
    operations:
      mass_poster_update:
        source: tmdb
        seasons: false
        episodes: false
mass_background_update - Updates the background of every item in the library.

Updates every item's background to the chosen sites background. Will fall back to plex if the given option fails. Assets will be used over anything else.

Warning

When used in combination with Overlays, this could cause PMM to reset the background and then reapply all overlays on each run, which will result in image bloat.


Attribute: mass_background_update

Accepted Values:

sourceSource of the poster updatetmdb, plex, lock, or unlock
seasonsUpdate season posters while updating shows Default: truetrue (default) or false
episodesUpdate episode posters while updating shows Default: truetrue (default) or false

Example
libraries:
  TV Shows:
    operations:
      mass_background_update:
        source: tmdb
        seasons: false
        episodes: false
mass_imdb_parental_labels - Adds IMDb Parental labels of every item in the library.

Updates every item's labels in the library to match the IMDb Parental Guide.


Attribute: mass_imdb_parental_labels

Accepted Values:

noneApply all Parental Labels with a value of None, Mild, Moderate, or Severe
mildApply all Parental Labels with a value of Mild, Moderate, or Severe
moderateApply all Parental Labels with a value of Moderate or Severe
severeApply all Parental Labels with a value of Severe

Example
libraries:
  TV Shows:
    operations:
      mass_imdb_parental_labels: severe
mass_collection_mode - Updates the Collection Mode of every item in the library.

Updates every Collection in your library to the specified Collection Mode.


Attribute: mass_collection_mode

Accepted Values:

defaultLibrary default
hideHide Collection
hide_itemsHide Items in this Collection
show_itemsShow this Collection and its Items

Example
libraries:
  TV Shows:
    operations:
      mass_collection_mode: hide
update_blank_track_titles - Updates blank track titles of every item in the library.

Search though every track in a music library and replace any blank track titles with the tracks sort title.


Attribute: update_blank_track_titles

Accepted Values: true or false

Example
libraries:
  Music:
    operations:
      update_blank_track_titles: true
remove_title_parentheses - Removes title parentheses of every item in the library.

Search through every title and remove all ending parentheses in an items title if the title is not locked.


Attribute: remove_title_parentheses

Accepted Values: true or false

Example
libraries:
  Music:
    operations:
      remove_title_parentheses: true
split_duplicates - Splits all duplicate items found in this library.

Splits all duplicate items found in this library.


Attribute: split_duplicates

Accepted Values: true or false

Example
libraries:
  Movies:
    operations:
      split_duplicates: true
radarr_add_all - Adds every item in the library to Radarr.

Adds every item in the library to Radarr.

Warning

The existing paths in plex will be used as the root folder of each item, if the paths in Plex are not the same as your Radarr paths you can use the plex_path and radarr_path Radarr details to convert the paths.


Attribute: radarr_add_all

Accepted Values: true or false

Example
libraries:
  Movies:
    operations:
      radarr_add_all: true
radarr_remove_by_tag - Removes every item from Radarr with the Tags given.

Removes every item from Radarr with the Tags given.


Attribute: radarr_remove_by_tag

Accepted Values: List or comma separated string of tags

Example
libraries:
  Movies:
    operations:
      radarr_remove_by_tag: mytag1, mytag2
sonarr_add_all - Adds every item in the library to Sonarr.

Adds every item in the library to Sonarr.

Warning

The existing paths in plex will be used as the root folder of each item, if the paths in Plex are not the same as your Sonarr paths you can use the plex_path and sonarr_path Sonarr details to convert the paths.


Attribute: sonarr_add_all

Accepted Values: true or false

Example
libraries:
  TV Shows:
    operations:
      sonarr_add_all: true
sonarr_remove_by_tag - Removes every item from Sonarr with the Tags given.

Removes every item from Sonarr with the Tags given.


Attribute: sonarr_remove_by_tag

Accepted Values: List or comma separated string of tags

Example
libraries:
  TV Shows:
    operations:
      sonarr_remove_by_tag: mytag1, mytag2
genre_mapper - Maps genres in your library to be changed to other genres.

Maps genres in your library to be changed to other genres.


Attribute: genre_mapper

Accepted Values: Each attribute under genre_mapper is a separate mapping and has two parts.

keyGenre you want mapped to the valueAction/Adventure, Action & Adventure in the example below
valueWhat the genre will end up asAction in the example below

Example

This example will change go through every item in your library and change the genre Action/Adventure or Action & Adventure to Action and Romantic Comedy to Comedy.

libraries:
  Movies:
    # Metadata and Overlay files here
    operations:
      genre_mapper:
        "Action/Adventure": Action 
        "Action & Adventure": Action
        Romantic Comedy: Comedy

To just Remove a Genre without replacing it just set the Genre to nothing like this.

libraries:
  Movies:
    # Metadata and Overlay files here
    operations:
      genre_mapper:
        "Action/Adventure": Action 
        "Action & Adventure": Action
        Romantic Comedy:

The above example will change go through every item in your library and change the genre Action/Adventure or Action & Adventure to Action and remove every instance of the Genre Romantic Comedy.

content_rating_mapper - Maps content ratings in your library to be changed to other content ratings.

Maps content ratings in your library to be changed to other content ratings.


Attribute: content_rating_mapper

Accepted Values: Each attribute under content_rating_mapper is a separate mapping and has two parts.

keyContent rating you want mapped to the valuePG, PG-13 in the example below
valueWhat the content rating will end up asY-10 in the example below

Example

This example will change go through every item in your library and change the content rating PG or PG-13 to Y-10 and R to Y-17.

libraries:
  Movies:
    # Metadata and Overlay files here
    operations:
      content_rating_mapper:
        PG: Y-10 
        "PG-13": Y-10
        R: Y-17

To just Remove a content rating without replacing it just set the content rating to nothing like this.

libraries:
  Movies:
    # Metadata and Overlay files here
    operations:
      content_rating_mapper:
        PG: Y-10 
        "PG-13": Y-10
        R:

The above example will change go through every item in your library and change the content rating PG or PG-13 to Y-10 and remove every instance of the content rating R.

metadata_backup - Creates/Maintains a PMM Metadata File for the library.

Creates/Maintains a Plex Meta Manager Metadata File with a full metadata mapping based on the library's items locked attributes.

If you point to an existing Metadata File then PMM will Sync the changes to the file, so you won't lose non plex changes in the file.


Attribute: metadata_backup

Accepted Values: There are a few different options to determine how the metadata_backup works.

pathPath to where the metadata will be saved/maintained
Default: <<library_name>>_Metadata_Backup.yml in your config folder
Values: Path to Metadata File
excludeExclude all listed attributes from being saved in the collection file
Values: Comma-separated string or list of attributes
sync_tagsAll Tag Attributes will have the .sync option and blank attribute will be added to sync
Default: false
Values: true or false
add_blank_entriesWill add a line for entries that have no metadata changes
Default: true
Values: true or false

Example
libraries:
  Movies:
    operations:
      metadata_backup:
        path: config/Movie_Backup.yml
        sync_tags: true
        add_blank_entries: false