aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Server/Migrations/IMigrationRoutine.cs
blob: 29f681df5295e9de3dcd7ce330e80089e64878b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
using System;
using Jellyfin.Server.Implementations;
using Microsoft.EntityFrameworkCore.Internal;

namespace Jellyfin.Server.Migrations
{
    /// <summary>
    /// Interface that describes a migration routine.
    /// </summary>
    internal interface IMigrationRoutine
    {
        /// <summary>
        /// Gets the unique id for this migration. This should never be modified after the migration has been created.
        /// </summary>
        public Guid Id { get; }

        /// <summary>
        /// Gets the display name of the migration.
        /// </summary>
        public string Name { get; }

        /// <summary>
        /// Gets a value indicating whether to perform migration on a new install.
        /// </summary>
        public bool PerformOnNewInstall { get; }

        /// <summary>
        /// Execute the migration routine.
        /// </summary>
        public void Perform();
    }
}