move database changes to MigrationRoutine

Emby.Server.Implementations/Data/BaseSqliteRepository.cs

@@ -174,21 +174,6 @@ namespace Emby.Server.Implementations.Data
             return columnNames;
         }
 
-        protected Dictionary<string, string> GetColumnTypes(SqliteConnection connection, string table)
-        {
-            var columnTypes = new Dictionary<string, string>();
-
-            foreach (var row in connection.Query("PRAGMA table_info(" + table + ")"))
-            {
-                if (row.TryGetString(1, out var columnName) && row.TryGetString(2, out var columnType))
-                {
-                    columnTypes[columnName] = columnType;
-                }
-            }
-
-            return columnTypes;
-        }
-
         protected void AddColumn(SqliteConnection connection, string table, string columnName, string type, List<string> existingColumnNames)
         {
             if (existingColumnNames.Contains(columnName, StringComparison.OrdinalIgnoreCase))

Emby.Server.Implementations/Data/SqliteItemRepository.cs

@@ -521,18 +521,6 @@ namespace Emby.Server.Implementations.Data
                 AddColumn(connection, "TypedBaseItems", "Height", "INT", existingColumnNames);
                 AddColumn(connection, "TypedBaseItems", "Size", "BIGINT", existingColumnNames);
 
-                // change type of OwnerId from TEXT to GUID so database can use index when compared to guid column
-                // sadly sqlite doesn't support to change column types directly (see: https://www.sqlite.org/lang_altertable.html)
-                // it would be much cleaner to use a database migration tool with proper versioning like evolve to execute the necessary databse changes for new versions (see: https://github.com/lecaillon/Evolve)
-                var columnTypes = GetColumnTypes(connection, "TypedBaseItems");
-                if (columnTypes["OwnerId"] == "TEXT")
-                {
-                    connection.Execute("ALTER TABLE TypedBaseItems RENAME COLUMN OwnerId TO OwnerId_OLD");
-                    connection.Execute("ALTER TABLE TypedBaseItems ADD COLUMN OwnerId GUID NULL");
-                    connection.Execute("UPDATE TypedBaseItems SET OwnerId = OwnerId_OLD WHERE OwnerId_OLD IS NOT NULL");
-                    connection.Execute("ALTER TABLE TypedBaseItems DROP COLUMN OwnerId_OLD");
-                }
-
                 existingColumnNames = GetColumnNames(connection, "ItemValues");
                 AddColumn(connection, "ItemValues", "CleanValue", "Text", existingColumnNames);
 

Jellyfin.Server/Migrations/MigrationRunner.cs

@@ -43,7 +43,8 @@ namespace Jellyfin.Server.Migrations
             typeof(Routines.MigrateAuthenticationDb),
             typeof(Routines.FixPlaylistOwner),
             typeof(Routines.MigrateRatingLevels),
-            typeof(Routines.AddDefaultCastReceivers)
+            typeof(Routines.AddDefaultCastReceivers),
+            typeof(Routines.ChangeTypeOfTypedBaseItemsOwnerIdToGuid)
         };
 
         /// <summary>

Jellyfin.Server/Migrations/Routines/ChangeTypeOfTypedBaseItemsOwnerIdToGuid.cs

