Simplify, add to Interface, add docs for boolean

HicServices · Oct 16, 2024 · a82b535 · a82b535
1 parent 69a749a
commit a82b535
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 16 deletions.
diff --git a/FAnsiSql/Discovery/QuerySyntax/IQuerySyntaxHelper.cs b/FAnsiSql/Discovery/QuerySyntax/IQuerySyntaxHelper.cs
@@ -115,6 +115,15 @@ public interface IQuerySyntaxHelper
     /// </summary>
     int MaximumColumnLength { get; }
 
+    /// <summary>
+    /// Boolean false encoded appropriately for the DBMS (either 0 or FALSE depending)
+    /// </summary>
+    public string False { get; }
+
+    /// <summary>
+    /// Boolean true encoded appropriately for the DBMS (either 1 or TRUE depending)
+    /// </summary>
+    public string True { get; }
 
     bool SplitLineIntoSelectSQLAndAlias(string lineToSplit, out string selectSQL, out string? alias);
 

diff --git a/FAnsiSql/Discovery/QuerySyntaxHelper.cs b/FAnsiSql/Discovery/QuerySyntaxHelper.cs
@@ -39,8 +39,11 @@ public abstract partial class QuerySyntaxHelper(
     /// <inheritdoc/>
     public virtual char[] IllegalNameChars { get; } = ['.', '(', ')'];
 
-    public abstract string False { get; }
-    public abstract string True { get; }
+    ///<inheritdoc/>
+    public virtual string False => "0"; // 0 works as false for everything except Postgres
+
+    ///<inheritdoc/>
+    public virtual string True => "1"; // 1 works as true for everything except Postgres
 
     /// <summary>
     /// Regex for identifying parameters in blocks of SQL (starts with @ or : (Oracle)

diff --git a/FAnsiSql/Implementations/MicrosoftSQL/MicrosoftQuerySyntaxHelper.cs b/FAnsiSql/Implementations/MicrosoftSQL/MicrosoftQuerySyntaxHelper.cs
@@ -28,10 +28,6 @@ public sealed class MicrosoftQuerySyntaxHelper : QuerySyntaxHelper
 
     public override string CloseQualifier => "]";
 
-    public override string False => "0";
-
-    public override string True => "1";
-
     public override TopXResponse HowDoWeAchieveTopX(int x) => new($"TOP {x}", QueryComponent.SELECT);
 
     public override string GetParameterDeclaration(string proposedNewParameterName, string sqlType) => $"DECLARE {proposedNewParameterName} AS {sqlType};";

diff --git a/FAnsiSql/Implementations/MySql/MySqlQuerySyntaxHelper.cs b/FAnsiSql/Implementations/MySql/MySqlQuerySyntaxHelper.cs
@@ -21,10 +21,6 @@ public sealed class MySqlQuerySyntaxHelper : QuerySyntaxHelper
 
     public override string CloseQualifier => "`";
 
-    public override string False => "0";
-
-    public override string True => "1";
-
     private MySqlQuerySyntaxHelper() : base(MySqlTypeTranslater.Instance, MySqlAggregateHelper.Instance,MySqlUpdateHelper.Instance,DatabaseType.MySql)//no specific type translation required
     {
     }

diff --git a/FAnsiSql/Implementations/Oracle/OracleQuerySyntaxHelper.cs b/FAnsiSql/Implementations/Oracle/OracleQuerySyntaxHelper.cs
@@ -26,10 +26,6 @@ private OracleQuerySyntaxHelper() : base(OracleTypeTranslater.Instance, OracleAg
 
     public override char ParameterSymbol => ':';
 
-    public override string False => "0";
-
-    public override string True => "1";
-
     [return: NotNullIfNotNull(nameof(s))]
     public override string? GetRuntimeName(string? s)
     {

diff --git a/FAnsiSql/Implementations/PostgreSql/PostgreSqlSyntaxHelper.cs b/FAnsiSql/Implementations/PostgreSql/PostgreSqlSyntaxHelper.cs
@@ -24,9 +24,11 @@ private PostgreSqlSyntaxHelper() : base(PostgreSqlTypeTranslater.Instance, Postg
 
     public override string CloseQualifier => "\"";
 
-    public override string False => "FALSE";
+    ///<inheritdoc/>
+    public override string False => "FALSE"; // 'FALSE' is the string representation of the boolean false in PostgreSql, unlike 0 for the others
 
-    public override string True => "TRUE";
+    ///<inheritdoc/>
+    public override string True => "TRUE"; // 'TRUE' is the string representation of the boolean true in PostgreSql, unlike 1 for the others
 
     public override bool SupportsEmbeddedParameters() => false;