Document compatibility with MBDB schema sequences

metabrainz · Dec 29, 2020 · a586387 · a586387
1 parent 38a7835
commit a586387
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/source/setup/index.rst b/docs/source/setup/index.rst
@@ -6,4 +6,5 @@ Setup
 .. include:: install.rst
 .. include:: amqp.rst
 .. include:: solr.rst
+.. include:: mbdbschema.rst
 .. include:: wscompat.rst
diff --git a/docs/source/setup/mbdbschema.rst b/docs/source/setup/mbdbschema.rst
@@ -0,0 +1,12 @@
+MusicBrainz Database Schema
+----
+
+Of course you'll need a MusicBrainz database somewhere to read the data from.
+The active database schema sequence must be `26` (or any future schema version
+if still compatible). Follow `announcements`_ from the MetaBrainz blog.
+
+Only Sir `1.y.z` is able to read from database of schema sequence `25` (or
+`26` which does not break anything, or any future schema if still compatible).
+It only reads (and sends) the data made available from schema sequence `25`.
+
+.. _announcements: https://blog.metabrainz.org/category/schema-change-release/