We’re happy to announce the release of our May 2022 schema change today! Thanks to all who were patient during today’s downtime as we released everything to our production servers, and thanks to ikerm2003, mfmeulenbelt rinmon and salo.rock for updating the translations.
This is once again a fairly minor release as far as schema changes go, but please do report any issues that you come across, especially related to the propagation of ratings and tags.
New, user-facing changes with this release include withdrawn-only release groups showing in the official overview again (MBS-12208) and the final disappearance of Amazon cover art (MBS-12200). To this regard, the report of releases that have Amazon cover art but no Cover Art Archive front cover will stay available for editors to check their subscribed entities.
Additionally, several small changes will allow, in the next couple of releases, to store more information about genres (including URL relationships) and to recognize and special-case mood tags (MBS-12190). Another new feature that will start to be used in the API and artist credit pages is the addition of MusicBrainz IDs for artist credits, which allow referring to them with a unique and more persistent ID (MBS-11456). Finally, a few more under-the-hood only changes are made, which should ensure better performance for finding artists, events, etc. for all areas contained in a given one, and less bugs when adding and changing tags and ratings.
The area containment changes make use of a new materialized table. Like the ones we added last year, this table isn’t dumped nor replicated, since it is derived entirely from primary table data. Rather, it will be created during migration (or, in a new install, by running the
admin/BuildMaterializedTables script) and triggers will be added to keep it up-to-date once it has been built. These triggers are created on replicated servers, too.
The accompanying new version of the search index rebuilder brings performance improvements for both the main server and mirrors, and simplifies maintenance. See the release notes for details.
A new release of MusicBrainz Docker is also available that matches this update of MusicBrainz Server. See the release notes for update instructions.
Now, on to the instructions.
Schema Change Upgrade Instructions
Note: Importing the latest data dump is always a valid alternative to running
./upgrade.sh on an existing database, if you’d prefer to also get new data in one go. Just follow the relevant instructions in INSTALL.md. The git tag is v-2022-05-16-schema-change. The rest of the instructions here assume an in-place upgrade.
- Make sure
DB_SCHEMA_SEQUENCE is set to 26 in
- If you’re using the live data feed (your
REPLICATION_TYPE is set to
RT_SLAVE), ensure you’ve replicated up to the most recent replication packet available with the old schema. If you’re not sure, run
./admin/replication/LoadReplicationChanges and see what it tells you; if you’re ready to upgrade, it should say “This replication packet matches schema sequence #27, but the database is currently at #26.”
- Take down the web server running MusicBrainz, if you’re running a web server.
- Turn off cron jobs if you’re automatically updating the database via cron jobs.
- If you’re using the live search indexing, stop it and, assuming
sir is under the same directory as
cd ../sir && python2.7 -m sir triggers && cd - && ./admin/psql < ../sir/sql/DropTriggers.sql && ./admin/psql < ../sir/sql/DropFunctions.sql
- Switch to the new code with
git fetch origin followed by
git checkout v-2022-05-16-schema-change.
cpanm --installdeps --notest . (note the dot at the end) to ensure your perl-based dependencies are up to date.
./upgrade.sh (it may take a while to vacuum at the end).
DB_SCHEMA_SEQUENCE to 27 in
lib/DBDefs.pm as instructed by the output of
- If your
REPLICATION_TYPE is set to
RT_SLAVE, change it to
RT_MIRROR. (The previous terminology will work for the time being, but is now deprecated.)
- If you’re using the live search indexing, assuming again that
sir is under the same directory as
cd ../sir && git fetch origin && git checkout v3.0.1 && python2.7 -m sir triggers && cd - && ./admin/psql < ../sir/sql/CreateFunctions.sql && ./admin/psql < ../sir/sql/CreateTriggers.sql and rebuild indexes which takes hours (by running
cd ../sir && python2.7 -m sir reindex && cd -) then start it in watch mode (with
cd ../sir && git fetch origin && git checkout v3.0.1 && python2.7 -m sir amqp_watch)
- Turn cron jobs back on, if applicable.
- Restart the MusicBrainz web server, if applicable. It’s also recommended you restart Redis. If you’re accessing your MusicBrainz server in a web browser, run
Here’s the list of resolved tickets:
- [MBS-5359] – *_tag tables are corrupt and need to be regenerated
- [MBS-11760] – Removing the last use of a tag does not always remove the tag
- [MBS-12369] – Standalone databases may be missing foreign keys for the documentation schema
- [MBS-12190] – Add Mood support in the database
- [MBS-11456] – Add MBIDs to artist credits in the database with merge
- [MBS-12141] – Block tag names that are empty or have uncontrolled whitespace with database constraints
- [MBS-12224] – Keep tags’ ref_count and aggregate vote counts updated with triggers
- [MBS-12249] – Add a materialized area_containment table kept up-to-date with triggers
- [MBS-12256] – Keep rating and rating_count column on *_meta tables up-to-date with triggers
- [MBS-12313] – Clarify item naming in the Search drop down menu
Database Schema Change Task
- [MBS-11457] – Drop the series ordering_attribute column
- [MBS-11755] – Remove unused tags
- [MBS-12157] – Remove support for Amazon cover art
- [MBS-12200] – Drop schema objects related to Amazon cover art support
- [MBS-12225] – Rename “slave” to “mirror” (inclusive language update)
- [MBS-12250] – Create dbmirror2 schema on production and mirror servers
- [MBS-12252] – Add edit_genre table
- [MBS-12253] – Add relationship tables for genres
- [MBS-12254] – Add genre_annotation table
- [MBS-12255] – Add genre_alias_type table and make genre_alias consistent