schema.xml

<?xml version="1.0" encoding="utf-8"?>
<!--
This is the Mixxx schema history file. It keeps track of internal changes to the
Mixxx database schema and allows Mixxx to automatically upgrade itself to new
revisions of the schema on a version upgrade.

DO NOT EDIT THIS FILE OR YOU WILL BREAK YOUR MIXXX LIBRARY AND LOSE YOUR
METADATA

Backwards compatible migrations are required to be "reappliable" safely
after the database has been opened and used with an older Mixxx version!!
Backward compatible schema migrations must ensure that they do not fail
on a newer schema version and that they neither overwrite nor delete
any existing data. If this is not possible then a migration does not
qualify to be backwards compatible. In this case the min_compatible
attribute has to be set to the current version, i.e. the same version
as the migration.

Errors when adding table columns that already exist when reapplying a
migration are gracefully ignored during schema migration to allow
reapplying those migrations.
-->
<schema>
  <revision version="1">
    <description>
      The base schema for the Mixxx SQLITE database.
    </description>
    <sql>
      CREATE TABLE IF NOT EXISTS settings (
        name TEXT UNIQUE NOT NULL,
        value TEXT,
        locked INTEGER DEFAULT 0,
        hidden INTEGER DEFAULT 0);

      CREATE TABLE IF NOT EXISTS track_locations (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        location varchar(512) UNIQUE,
        filename varchar(512),
        directory varchar(512),
        filesize INTEGER,
        fs_deleted INTEGER,
        needs_verification INTEGER);

      CREATE TABLE IF NOT EXISTS LibraryHashes (
        directory_path VARCHAR(256) PRIMARY KEY,
        hash INTEGER,
        directory_deleted INTEGER);

      CREATE TABLE IF NOT EXISTS library (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        artist varchar(48), title varchar(48),
        album varchar(48), year varchar(16),
        genre varchar(32), tracknumber varchar(3),
        location varchar(512) REFERENCES track_locations(location),
        comment varchar(20), url varchar(256),
        duration FLOAT,
        bitrate INTEGER, samplerate INTEGER,
        cuepoint INTEGER, bpm FLOAT,
        wavesummaryhex BLOB,
        channels INTEGER,
        datetime_added DEFAULT CURRENT_TIMESTAMP,
        mixxx_deleted INTEGER,
        played INTEGER);

      CREATE TABLE Playlists (
        id INTEGER PRIMARY KEY,
        name varchar(48),
        position INTEGER,
        hidden INTEGER DEFAULT 0 NOT NULL,
        date_created datetime,
        date_modified datetime);

      CREATE TABLE PlaylistTracks (
        id INTEGER PRIMARY KEY,
        playlist_id INTEGER REFERENCES Playlists(id),
        track_id INTEGER REFERENCES library(id),
        position INTEGER);

      CREATE TABLE IF NOT EXISTS cues (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        track_id INTEGER NOT NULL REFERENCES library(id),
        type INTEGER DEFAULT 0 NOT NULL,
        <!-- Positions and lengths are actually stored as SQLite REAL (double) frame values.
        This allows for bpm-accurate sub-sample accuracy positions and lengths. -->
        position INTEGER DEFAULT -1 NOT NULL,
        length INTEGER DEFAULT 0 NOT NULL,
        hotcue INTEGER DEFAULT -1 NOT NULL,
        label TEXT DEFAULT '' NOT NULL);

      CREATE TABLE IF NOT EXISTS crates (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        name varchar(48) UNIQUE NOT NULL,
        count INTEGER DEFAULT 0,
        show INTEGER DEFAULT 1);

      CREATE TABLE IF NOT EXISTS crate_tracks (
        crate_id INTEGER NOT NULL REFERENCES crates(id),
        track_id INTEGER NOT NULL REFERENCES library(id),
        UNIQUE (crate_id, track_id));

    </sql>
  </revision>
  <revision version="2">
    <description>
      Add a header_parsed integer column to the library to indicate when a
      track's tags have been parsed.
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN header_parsed INTEGER DEFAULT 0;
    </sql>
  </revision>
  <revision version="3">
    <description>
      Change the location column to be a an integer. Change comment to be
      varchar(256) and album/artist/title to be varchar(64).
    </description>
    <sql>
      ALTER TABLE library RENAME TO library_old;

      CREATE TABLE IF NOT EXISTS library (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        artist varchar(64),
        title varchar(64),
        album varchar(64),
        year varchar(16),
        genre varchar(64),
        tracknumber varchar(3),
        location INTEGER REFERENCES track_locations(location),
        comment varchar(256),
        url varchar(256),
        duration FLOAT,
        bitrate INTEGER,
        samplerate INTEGER,
        cuepoint INTEGER,
        bpm FLOAT,
        wavesummaryhex BLOB,
        channels INTEGER,
        datetime_added DEFAULT CURRENT_TIMESTAMP,
        mixxx_deleted INTEGER,
        played INTEGER,
        header_parsed INTEGER DEFAULT 0);

      INSERT INTO library (id, artist, title, album, year, genre, tracknumber, location, comment, url, duration, bitrate, samplerate, bpm, cuepoint, bpm, wavesummaryhex, channels, datetime_added, mixxx_deleted, played, header_parsed) SELECT id, artist, title, album, year, genre, tracknumber, location, comment, url, duration, bitrate, samplerate, bpm, cuepoint, bpm, wavesummaryhex, channels, datetime_added, mixxx_deleted, played, header_parsed from library_old;

      DROP TABLE library_old;
    </sql>
  </revision>
  <revision version="4">
    <description>
      Add file type column.
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN filetype varchar(8) DEFAULT "?";
    </sql>
  </revision>
  <revision version="5">
    <description>
      Add needs_verification column to library hashes table.
    </description>
    <sql>
      ALTER TABLE LibraryHashes ADD COLUMN needs_verification INTEGER DEFAULT 0;
    </sql>
  </revision>
  <revision version="6">
    <description>
      Added a ReplayGain Column.
    </description>
    <sql>
        ALTER TABLE library ADD COLUMN replaygain FLOAT DEFAULT 0;
    </sql>
  </revision>
  <revision version="7" min_compatible="3">
    <description>
      Add timesplayed and rating column. Reset header state.
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN timesplayed INTEGER DEFAULT 0;
      ALTER TABLE library ADD COLUMN rating INTEGER DEFAULT 0;
      ALTER TABLE library ADD COLUMN key varchar(8) DEFAULT "";
      UPDATE library SET timesplayed = played;
      UPDATE library SET played = 0;

      DELETE FROM settings WHERE name="mixxx.db.model.library.header_state";
      DELETE FROM settings WHERE name="mixxx.db.model.playlist.header_state";
      DELETE FROM settings WHERE name="mixxx.db.model.crate.header_state";
      DELETE FROM settings WHERE name="mixxx.db.model.prepare.header_state";
      DELETE FROM settings WHERE name="mixxx.db.model.missing.header_state";
    </sql>
  </revision>
  <revision version="8" min_compatible="3">
    <description>
      Added iTunes tables
    </description>
    <sql>
      CREATE TABLE IF NOT EXISTS itunes_library (
        id INTEGER PRIMARY KEY,
        artist varchar(48), title varchar(48),
        album varchar(48), year varchar(16),
        genre varchar(32), tracknumber varchar(3),
        location varchar(512),
        comment varchar(60),
        duration INTEGER,
        bitrate INTEGER,
        bpm INTEGER,
        rating INTEGER);

       CREATE TABLE IF NOT EXISTS itunes_playlists (
        id INTEGER PRIMARY KEY,
        name varchar(100) UNIQUE);

      CREATE TABLE IF NOT EXISTS itunes_playlist_tracks (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        playlist_id INTEGER REFERENCES itunes_playlist(id),
        track_id INTEGER REFERENCES itunes_library(id));
    </sql>
  </revision>
  <revision version="9" min_compatible="3">
    <description>
      Tables for Traktor library feature
    </description>
    <sql>
     CREATE TABLE IF NOT EXISTS traktor_library (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        artist varchar(48), title varchar(48),
        album varchar(48), year varchar(16),
        genre varchar(32), tracknumber varchar(3),
        location varchar(512) UNIQUE,
        comment varchar(60),
        duration INTEGER,
        bitrate INTEGER,
        bpm FLOAT,
        key varchar(6),
        rating INTEGER
        );
      CREATE TABLE IF NOT EXISTS traktor_playlists (
        id INTEGER PRIMARY KEY,
        name varchar(100) UNIQUE
        );
      CREATE TABLE IF NOT EXISTS traktor_playlist_tracks (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        playlist_id INTEGER REFERENCES traktor_playlist(id),
        track_id INTEGER REFERENCES traktor_library(id)
        );
    </sql>
  </revision>
  <revision version="10" min_compatible="3">
    <description>
      Playlist and crate locks
    </description>
    <sql>
      ALTER TABLE crates ADD COLUMN locked INTEGER DEFAULT 0;
      ALTER TABLE playlists ADD COLUMN locked INTEGER DEFAULT 0;
    </sql>
  </revision>
  <revision version="11" min_compatible="3">
    <description>
      Tables for Rhythmbox library feature
    </description>
    <sql>
      CREATE TABLE IF NOT EXISTS rhythmbox_library (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        artist varchar(48), title varchar(48),
        album varchar(48), year varchar(16),
        genre varchar(32), tracknumber varchar(3),
        location varchar(512) UNIQUE,
        comment varchar(60),
        duration INTEGER,
        bitrate INTEGER,
        bpm FLOAT,
        key varchar(6),
        rating INTEGER
        );
      CREATE TABLE IF NOT EXISTS rhythmbox_playlists (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        name varchar(100) UNIQUE
        );
      CREATE TABLE IF NOT EXISTS rhythmbox_playlist_tracks (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        playlist_id INTEGER REFERENCES rhythmbox_playlist(id),
        track_id INTEGER REFERENCES rhythmbox_library(id)
        );
    </sql>
  </revision>
  <revision version="12" min_compatible="3">
    <description>
      Add beats column to library table.
    </description>
    <sql>
      ALTER TABLE Library ADD COLUMN beats BLOB;
      ALTER TABLE Library ADD COLUMN beats_version TEXT;
    </sql>
  </revision>
  <revision version="13" min_compatible="3">
    <description>
      Add position column to Rhythmbox, iTunes, and Traktor playlist tables.
    </description>
    <sql>
      ALTER TABLE itunes_playlist_tracks ADD COLUMN position INTEGER DEFAULT 0;
      ALTER TABLE rhythmbox_playlist_tracks ADD COLUMN position INTEGER DEFAULT 0;
      ALTER TABLE traktor_playlist_tracks ADD COLUMN position INTEGER DEFAULT 0;
    </sql>
  </revision>
  <revision version="14" min_compatible="3">
    <description>
      Add composer column to library table.
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN composer varchar(64) DEFAULT "";
    </sql>
  </revision>
  <revision version="15" min_compatible="3">
    <description>
      Add datetime_added to playlists tracks.
    </description>
    <sql>
      ALTER TABLE PlaylistTracks ADD COLUMN pl_datetime_added;
    </sql>
  </revision>
  <revision version="16" min_compatible="3">
    <description>
      Add track analysis table.
    </description>
    <sql>
    CREATE TABLE IF NOT EXISTS track_analysis (
      id INTEGER PRIMARY KEY AUTOINCREMENT,
      track_id INTEGER NOT NULL REFERENCES track_locations(id),
      type varchar(512),
      description varchar(1024),
      version varchar(512),
      created DEFAULT CURRENT_TIMESTAMP,
      data_checksum varchar(512)
    );
    UPDATE library SET wavesummaryhex = '';
    CREATE INDEX IF NOT EXISTS track_analysis_track_id_index ON track_analysis (track_id);
    </sql>
  </revision>
  <revision version="17" min_compatible="3">
    <description>
      Add columns for BPM lock and a sub-version string for beats.
    </description>
    <sql>
      ALTER TABLE Library ADD COLUMN bpm_lock INTEGER DEFAULT 0;
      ALTER TABLE Library ADD COLUMN beats_sub_version TEXT DEFAULT '';
    </sql>
  </revision>
  <revision version="18" min_compatible="3">
    <description>
      Add keys column to library table.
    </description>
    <sql>
      ALTER TABLE Library ADD COLUMN keys BLOB;
      ALTER TABLE Library ADD COLUMN keys_version TEXT;
      ALTER TABLE Library ADD COLUMN keys_sub_version TEXT;
    </sql>
  </revision>
  <revision version="19" min_compatible="3">
    <description>
      Add key_id column to library table for caching the global key. Default to
      INVALID.
    </description>
    <sql>
      ALTER TABLE Library ADD COLUMN key_id INTEGER DEFAULT 0;
    </sql>
  </revision>
  <revision version="20" min_compatible="3">
    <description>
      Crates in AutoDJ queue (for automated random-track selection).
    </description>
    <sql>
      ALTER TABLE crates ADD COLUMN autodj_source INTEGER DEFAULT 0;
    </sql>
  </revision>
  <revision version="21" min_compatible="3">
    <description>
      Add grouping and album_artist column to library table.
    </description>
    <sql>
      ALTER TABLE Library ADD COLUMN grouping TEXT DEFAULT "";
      ALTER TABLE Library ADD COLUMN album_artist TEXT DEFAULT "";
    </sql>
  </revision>
  <revision version="22" min_compatible="3">
    <description>
      Add grouping and album_artist column to itunes_library table.
    </description>
    <sql>
      ALTER TABLE itunes_library ADD COLUMN grouping TEXT DEFAULT "";
      ALTER TABLE itunes_library ADD COLUMN album_artist TEXT DEFAULT "";
    </sql>
  </revision>
  <revision version="23" min_compatible="3">
    <description>
      Add directories table
    </description>
    <sql>
      CREATE TABLE IF NOT EXISTS directories (
        directory TEXT UNIQUE
      );
    </sql>
  </revision>
  <revision version="24" min_compatible="3">
    <description>
      Add cover art support. Default source is UNKNOWN and default type is NONE.
      <!-- See library/coverart.h. -->
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN coverart_source INTEGER DEFAULT 0;
      ALTER TABLE library ADD COLUMN coverart_type INTEGER DEFAULT 0;
      ALTER TABLE library ADD COLUMN coverart_location TEXT DEFAULT "";
      ALTER TABLE library ADD COLUMN coverart_hash INTEGER DEFAULT 0;
    </sql>
  </revision>
  <revision version="25" min_compatible="3">
    <description>
      Add full replay gain support including peak amplitude. The default
      value for the peak amplitude is "undefined", represented by any
      negative value. The internal constant for "undefined" is -1.0.
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN replaygain_peak REAL DEFAULT -1.0;
    </sql>
  </revision>
  <revision version="26" min_compatible="3">
    <description>
      Add new column "tracktotal" column that stores the total number of
      tracks as a string. The total number of tracks will be reloaded
      from the corresponding file upon first access when encountering
      the default value.
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN tracktotal TEXT DEFAULT '//';
    </sql>
  </revision>
  <revision version="27" min_compatible="3">
    <description>
      Add cue color support. Default color is #FF0000.
      <!-- See track/cue.h. -->
    </description>
    <sql>
      <!-- Default color is #FFFF0000 (in base 10) -->
      ALTER TABLE cues ADD COLUMN color INTEGER DEFAULT 4294901760 NOT NULL;
    </sql>
  </revision>
  <revision version="28" min_compatible="3">
    <description>
      Reset replay gain info for all FLAC files after fixing a decoding bug in version 2.1.0.
      <!-- The value of 'replaygain_peak' is not yet calculated by any Mixxx analyzer, -->
      <!-- so we should leave it untouched and don't need to reset it here!            -->
      <!-- See also: https://github.com/mixxxdj/mixxx/issues/9255                     -->
    </description>
    <sql>
      <!-- Reset replay gain to default value -->
      UPDATE library SET replaygain=0.0 WHERE filetype='flac' COLLATE NOCASE;
    </sql>
  </revision>
  <revision version="29" min_compatible="3">
    <description>
      This was used in the development of 2.3 to track whether cues were placed
      manually or automatically. However, this turned out to be unnecessary.
      This version is left as a placeholder so users who were using the master
      branch will have their database updated correctly for the subsequent
      schema change.
    </description>
    <sql/>
  </revision>
  <revision version="30" min_compatible="3">
    <description>
      This was used in the development of 2.3 for permanent Rekordbox
      library feature tables, which have since been replaced by
      dynamic temporary tables, similar to the Serato library
      feature.
    </description>
    <sql/>
  </revision>
  <revision version="31" min_compatible="3">
    <description>
      Add track color support.
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN color INTEGER;
    </sql>
  </revision>
  <revision version="32" min_compatible="3">
    <description>
      Convert the PredefinedColor ID to the actual RGB value.
    </description>
    <sql>
      <!-- No Color becomes Orange (not in default palette) -->
      UPDATE cues SET color=0xFF8C00 WHERE color=0;
      <!-- Mixxx Hotcue Color Palette (also defined in src/util/color/colorpalette.h) -->
      <!-- Red -->
      UPDATE cues SET color=0xC50A08 WHERE color=1;
      <!-- Green -->
      UPDATE cues SET color=0x32BE44 WHERE color=2;
      <!-- Blue -->
      UPDATE cues SET color=0x0044FF WHERE color=3;
      <!-- Yellow -->
      UPDATE cues SET color=0xF8D200 WHERE color=4;
      <!-- Celeste -->
      UPDATE cues SET color=0x42D4F4 WHERE color=5;
      <!-- Magenta -->
      UPDATE cues SET color=0xAF00CC WHERE color=6;
      <!-- Pink -->
      UPDATE cues SET color=0xFCA6D7 WHERE color=7;
      <!-- White -->
      UPDATE cues SET color=0xF2F2FF WHERE color=8;
      <!-- Remove alpha channel from cues that were updated by
           previous, in-development schema migrations -->
      UPDATE cues SET color = (color &amp; 0xFFFFFF) WHERE color > 0xFFFFFF;
    </sql>
  </revision>
  <revision version="33" min_compatible="3">
    <description>
      Add cover art image digest and (background) color
    </description>
    <sql>
      ALTER TABLE library ADD COLUMN coverart_color INTEGER;
      ALTER TABLE library ADD COLUMN coverart_digest BLOB;
    </sql>
  </revision>
  <revision version="34" min_compatible="3">
    <description>
      Add indexes for tracks in playlists and crates
    </description>
    <sql>
      CREATE INDEX IF NOT EXISTS idx_PlaylistTracks_playlist_id_track_id ON PlaylistTracks (
          playlist_id,
          track_id
      );
      CREATE INDEX IF NOT EXISTS idx_PlaylistTracks_track_id ON PlaylistTracks (
          track_id
      );
      CREATE INDEX IF NOT EXISTS idx_crate_tracks_track_id ON crate_tracks (
          track_id
      );
    </sql>
  </revision>
  <revision version="35" min_compatible="3">
    <description>
      Add last_played_at column to library table
    </description>
    <sql>
      -- Add new column
      ALTER TABLE library ADD COLUMN last_played_at DATETIME DEFAULT NULL;
    </sql>
  </revision>
  <revision version="36" min_compatible="3">
    <description>
      Populate last_played_at column in library table from play history
    </description>
    <sql>
      -- Populate new column from history playlists
      UPDATE library SET last_played_at=(
        SELECT MAX(PlaylistTracks.pl_datetime_added)
          FROM PlaylistTracks
          JOIN Playlists ON PlaylistTracks.playlist_id=Playlists.id
          WHERE PlaylistTracks.track_id=library.id
          AND Playlists.hidden=2
          GROUP BY PlaylistTracks.track_id);
    </sql>
  </revision>
  <revision version="37" min_compatible="3">
    <description>
      Add source_synchronized_ms column to library table
    </description>
    <!-- source_synchronized_ms: in milliseconds since 1970-01-01T00:00:00.000 UTC -->
    <sql>
      ALTER TABLE library ADD COLUMN source_synchronized_ms INTEGER DEFAULT NULL;
    </sql>
  </revision>
  <revision version="38" min_compatible="3">
    <description>
      Fix 0/NULL issue after upgrade to schema version 37.
    </description>
    <sql>
      UPDATE library SET source_synchronized_ms=NULL WHERE source_synchronized_ms=0;
    </sql>
  </revision>
  <revision version="39" min_compatible="3">
    <description>
      Replace file type "aif" with "aiff".
    </description>
    <sql>
      UPDATE library SET filetype='aiff' WHERE filetype='aif';
    </sql>
  </revision>
</schema>