Make DB backends a little more flexible with overriding

ClassiCube · Apr 2, 2024 · 1bf0f7a · 1bf0f7a
1 parent b875e2f
commit 1bf0f7a
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 57 deletions.
diff --git a/MCGalaxy/Database/Backends/Interfaces.cs b/MCGalaxy/Database/Backends/Interfaces.cs
@@ -20,36 +20,33 @@ permissions and limitations under the Licenses.
 namespace MCGalaxy.SQL
 {
     /// <summary> Abstracts a connection to a SQL database </summary>
-    public abstract class ISqlConnection : IDisposable
+    public interface ISqlConnection : IDisposable
     {
-        public abstract ISqlTransaction BeginTransaction();
-        public abstract ISqlCommand CreateCommand(string sql);
+        ISqlTransaction BeginTransaction();
+        ISqlCommand CreateCommand(string sql);
 
-        public abstract void Open();
-        public abstract void ChangeDatabase(string name);
-        public abstract void Close();
-        public abstract void Dispose();
+        void Open();
+        void ChangeDatabase(string name);
+        void Close();
     }
 
     /// <summary> Abstracts a SQL command/statement </summary>
-    public abstract class ISqlCommand : IDisposable
+    public interface ISqlCommand : IDisposable
     {
-        public abstract void ClearParameters();
-        public abstract void AddParameter(string name, object value);
+        void ClearParameters();
+        void AddParameter(string name, object value);
 
-        public abstract void Prepare();
+        void Prepare();
         /// <summary> Executes this command and returns the number of rows affected </summary>
-        public abstract int ExecuteNonQuery();
+        int ExecuteNonQuery();
         /// <summary> Executes this command and returns an ISqlReader for reading the results </summary>
-        public abstract ISqlReader ExecuteReader();
-        public abstract void Dispose();
+        ISqlReader ExecuteReader();
     }
 
-    public abstract class ISqlTransaction : IDisposable
+    public interface ISqlTransaction : IDisposable
     {
-        public abstract void Commit();
-        public abstract void Rollback();
-        public abstract void Dispose();
+        void Commit();
+        void Rollback();
     }
 
     /// <summary> Abstracts iterating over the results from executing a SQL command </summary>

diff --git a/MCGalaxy/Database/Backends/MySQL.cs b/MCGalaxy/Database/Backends/MySQL.cs
@@ -24,7 +24,7 @@ permissions and limitations under the Licenses.
 
 namespace MCGalaxy.SQL 
 {
-    public sealed class MySQLBackend : IDatabaseBackend 
+    public class MySQLBackend : IDatabaseBackend 
     {
         public static IDatabaseBackend Instance = new MySQLBackend();
         public MySQLBackend() {
@@ -33,10 +33,10 @@ public MySQLBackend() {
             CaselessLikeSuffix  = "";
         }
 
-        public override bool EnforcesTextLength { get { return true; } }
+        public override bool EnforcesTextLength    { get { return true; } }
         public override bool EnforcesIntegerLimits { get { return true; } }
         public override bool MultipleSchema { get { return true; } }
-        public override string EngineName { get { return "MySQL"; } }
+        public override string EngineName   { get { return "MySQL"; } }
 
         public override ISqlConnection CreateConnection() {
             const string format = "Data Source={0};Port={1};User ID={2};Password={3};Pooling={4};Treat Tiny As Boolean=false;";
@@ -164,39 +164,39 @@ sealed class MySQLConnection : ISqlConnection
         public readonly MySqlConnection conn;        
         public MySQLConnection(MySqlConnection conn) { this.conn = conn; }
 
-        public override ISqlTransaction BeginTransaction() {
+        public ISqlTransaction BeginTransaction() {
             MySqlTransaction trn = conn.BeginTransaction();
             return new MySQLTransaction(trn);
         }
 
-        public override ISqlCommand CreateCommand(string sql) {
+        public ISqlCommand CreateCommand(string sql) {
             MySqlCommand cmd = new MySqlCommand(sql, conn);
             return new MySQLCommand(cmd);
         }
 
-        public override void Open() { conn.Open(); }
-        public override void ChangeDatabase(string name) { conn.ChangeDatabase(name); }
-        public override void Close() { conn.Close(); }
-        public override void Dispose() { conn.Dispose(); }
+        public void Open() { conn.Open(); }
+        public void ChangeDatabase(string name) { conn.ChangeDatabase(name); }
+        public void Close() { conn.Close(); }
+        public void Dispose() { conn.Dispose(); }
     }
 
     sealed class MySQLCommand : ISqlCommand
     {        
         readonly MySqlCommand cmd;
         public MySQLCommand(MySqlCommand cmd) { this.cmd = cmd; }
 
-        public override void ClearParameters() { 
+        public void ClearParameters() { 
             cmd.Parameters.Clear(); 
         }
-        public override void AddParameter(string name, object value) {
+        public void AddParameter(string name, object value) {
             cmd.Parameters.AddWithValue(name, value);
         }
 
-        public override void Dispose() { cmd.Dispose(); }
-        public override void Prepare() { cmd.Prepare(); }
-        public override int ExecuteNonQuery() { return cmd.ExecuteNonQuery(); }
+        public void Dispose() { cmd.Dispose(); }
+        public void Prepare() { cmd.Prepare(); }
+        public int ExecuteNonQuery() { return cmd.ExecuteNonQuery(); }
 
-        public override ISqlReader ExecuteReader() { 
+        public ISqlReader ExecuteReader() { 
             MySqlDataReader rdr = cmd.ExecuteReader();
             return new MySQLReader(rdr);
         }
@@ -207,9 +207,9 @@ sealed class MySQLTransaction : ISqlTransaction
         readonly MySqlTransaction trn;
         public MySQLTransaction(MySqlTransaction trn) { this.trn = trn; }        
 
-        public override void Commit()   { trn.Commit(); }
-        public override void Rollback() { trn.Rollback(); }
-        public override void Dispose()  { trn.Dispose(); }
+        public void Commit()   { trn.Commit(); }
+        public void Rollback() { trn.Rollback(); }
+        public void Dispose()  { trn.Dispose(); }
     }
 
     sealed class MySQLReader : ISqlReader

diff --git a/MCGalaxy/Database/Backends/SQLite.cs b/MCGalaxy/Database/Backends/SQLite.cs
@@ -23,18 +23,18 @@ permissions and limitations under the Licenses.
 
 namespace MCGalaxy.SQL 
 {
-    public sealed class SQLiteBackend : IDatabaseBackend 
+    public class SQLiteBackend : IDatabaseBackend 
     {
         public static IDatabaseBackend Instance = new SQLiteBackend();
         public SQLiteBackend() {
             CaselessWhereSuffix = " COLLATE NOCASE";
             CaselessLikeSuffix  = " COLLATE NOCASE";
         }
 
-        public override bool EnforcesTextLength { get { return false; } }
+        public override bool EnforcesTextLength    { get { return false; } }
         public override bool EnforcesIntegerLimits { get { return false; } }
         public override bool MultipleSchema { get { return false; } }
-        public override string EngineName { get { return "SQLite"; } }
+        public override string EngineName   { get { return "SQLite"; } }
 
         public override ISqlConnection CreateConnection() {
             return new MCGSQLiteConnection();

diff --git a/MCGalaxy/Database/Backends/SQLiteBackend.cs b/MCGalaxy/Database/Backends/SQLiteBackend.cs
@@ -105,13 +105,13 @@ public abstract class SQLiteConnection : ISqlConnection
         protected abstract bool ConnectionPooling { get; }
         protected abstract string DBPath { get; }
 
-        public override ISqlTransaction BeginTransaction() {
+        public ISqlTransaction BeginTransaction() {
             return new SQLiteTransaction(this);
         }
 
-        public override void ChangeDatabase(string databaseName) { }
+        public void ChangeDatabase(string databaseName) { }
 
-        public override ISqlCommand CreateCommand(string sql) { return new SQLiteCommand(sql, this); }
+        public ISqlCommand CreateCommand(string sql) { return new SQLiteCommand(sql, this); }
 
         public long LastInsertRowId {
             get {
@@ -170,7 +170,7 @@ internal SQLiteStatement Prepare(string strSql, ref string strRemain) {
             }
         }
 
-        public override void Open() {
+        public void Open() {
             if (handle != IntPtr.Zero) throw new InvalidOperationException();
 
             try {
@@ -226,8 +226,8 @@ internal bool Reset(bool canThrow) {
             return false;
         }
 
-        public override void Dispose() { Close(false); }
-        public override void Close() { Close(true); }
+        public void Dispose() { Close(false); }
+        public void Close() { Close(true); }
 
         void Close(bool canThrow) {
             if (handle == IntPtr.Zero) return;
@@ -291,7 +291,7 @@ void DisposeStatement() {
             stmt = null;
         }
 
-        public override void Dispose() {
+        public void Dispose() {
             conn = null;
             param_names.Clear();
             param_values.Clear();
@@ -316,27 +316,27 @@ internal SQLiteStatement NextStatement() {
             return stmt;
         }
 
-        public override void Prepare() { }
+        public void Prepare() { }
 
-        public override void ClearParameters() {
+        public void ClearParameters() {
             param_names.Clear();
             param_values.Clear();
         }
 
-        public override void AddParameter(string name, object value) {
+        public void AddParameter(string name, object value) {
             param_names.Add(name);
             param_values.Add(value);
         }
 
-        public override ISqlReader ExecuteReader() {
+        public ISqlReader ExecuteReader() {
             SQLiteConnection.Check(conn);
 
             SQLiteDataReader reader = new SQLiteDataReader(this);
             reader.NextResult();
             return reader;
         }
 
-        public override int ExecuteNonQuery() {
+        public int ExecuteNonQuery() {
             using (ISqlReader reader = ExecuteReader()) {
                 while (reader.Read()) { }
                 return reader.RowsAffected;
@@ -835,7 +835,7 @@ internal byte[] GetBytes(int index) {
         }
     }
 
-    public sealed class SQLiteTransaction : ISqlTransaction 
+    public class SQLiteTransaction : ISqlTransaction 
     {
         SQLiteConnection conn;
 
@@ -855,13 +855,13 @@ internal SQLiteTransaction(SQLiteConnection connection) {
         }
 
         bool disposed;
-        public override void Dispose() {
+        public void Dispose() {
             if (disposed) return;
             if (IsValid(false)) IssueRollback(false);
             disposed = true;
         }
 
-        public override void Commit() {
+        public void Commit() {
             SQLiteConnection.Check(conn);
             IsValid(true);
 
@@ -873,7 +873,7 @@ public override void Commit() {
             conn = null;
         }
 
-        public override void Rollback() {
+        public void Rollback() {
             SQLiteConnection.Check(conn);
             IsValid(true);
             IssueRollback(true);

diff --git a/MCGalaxy/Database/IDatabaseBackend.cs b/MCGalaxy/Database/IDatabaseBackend.cs
@@ -152,7 +152,7 @@ protected string InsertSql(string cmd, string table, string columns, int numArgs
         #region Raw SQL functions
 
         /// <summary> Executes an SQL command and returns the number of affected rows. </summary>
-        public int Execute(string sql, object[] parameters, bool createDB) {
+        public virtual int Execute(string sql, object[] parameters, bool createDB) {
             int rows = 0;
 
             using (ISqlConnection conn = CreateConnection()) {
@@ -170,7 +170,7 @@ public int Execute(string sql, object[] parameters, bool createDB) {
         }
 
         /// <summary> Excecutes an SQL query, invoking a callback on the returned rows one by one. </summary>        
-        public int Iterate(string sql, object[] parameters, ReaderCallback callback) {
+        public virtual int Iterate(string sql, object[] parameters, ReaderCallback callback) {
             int rows = 0;
 
             using (ISqlConnection conn = CreateConnection()) {