Add better API's for executing SP's with OUT params

Author: mythz

src/ServiceStack.OrmLite.MySql.Tests/CustomSqlTests.cs

@@ -0,0 +1,72 @@
+using System.Data;
+using NUnit.Framework;
+using ServiceStack.DataAnnotations;
+
+namespace ServiceStack.OrmLite.MySql.Tests
+{
+    public class LetterFrequency
+    {
+        [AutoIncrement]
+        public int Id { get; set; }
+
+        public string Letter { get; set; }
+    }
+ 
+    [TestFixture]
+    public class CustomSqlTests : OrmLiteTestBase
+    {
+        string spSql = @"DROP PROCEDURE IF EXISTS spSearchLetters;
+            CREATE PROCEDURE spSearchLetters (IN pLetter varchar(10), OUT pTotal int)
+            BEGIN
+                SELECT COUNT(*) FROM LetterFrequency WHERE Letter = pLetter INTO pTotal;
+                SELECT * FROM LetterFrequency WHERE Letter = pLetter;
+            END";
+
+        [Test]
+        public void Can_execute_stored_procedure_using_SqlList_with_out_params()
+        {
+            using (var db = OpenDbConnection())
+            {
+                db.DropAndCreateTable<LetterFrequency>();
+
+                var rows = "A,B,B,C,C,C,D,D,E".Split(',').Map(x => new LetterFrequency { Letter = x });
+                db.InsertAll(rows);
+
+                db.ExecuteSql(spSql);
+
+                IDbDataParameter pTotal = null;
+                var results = db.SqlList<LetterFrequency>("spSearchLetters",
+                    cmd =>
+                    {
+                        cmd.CommandType = CommandType.StoredProcedure;
+                        cmd.AddParam("pLetter", "C");
+                        pTotal = cmd.AddParam("pTotal", direction: ParameterDirection.Output);
+                    });
+
+                Assert.That(results.Count, Is.EqualTo(3));
+                Assert.That(pTotal.Value, Is.EqualTo(3));
+            }
+        }
+
+        [Test]
+        public void Can_execute_stored_procedure_using_SqlProc_with_out_params()
+        {
+            using (var db = OpenDbConnection())
+            {
+                db.DropAndCreateTable<LetterFrequency>();
+
+                var rows = "A,B,B,C,C,C,D,D,E".Split(',').Map(x => new LetterFrequency { Letter = x });
+                db.InsertAll(rows);
+
+                db.ExecuteSql(spSql);
+
+                var cmd = db.SqlProc("spSearchLetters", new { pLetter = "C" });
+                var pTotal = cmd.AddParam("pTotal", direction: ParameterDirection.Output);
+                var results = cmd.ConvertToList<LetterFrequency>();
+
+                Assert.That(results.Count, Is.EqualTo(3));
+                Assert.That(pTotal.Value, Is.EqualTo(3));
+            }
+        }
+    }
+}

src/ServiceStack.OrmLite.MySql.Tests/ServiceStack.OrmLite.MySql.Tests.csproj

@@ -76,6 +76,7 @@
       <Link>Properties\GlobalAssemblyInfo.cs</Link>
     </Compile>
     <Compile Include="BooleanTests.cs" />
+    <Compile Include="CustomSqlTests.cs" />
     <Compile Include="DateTimeColumnTest.cs" />
     <Compile Include="EnumTests.cs" />
     <Compile Include="Expressions\AdditiveExpressionsTest.cs" />

src/ServiceStack.OrmLite/OrmLiteReadConnectionExtensions.cs

@@ -419,6 +419,24 @@ public static List<T> SqlList<T>(this IDbConnection dbConn, string sql, Dictiona
             return dbConn.Exec(dbCmd => dbCmd.SqlList<T>(sql, dict));
         }
 