@@ -0,0 +1,96 @@
+using System;
+using System.Globalization;
+using System.IO;
+using Emby.Server.Implementations.Data;
+using MediaBrowser.Controller;
+using Microsoft.Data.Sqlite;
+using Microsoft.Extensions.Logging;
+
+namespace Jellyfin.Server.Migrations.Routines
+{
+    /// <summary>
+    /// Change type of TypedBaseItems.OwnerId to GUID so database can use index when compared to guid column.
+    /// </summary>
+    internal class ChangeTypeOfTypedBaseItemsOwnerIdToGuid : IMigrationRoutine
+    {
+        private const string DbFilename = "library.db";
+        private readonly ILogger<ChangeTypeOfTypedBaseItemsOwnerIdToGuid> _logger;
+        private readonly IServerApplicationPaths _paths;
+
+        public ChangeTypeOfTypedBaseItemsOwnerIdToGuid(ILogger<ChangeTypeOfTypedBaseItemsOwnerIdToGuid> logger, IServerApplicationPaths paths)
+        {
+            _logger = logger;
+            _paths = paths;
+        }
+
+        /// <inheritdoc/>
+        public Guid Id => Guid.Parse("{9ACD7444-568D-4E20-89A1-B0E0D94023AC}");
+
+        /// <inheritdoc/>
+        public string Name => "ChangeTypeOfTypedBaseItemsOwnerIdToGuid";
+
+        /// <inheritdoc/>
+        public bool PerformOnNewInstall => false;
+
+        /// <inheritdoc/>
+        public void Perform()
+        {
+            var dataPath = _paths.DataPath;
+            var dbPath = Path.Combine(dataPath, DbFilename);
+            using (var connection = new SqliteConnection($"Filename={Path.Combine(dataPath, DbFilename)}"))
+            {
+                // Back up the database before column is changed
+                for (int i = 1; ; i++)
+                {
+                    var bakPath = string.Format(CultureInfo.InvariantCulture, "{0}.bak{1}", dbPath, i);
+                    if (!File.Exists(bakPath))
+                    {
+                        try
+                        {
+                            File.Copy(dbPath, bakPath);
+                            _logger.LogInformation("Library database backed up to {BackupPath}", bakPath);
+                            break;
+                        }
+                        catch (Exception ex)
+                        {
+                            _logger.LogError(ex, "Cannot make a backup of {Library} at path {BackupPath}", DbFilename, bakPath);
+                            throw;
+                        }
+                    }
+                }
+
+                // Determine the type of TypedBaseItems.OwnerId
+                _logger.LogInformation("Determine type of column TypedBaseItems.OwnerId.");
+                var result = connection.Query("SELECT type FROM pragma_table_info('TypedBaseItems') WHERE name = 'OwnerId'").GetEnumerator();
+                if (result.MoveNext())
+                {
+                    var row = result.Current;
+
+                    // If the type is TEXT change it to GUID so the database can use indexes when OwnerId is compared to guid column
+                    if (row.TryGetString(0, out var columnType) && columnType != "GUID")
+                    {
+                        _logger.LogInformation("Type of column TypedBaseItems.OwnerId is {ColumnType} -> changing to GUID.", columnType);
+
+                        // use separate connections for alter table commands to prevent sqlite "database table is locked" exception
+                        using (var alterTableConnection = new SqliteConnection($"Filename={Path.Combine(dataPath, DbFilename)}"))
+                        using (var transaction = alterTableConnection.BeginTransaction())
+                        {
+                            alterTableConnection.Execute("DROP INDEX IF EXISTS idx_TypedBaseItemsOwnerId");
+                            alterTableConnection.Execute("ALTER TABLE TypedBaseItems RENAME COLUMN OwnerId TO OwnerId_OLD");
+                            alterTableConnection.Execute("ALTER TABLE TypedBaseItems ADD COLUMN OwnerId GUID NULL");
+                            alterTableConnection.Execute("UPDATE TypedBaseItems SET OwnerId = OwnerId_OLD WHERE OwnerId_OLD IS NOT NULL");
+                            alterTableConnection.Execute("ALTER TABLE TypedBaseItems DROP COLUMN OwnerId_OLD");
+                            alterTableConnection.Execute("CREATE INDEX idx_TypedBaseItemsOwnerId ON TypedBaseItems(OwnerId)");
+                            transaction.Commit();
+                        }
+                    }
+                    else
+                    {
+                        // Do nothing if the column is already of type GUID
+                        _logger.LogInformation("Type of column TypedBaseItems.OwnerId is GUID -> no migration necessary");
+                    }
+                }
+            }
+        }
+    }
+}