From 6c9778b55dd8367d38280c66e0f308c5332029ed Mon Sep 17 00:00:00 2001
From: crupest <crupest@outlook.com>
Date: Tue, 27 Apr 2021 18:38:26 +0800
Subject: refactor: Refactor is still on...

---
 .../Services/DatabaseManagement/IDatabaseCustomMigration.cs      | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'BackEnd/Timeline/Services/DatabaseManagement/IDatabaseCustomMigration.cs')

diff --git a/BackEnd/Timeline/Services/DatabaseManagement/IDatabaseCustomMigration.cs b/BackEnd/Timeline/Services/DatabaseManagement/IDatabaseCustomMigration.cs
index 7300ccbd..a38dcb99 100644
--- a/BackEnd/Timeline/Services/DatabaseManagement/IDatabaseCustomMigration.cs
+++ b/BackEnd/Timeline/Services/DatabaseManagement/IDatabaseCustomMigration.cs
@@ -7,6 +7,15 @@ namespace Timeline.Services.DatabaseManagement
     public interface IDatabaseCustomMigration
     {
         string GetName();
+
+        /// <summary>
+        /// Execute the migration on database.
+        /// </summary>
+        /// <param name="database">The database.</param>
+        /// <param name="cancellationToken">Cancellation token.</param>
+        /// <remarks>
+        /// Do not create transaction since the migrator will take care of transaction.
+        /// </remarks>
         Task ExecuteAsync(DatabaseContext database, CancellationToken cancellationToken = default);
     }
 }
-- 
cgit v1.2.3