+        /// <summary>
+        /// Returns results from an arbitrary parameterized raw sql query with a dbCmd filter. E.g:
+        /// <para>db.SqlList&lt;Person&gt;("EXEC GetRockstarsAged @age", dbCmd => ...)</para>
+        /// </summary>
+        public static List<T> SqlList<T>(this IDbConnection dbConn, string sql, Action<IDbCommand> dbCmdFilter)
+        {
+            return dbConn.Exec(dbCmd => dbCmd.SqlList<T>(sql, dbCmdFilter));
+        }
+
+        /// <summary>
+        /// Prepare Stored Procedure with Input parameters, optionally populated with Input Params. E.g:
+        /// <para>var cmd = db.SqlProc("GetRockstarsAged", new { age = 42 })</para>
+        /// </summary>
+        public static IDbCommand SqlProc(this IDbConnection dbConn, string name, object inParams = null, bool excludeDefaults = false)
+        {
+            return dbConn.Exec(dbCmd => dbCmd.SqlProc(name, inParams, excludeDefaults));
+        }
+
         /// <summary>
         /// Returns the first column in a List using an SqlExpression. E.g:
         /// <para>db.SqlColumn&lt;string&gt;(db.From&lt;Person&gt;().Select(x => x.LastName).Where(q => q.Age < 50))</para>

src/ServiceStack.OrmLite/OrmLiteReadExtensions.cs

@@ -378,6 +378,14 @@ internal static List<T> SqlList<T>(this IDbCommand dbCmd, string sql, Dictionary
             return dbCmd.ConvertToList<T>();
         }
 
+        internal static List<T> SqlList<T>(this IDbCommand dbCmd, string sql, Action<IDbCommand> dbCmdFilter)
+        {
+            if (dbCmdFilter != null) dbCmdFilter(dbCmd);
+            dbCmd.CommandText = sql;
+
+            return dbCmd.ConvertToList<T>();
+        }
+
         internal static List<T> SqlColumn<T>(this IDbCommand dbCmd, string sql, object anonType = null)
         {
             if (anonType != null) dbCmd.SetParameters<T>(anonType, excludeDefaults: false);
@@ -910,5 +918,47 @@ public static FieldDefinition GetSelfRefFieldDefIfExists(ModelDefinition modelDe
 
             return refField;
         }
+
+        public static IDbDataParameter AddParam(this IDbCommand dbCmd,
+            string name,
+            object value = null,
+            ParameterDirection direction = ParameterDirection.Input,
+            DbType? dbType = null)
+        {
+            var p = dbCmd.CreateParam(name, value, direction, dbType);
+            dbCmd.Parameters.Add(p);
+            return p;
+        }
+
+        public static IDbDataParameter CreateParam(this IDbCommand dbCmd,
+            string name,
+            object value = null,
+            ParameterDirection direction = ParameterDirection.Input,
+            DbType? dbType=null)
+        {
+            var p = dbCmd.CreateParameter();
+            var dialectProvider = OrmLiteConfig.DialectProvider;
+            p.ParameterName = dialectProvider.GetParam(name);
+            p.Direction = direction;
+            if (value != null)
+            {
+                p.Value = value;
+                p.DbType = dialectProvider.GetColumnDbType(value.GetType());
+            }
+            if (dbType != null)
+                p.DbType = dbType.Value;
+            return p;
+        }
+
+        internal static IDbCommand SqlProc(this IDbCommand dbCmd, string name, object inParams = null, bool excludeDefaults = false)
+        {
+            dbCmd.CommandType = CommandType.StoredProcedure;
+            dbCmd.CommandText = name;
+            dbCmd.CommandTimeout = OrmLiteConfig.CommandTimeout;
+
+            dbCmd.SetParameters(inParams, excludeDefaults);
+
+            return dbCmd;
+        }
     }
 }

src/ServiceStack.OrmLite/OrmLiteResultsFilterExtensions.cs

@@ -99,7 +99,7 @@ internal static List<T> ExprConvertToList<T>(this IDbCommand dbCmd, string sql =
             }
         }
 
-        internal static T ConvertTo<T>(this IDbCommand dbCmd, string sql = null)
+        public static T ConvertTo<T>(this IDbCommand dbCmd, string sql = null)
         {
             if (sql != null)
                 dbCmd.CommandText = sql;
@@ -131,7 +131,7 @@ internal static object ConvertTo(this IDbCommand dbCmd, Type refType, string sql
             }
         }
 
-        internal static T Scalar<T>(this IDbCommand dbCmd, string sql = null)
+        public static T Scalar<T>(this IDbCommand dbCmd, string sql = null)
         {
             if (sql != null)
                 dbCmd.CommandText = sql;
@@ -147,7 +147,7 @@ internal static T Scalar<T>(this IDbCommand dbCmd, string sql = null)
             }
         }
 
-        internal static object Scalar(this IDbCommand dbCmd, string sql = null)
+        public static object Scalar(this IDbCommand dbCmd, string sql = null)
         {
             if (sql != null)
                 dbCmd.CommandText = sql;