PostgreSQL 12 Upgrade Instructions for MusicBrainz Server

Thanks to everyone for your patience during our downtime today. As promised, here are steps to follow to upgrade your own PG instance to v12. (Confused? See the previous blog post on this subject.)

If you’re already running v12, there are still some instructions you must follow!

For MusicBrainz Docker

If you’re running the new MusicBrainz Docker setup, an upgrade script exists for you to use. See the release notes for specific – hopefully brief – instructions.

For a Manual Setup (INSTALL.md Based)

If you aren’t using Docker but rather set up musicbrainz-server by hand following INSTALL.md, see the steps below.

Know that as an alternative, you can always import new data dumps from scratch (again following the steps in INSTALL.md) into a new PG 12 cluster. Just make sure you’re on the v-2020-05-18-postgres12 tag of musicbrainz-server while doing so.

If on the other hand you don’t mind getting your hands a bit dirty, you can use the quicker method below. Like INSTALL.md, this assumes you’re using Ubuntu/Debian and their postgresql-common cluster management tools.

If you’re already running v12, you should still follow these steps; however, you can skip the ones involving apt-get, pg_dropcluster, and pg_upgradecluster. The main steps you need to follow in this case are running the 20200518-pg12-before-upgrade.sql and 20200518-pg12-after-upgrade.sql scripts in that order.

On distros other than Debian/Ubuntu where the postgresql-common tools aren’t available, you’ll have to manage with initdb and pg_upgrade on your own.

  1. First take down the web server running MusicBrainz (stop plackup) to prevent database access.
  2. Turn off any cron jobs updating or accessing the database (e.g. for the live data feed/replication packets).
  3. Switch to the latest musicbrainz-server code with:
    git fetch origin && \
    git checkout v-2020-05-18-postgres12
  4. With PG 9.5 (or whatever version you’re using) still running, run the following “pre-upgrade” script:
    psql -U postgres -d musicbrainz_db \
    -f admin/sql/updates/20200518-pg12-before-upgrade.sql

    This assumes that “postgres” is the name of your PG superuser, and “musicbrainz_db” is the name of your database. If you see a few messages about things not existing, that’s normal.

  5. Install packages for PostgreSQL 12. On Ubuntu/Debian you can obtain them from the PGDG apt repo.
    apt-get update && \
    apt-get install postgresql-12 postgresql-server-dev-12

    If you’re installing postgresql-12 for the first time, this will automatically create a new cluster at /var/lib/postgresql/12/main. Remove that empty cluster. Don’t run this if you already had v12 installed and have data there!

    pg_dropcluster --stop 12 main
    If you did already have v12 installed with musicbrainz_db running there, leave the cluster alone and skip the next step involving pg_upgradecluster.

    In the unlikely event that you already have a v12 cluster, but also have musicbrainz_db running in a separate, older cluster, these instructions won’t work for you. We recommend importing fresh data dumps into the v12 cluster and dropping the old one.

  6. Upgrade the old cluster. This assumes it’s version 9.5; if you’re using version 10 or 11, make sure to replace 9.5 below with 10 or 11. If you have other databases in your old cluster besides musicbrainz_db, be aware that this will upgrade all of them to PG 12.
     pg_upgradecluster -v 12 9.5 main
  7. If all goes well, the new cluster should be up and running. (You can drop the old one if you like; the output of the pg_upgradecluster command will tell you how.) Now run the following “post-upgrade” script on the database:
    psql -U postgres -d musicbrainz_db -f \
    admin/sql/updates/20200518-pg12-after-upgrade.sql
    This may take a bit, as it has to recreate some indexes.
  8. The upgrade is complete. You can turn cron jobs back on, if applicable.
  9. Restart the MusicBrainz web server / plackup, if applicable. If you’re accessing the server in a web browser, the usual release upgrade steps apply, like running ./script/compile_resources.sh again.

If you run into any trouble following the above, please let us know and we’ll try to help resolve your issue as soon as possible!

MusicBrainz Server update, 2020-05-11

This is the last update before upgrading to Postgres 12. It is mainly focused on React conversion but also carries ten small bugfixes and improvements.

Thanks to navap for hacking the user interface. Thanks to admiy, chaban, fabe56, Freso, jesus2099, zas for having reported bugs and suggested improvements. Thanks to kellnerd, mfmeulenbelt, and salorock for updating the translations. And thanks to all others who tested the beta version!

The git tag is v-2020-05-11.

Bug

Improvement

  • [MBS-10737] – Allow thesession.org URLs for Places
  • [MBS-10761] – Disallow YouTube links at wrong levels
  • [MBS-10804] – Remove redundant user header from edit page
  • [MBS-10805] – Support for Amazon.AE/NL/SG/TR ASINs

