Skip to main content

Mopidy SQLite local library extension

Project description

Mopidy-Local-SQLite is a Mopidy local library extension that uses an SQLite database for keeping track of your local media. This extension lets you browse your music collection by album, artist, composer and performer, and provides full-text search capabilities based on SQLite’s FTS modules. It also notices updates via mopidy local scan while Mopidy is running, so you can scan your media library periodically from a cron job, for example.


Mopidy-Local-SQLite can be installed using pip by running:

pip install Mopidy-Local-SQLite


Before starting Mopidy, you must change your configuration to switch to using Mopidy-Local-SQLite as your preferred local library. It is also recommended to change the default scan_flush_threshold, to improve database access during a local scan:

library = sqlite
scan_flush_threshold = 100

Once this has been set you need to re-scan your library to populate the database:

mopidy local scan

This extension also provides some configuration settings of its own, but be aware that these are still subject to change:

enabled = true

# top-level directories for browsing, as <name> <uri>
directories =
    Albums                  local:directory?type=album
    Artists                 local:directory?type=artist
    Composers               local:directory?type=artist&role=composer
    Genres                  local:directory?type=genre
    Performers              local:directory?type=artist&role=performer
    Release Years           local:directory?type=date&format=%25Y
    Tracks                  local:directory?type=track
    Last Week's Updates     local:directory?max-age=604800
    Last Month's Updates    local:directory?max-age=2592000

# database connection timeout in seconds
timeout = 10

# whether to use an album's musicbrainz_id for generating its URI
use_album_mbid_uri = true

# whether to use an artist's musicbrainz_id for generating its URI;
# disabled by default, since some taggers do not handle this well for
# multi-artist tracks []
use_artist_mbid_uri = false

# whether to use the sortname field for sorting artist browse results;
# set to false to sort according to displayed name only
use_artist_sortname = true


Copyright (c) 2014, 2015 Thomas Kemmer and contributors.

Licensed under the Apache License, Version 2.0.

Known Bugs and Limitations

The database schema does not support multiple artists, composers or performers for a single track or album. Look out for “Ignoring multiple artists” warnings during a local scan to see if you are affected by this.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Mopidy-Local-SQLite, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size Mopidy_Local_SQLite-1.0.0-py2.py3-none-any.whl (18.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size Mopidy-Local-SQLite-1.0.0.tar.gz (20.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page