eb4c05eda2
Support externally-provisioned databases (opt-in, no drop/create) (cherry picked from commit 2e117c26764483fb4ee3de9540c9bf7a647d8067)
80 lines
3.4 KiB
C#
80 lines
3.4 KiB
C#
// <copyright file="IMigratableDatabaseContextProvider.cs" company="MUnique">
|
|
// Licensed under the MIT License. See LICENSE file in the project root for full license information.
|
|
// </copyright>
|
|
namespace MUnique.OpenMU.Persistence;
|
|
|
|
using System.Threading;
|
|
|
|
/// <summary>
|
|
/// Provider for persistence contexts which supports database creation and migration.
|
|
/// TODO: find better name?.
|
|
/// </summary>
|
|
public interface IMigratableDatabaseContextProvider : IPersistenceContextProvider
|
|
{
|
|
/// <summary>
|
|
/// Determines if the database exists already, by checking if any migration has been applied.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>
|
|
/// <c>True</c>, if the database exists; Otherwise, <c>false</c>.
|
|
/// </returns>
|
|
Task<bool> DatabaseExistsAsync(CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Determines whether the database schema is up to date.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>
|
|
/// <c>true</c> if the database is up to date; otherwise, <c>false</c>.
|
|
/// </returns>
|
|
Task<bool> IsDatabaseUpToDateAsync(CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Applies all pending updates to the database schema.
|
|
/// </summary>
|
|
Task ApplyAllPendingUpdatesAsync();
|
|
|
|
/// <summary>
|
|
/// Waits until all database updates are applied.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
Task WaitForUpdatedDatabaseAsync(CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Determines whether this instance can connect to the database.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>
|
|
/// <c>true</c> if this instance can connect to the database; otherwise, <c>false</c>.
|
|
/// </returns>
|
|
Task<bool> CanConnectToDatabaseAsync(CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Determines whether this instance should do an automatic schema update
|
|
/// without asking the user.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>
|
|
/// <c>true</c> if this instance should do an automatic schema update
|
|
/// without asking the user.; otherwise, <c>false</c>.
|
|
/// </returns>
|
|
Task<bool> ShouldDoAutoSchemaUpdateAsync(CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Recreates the database by deleting and creating it again.
|
|
/// </summary>
|
|
/// <param name="dropExistingDatabase">
|
|
/// If <see langword="true"/> (the default), the database is dropped and created again from scratch.
|
|
/// If <see langword="false"/>, the existing database is kept and only its schema is built via
|
|
/// migrations. Set this to <see langword="false"/> when the database is provisioned externally
|
|
/// (e.g. by a Kubernetes operator, infrastructure-as-code, or a managed cloud database) and the
|
|
/// connecting role is not permitted to create or drop databases.
|
|
/// </param>
|
|
/// <returns>The disposable which should be disposed when the data creation process is finished.</returns>
|
|
Task<IDisposable> ReCreateDatabaseAsync(bool dropExistingDatabase = true);
|
|
|
|
/// <summary>
|
|
/// Resets the cache of this instance.
|
|
/// </summary>
|
|
void ResetCache();
|
|
} |