React Conversion Task

  • [MBS-9910] – Convert wikidocs transclusion admin templates to React/JSX
  • [MBS-10748] – Convert the relationship doc page to React
  • [MBS-10760] – Convert Remove Track edit to React
  • [MBS-10762] – Convert historic Remove Release/Releases edits to React
  • [MBS-10764] – Convert historic Remove Label Alias edits to React
  • [MBS-10765] – Convert historic Add, Move and Remove DiscID edits to React
  • [MBS-10773] – Convert historic Change Release Quality edit to React
  • [MBS-10775] – Convert historic Add/Remove Relationship edits to React
  • [MBS-10790] – Convert historic MAC/SAC edits to React
  • [MBS-10791] – Convert historic Change RG edit to React
  • [MBS-10792] – Convert historic Change Artist Quality edit to React
  • [MBS-10811] – Convert historic Edit Relationship edit to React

Reminder: Upgrading to PostgreSQL 12 on May 18, 2020

As we announced in February, in two weeks time (May 18, 2020) we’ll be upgrading our production database server to PostgreSQL v12 (from v9.5). At the same time, v12 will become the minimum supported version for MusicBrainz Server, so we ask that you upgrade afterwards as soon as possible! If you’re still unsure, a Q&A is below.

When do I need to upgrade my postgres by?

As soon as possible after May 18 if you’d like to keep your musicbrainz-server code up to date.

How do I perform the upgrade?

We’ll provide instructions closer to May 18. It’s recommended that you don’t upgrade until then, since we’ll be providing scripts to resolve some issues.

Will the live data feed (replication packets) stop working right away if I don’t upgrade?

No, as long as you keep your musicbrainz-server code checkout on the v-2020-05-11 tag (which will be the final release before May 18) or earlier. Future releases may work for a while too.

This is not a schema change release, so replication will continue to work smoothly until you upgrade. No tables or views will change.

However, to make the upgrade process smoother we’ll be dropping the musicbrainz-collate and musicbrainz-unaccent extensions, instead using PG’s builtin collation support for the former and replacing the latter with the unaccent extension from postgresql-contrib. A few SQL functions are being added to enable this, and some indexes need to be rebuilt. This will all happen as part of upgrade scripts we provide (or you can import from scratch). Some features of musicbrainz-server that use these old extensions may cease to work if you don’t apply them.

The extension changes above don’t actually make use of any new PG 12 features. We’ll avoid using such features for at least 1 month.

If I’m already running PostgreSQL 12, do I need to do anything?

Yes, but things will be easier for you. As mentioned in the previous answer, we’ll be dropping the musicbrainz-collate and musicbrainz-unaccent extensions to make the upgrade process smoother for pre-v12 instances. So you’ll only have to run some upgrade scripts we provide to replace those extensions and rebuild some indexes.

My host/distribution doesn’t have PostgreSQL 12 yet!

If you’re running Debian or Ubuntu, the PGDG maintains an APT repository with the latest versions. These are the same packages MetaBrainz uses in production.

Amazon RDS supports PostgreSQL 12 since March 31.

I absolutely cannot upgrade yet! What should I do?

You can stay on the v-2020-05-11 release of musicbrainz-server or earlier until then. Replication packets (i.e. the live data feed) will continue to work until the next schema change on that tag, but you’ll have upgraded to v12 by then, right?

Instead of performing a pg_upgrade and running these upgrade scripts you mentioned, can I just import fresh data dumps into a new v12 cluster?

Of course. Just make sure your musicbrainz-server git checkout is on the v-2020-05-18 tag (once that’s released) or later before performing the import. And keep in mind it may be slower than a direct upgrade.

MusicBrainz Server update, 2020-04-27

A large variety of issue types have been addressed in today’s release!

As a new feature, search indexes are now dumped and made available along with database dumps under the FTP directory search-indexes. They are mainly intended to be loaded on a MusicBrainz slave server to start a mirror with search.

Among improvements, a noticeable one is to lighten the area’s overview page that was heavily crowded with all sorts of relationships that have been scattered over more specific tabs.

As for bugfixes, the major one secures user/admin forms against CSRF attacks.

Thanks to atj for contributing code to support Traxsource URLs. Thanks to alex_s7, chaban, danbloo, Lotheric, murdos, Skeebadoo for reporting issues. Thanks to kellnerd, Jormangeud, mfmeulenbelt, salorock for updating the translations in German, Finnish, Dutch, Italian, respectively. And thanks to all others who tested the beta version!

The git tag is v-2020-04-27.

Bug

  • [MBS-10359] – Guess feat. artists from track titles do not give expected result
  • [MBS-10677] – Place type shown as null on WS event place rels
  • [MBS-10717] – Cookie attributes must be adjusted to work with with new behavior in browsers
  • [MBS-10719] – “remove PUID” edit doesn’t load
  • [MBS-10742] – “Show more” country miscount
  • [MBS-10756] – Inconsistent default sort order for recordings on Works page
  • [MBS-10778] – User/admin forms are prone to CSRF attacks

New Feature

  • [MBS-10546] – Dump MB Solr data along with MB DB full export

