Refactor DbScripts to include useDb PageResult global to change default conn

Author: mythz

src/ServiceStack.OrmLite/DbScripts.cs

@@ -11,6 +11,9 @@ public class TemplateDbFilters : DbScripts {}
 
     public class DbScripts : ScriptMethods
     {
+        private const string DbInfo = "__dbinfo"; // Keywords.DbInfo
+        private const string DbConnection = "__dbconnection"; // useDbConnection global
+        
         private IDbConnectionFactory dbFactory;
         public IDbConnectionFactory DbFactory
         {
@@ -19,22 +22,53 @@ public IDbConnectionFactory DbFactory
         }
 
         public IDbConnection OpenDbConnection(ScriptScopeContext scope, Dictionary<string, object> options)
+        {
+            var dbConn = OpenDbConnectionFromOptions(options);
+            if (dbConn != null)
+                return dbConn;
+
+            if (scope.PageResult != null)
+            {
+                if (scope.PageResult.Args.TryGetValue(DbInfo, out var oDbInfo) && oDbInfo is ConnectionInfo dbInfo)
+                    return DbFactory.OpenDbConnection(dbInfo);
+
+                if (scope.PageResult.Args.TryGetValue(DbConnection, out var oDbConn) && oDbConn is Dictionary<string, object> globalDbConn)
+                    return OpenDbConnectionFromOptions(globalDbConn);
+            }
+
+            return DbFactory.OpenDbConnection();
+        }
+
+        public IgnoreResult useDb(ScriptScopeContext scope, Dictionary<string, object> dbConnOptions)
+        {
+            if (dbConnOptions != null)
+            {
+                if (!dbConnOptions.ContainsKey("connectionString") && !dbConnOptions.ContainsKey("namedConnection"))
+                    throw new NotSupportedException(nameof(useDb) + " requires either 'connectionString' or 'namedConnection' property");
+
+                scope.PageResult.Args[DbConnection] = dbConnOptions;
+            }
+            return IgnoreResult.Value;
+        }
+
+        private IDbConnection OpenDbConnectionFromOptions(Dictionary<string, object> options)
         {
             if (options != null)
             {
                 if (options.TryGetValue("connectionString", out var connectionString))
+                {
                     return options.TryGetValue("providerName", out var providerName)
-                       ? DbFactory.OpenDbConnectionString((string)connectionString, (string)providerName) 
-                       : DbFactory.OpenDbConnectionString((string)connectionString);
-                
+                        ? DbFactory.OpenDbConnectionString((string) connectionString, (string) providerName)
+                        : DbFactory.OpenDbConnectionString((string) connectionString);
+                }
+
                 if (options.TryGetValue("namedConnection", out var namedConnection))
-                    return DbFactory.OpenDbConnection((string)namedConnection);
+                {
+                    return DbFactory.OpenDbConnection((string) namedConnection);
+                }
             }
-            
-            if (scope.PageResult != null && scope.PageResult.Args.TryGetValue("__dbinfo", out var oDbInfo) && oDbInfo is ConnectionInfo dbInfo) // Keywords.DbInfo
-                return DbFactory.OpenDbConnection(dbInfo);
 
-            return DbFactory.OpenDbConnection();
+            return null;
         }
 
         T exec<T>(Func<IDbConnection, T> fn, ScriptScopeContext scope, object options)

src/ServiceStack.OrmLite/DbScriptsAsync.cs

@@ -12,6 +12,9 @@ public class TemplateDbFiltersAsync : DbScriptsAsync {}
 
     public class DbScriptsAsync : ScriptMethods
     {
+        private const string DbInfo = "__dbinfo"; // Keywords.DbInfo
+        private const string DbConnection = "__dbconnection"; // useDbConnection global
+
         private IDbConnectionFactory dbFactory;
         public IDbConnectionFactory DbFactory
         {
@@ -20,22 +23,53 @@ public IDbConnectionFactory DbFactory
         }
 
         public async Task<IDbConnection> OpenDbConnectionAsync(ScriptScopeContext scope, Dictionary<string, object> options)
+        {
+            var dbConn = await OpenDbConnectionFromOptionsAsync(options);
+            if (dbConn != null)
+                return dbConn;
+
+            if (scope.PageResult != null)
+            {
+                if (scope.PageResult.Args.TryGetValue(DbInfo, out var oDbInfo) && oDbInfo is ConnectionInfo dbInfo)
+                    return await DbFactory.OpenDbConnectionAsync(dbInfo);
+
+                if (scope.PageResult.Args.TryGetValue(DbConnection, out var oDbConn) && oDbConn is Dictionary<string, object> globalDbConn)
+                    return await OpenDbConnectionFromOptionsAsync(globalDbConn);
+            }
+
+            return await DbFactory.OpenAsync();
+        }
+
+        public IgnoreResult useDb(ScriptScopeContext scope, Dictionary<string, object> dbConnOptions)
+        {
+            if (dbConnOptions != null)
+            {
+                if (!dbConnOptions.ContainsKey("connectionString") && !dbConnOptions.ContainsKey("namedConnection"))
+                    throw new NotSupportedException(nameof(useDb) + " requires either 'connectionString' or 'namedConnection' property");
+
+                scope.PageResult.Args[DbConnection] = dbConnOptions;
+            }
+            return IgnoreResult.Value;
+        }
+
+        private async Task<IDbConnection> OpenDbConnectionFromOptionsAsync(Dictionary<string, object> options)
         {
             if (options != null)
             {
                 if (options.TryGetValue("connectionString", out var connectionString))
+                {
                     return options.TryGetValue("providerName", out var providerName)
-                        ? await DbFactory.OpenDbConnectionStringAsync((string)connectionString, (string)providerName) 
-                        : await DbFactory.OpenDbConnectionStringAsync((string)connectionString);
-                
+                        ? await DbFactory.OpenDbConnectionStringAsync((string) connectionString, (string) providerName)
+                        : await DbFactory.OpenDbConnectionStringAsync((string) connectionString);
+                }
+
                 if (options.TryGetValue("namedConnection", out var namedConnection))
-                    return await DbFactory.OpenDbConnectionAsync((string)namedConnection);
+                {
+                    return await DbFactory.OpenDbConnectionStringAsync((string) namedConnection);
+                }
             }
-            
-            if (scope.PageResult != null && scope.PageResult.Args.TryGetValue("__dbinfo", out var oDbInfo) && oDbInfo is ConnectionInfo dbInfo) // Keywords.DbInfo
-                return await DbFactory.OpenDbConnectionAsync(dbInfo);
 
-            return await DbFactory.OpenAsync();
+            return null;
         }
 
         async Task<object> exec<T>(Func<IDbConnection, Task<T>> fn, ScriptScopeContext scope, object options)