Improvement

  • [MBS-1921] – Display edit link under annotations
  • [MBS-9086] – Move most relationships away from area overview
  • [MBS-10666] – Collapse work artists when there are too many on merge pages
  • [MBS-10741] – Make “relationship [attribute] in use” pages consistent
  • [MBS-10755] – Add entity type restrictions for musik-sammler.de URLs
  • [MBS-10781] – Add support for Traxsource URLs

React Conversion Task

  • [MBS-10740] – Convert /relationship static pages to React
  • [MBS-10751] – Convert Remove PUID edits to React

MusicBrainz Server update, 2020-04-13

No Easter egg in today’s update but rather a dozen or so of small bugfixes and convenient improvements.

Thanks Rotab for the pair of bugfixes he submitted, to CatQuest, chaban, chirlu, FSpy, HibiscusKazeneko, JesseW, KRSCuan, MichelV, wcw1966 for issues they reported, to salorock for the Italian translation he updated, and to all others who tested the beta version!

The git tag is v-2020-04-13.

Bug

  • [MBS-7465] – Tag cloud isn’t updated
  • [MBS-9169] – Inconsistent locale identifiers
  • [MBS-9728] – Recently-added Unicode emojis can’t be used in titles
  • [MBS-9894] – Timeline shows future date
  • [MBS-10360] – Whitelist User-Agent header in CORS Preflight requests
  • [MBS-10640] – Incorrect donation status in “Donation Check” tab
  • [MBS-10688] – Attaching a CDTOC that already exists on the medium gives a cryptic error
  • [MBS-10718] – Duplicate series “part of” relationships which got grouped are harder to detect
  • [MBS-10730] – Recording is displayed twice in artist overview when credited multiple times

Task

  • [MBS-10735] – Remove (discontinued) CD Baby links from the sidebar

Improvement

  • [MBS-5641] – Show release language/script in reports ReleasesWithUnlikelyLanguageScript, NoLanguage and NoScript
  • [MBS-10679] – Link to the JSON WS from the Details tab
  • [MBS-10680] – Link to WS docs from the Details tab
  • [MBS-10724] – Make sorting options (area, date, artist) consistent
  • [MBS-10747] – Change wording/phrasing of status description for open edits
  • [MBS-10753] – Use artist sort names for artist collection ordering

MusicBrainz Server update, 2020-03-31

This time we have a couple bugfixes, a couple of small improvements, and continued changes to simplify the React table code.

Thanks to chaban, kellnerd, Kid Devine, and all others who submitted patches, reported issues, tested beta version, or contributed to translations!

The git tag is v-2020-03-31.

Bug

  • [MBS-10704] – Relationships header shown for works with no rels to be displayed
  • [MBS-10707] – Open Add DiscID edit already adds discID, cancelling does not remove it
  • [MBS-10712] – ISE when trying to load “merge release” edit

Improvement

  • [MBS-10669] – Restrict “Metal Archives” album links to release
  • [MBS-10699] – Remove “medley” from Guess Case when at the end of a title

Task

  • [MBS-10365] – Refactor display of entity list/table
  • [MBS-0401] – Replace handshaking protocol with bit mask

MusicBrainz Server update, 2020-03-16

Mostly bugfixes today, along with a new data report, plus usual small improvements, React conversion and refactoring. We also blocked ratings for unverified users, since a specific artist was getting hundreds of ratings by people creating many accounts per person just for that (people, please be nice!).

Thanks to andrybo6, chaban, cyna, dimpole, dseomn, gioele, hibiscuskazeneko, jesus2099, kellnerd, mfmeulenbelt, nikki, outsidecontext, panos, sophist, sothotalker, yindesu, and all others who submitted patches, reported issues, tested beta version, or contributed to translations!

The git tag is v-2020-03-16.

Bug

  • [MBS-7835] – [No lyrics] works showing up as “No linguistic content” in old edit summaries
  • [MBS-9359] – Web service shows “mul” languages, but all single languages are duplicates
  • [MBS-9651] – Top voters overall includes more edits than editor profile’s yes+no+approve
  • [MBS-10628] – [no label] should not be editable
  • [MBS-10633] – Can’t change capitalization on username
  • [MBS-10661] – Recording-work rel not showing pending edits on release page
  • [MBS-10683] – Map doesn’t focus on new marker when creating a new Place
  • [MBS-10684] – Message over Place’s map is misleading
  • [MBS-10685] – Place maps: Zooming by clicking doesn’t follow the cursor
  • [MBS-10693] – Artist merge submission page doesn’t show any error message if you attempt to merge a special purpose artist

Improvement

  • [MBS-4090] – Report for recordings with a single track but with different spellings
  • [MBS-10607] – Give context to translations of “unknown” / “(unknown)”
  • [MBS-10676] – Add MD5/SHA256 checksum files for JSON data dumps
  • [MBS-10695] – Show full language names on work lists

React Conversion Task

  • [MBS-10618] – Convert Edit work edit to React

Other Task

  • [MBS-10671] – Block ratings for unverified users
  • [MBS-10689] – Update MapBox API calls
  • [MBS-10692] – Change React imports to “import * as React”