Merge pull request #400 from smoothdeveloper/optional-parameters-cmeeren

Optional parameters cmeeren

Author: smoothdeveloper

docs/content/configuration and Input.fsx

@@ -328,7 +328,7 @@ type AdventureWorks2012 = SqlProgrammabilityProvider<connStr>
     
 By default all input parameters of `AsyncExecute/Execute` generated by `SqlCommandProvider<...>` are mandatory. 
 But there are rare cases when you prefer to handle NULL input values inside T-SQL script. 
-`AllParametersOptional` set to true makes all parameters (guess what) optional.
+`AllParametersOptional` set to true makes all parameters `Option`-wrapped.
 *)
 
 type IncrBy = SqlCommandProvider<"SELECT @x + ISNULL(CAST(@y AS INT), 1) ", 

docs/content/faq.fsx

@@ -33,7 +33,7 @@ echoOnly.Execute( x = (* must pass int value here *) 1)
 There is no way to pass NULL as value for parameter `@x` although the query knows how to handle it.
 
 To resolve the issue specify `AllParametersOptional = true` as static parameter to type provider. 
-It makes all parameters of type `option<_>` with default value `None`. 
+It makes all parameters of type `option<_>`.
 
 <div class="well well-small" style="margin:0px 70px 0px 20px;">
 
@@ -53,10 +53,7 @@ let echoOr42 =
 // Pass parameter value. Specifying Some constructor is mandatrory.
 echoOr42.Execute( Some 1) 
 
-// Pass NULL by omitting parameter
-echoOr42.Execute() 
-
-//Pass NULL explicitly
+// Pass NULL
 echoOr42.Execute( x = None) 
 
 (**

docs/content/index.fsx

@@ -125,7 +125,7 @@ SqlCommandProvider and SqlProgrammabilityProvider features at glance
     * "ResolutionFolder" parameter - a folder to be used to resolve relative file paths at compile time. Applied to command text *.sql files only.
 * Input:
     * Unbound sql variables/input parameters mapped to mandatory typed arguments for `AsyncExecute/Execute`
-    * Set `AllParametersOptional` to true to make all parameters optional (nullable) (`SqlCommandProvider<...>` only)
+    * Set `AllParametersOptional` to true to make all parameters option-wrapped (`SqlCommandProvider<...>` only)
     * Stored Procedures and User-Defined Functions can be easily discovered with `SqlProgrammabilityProvider<...>`
     * `SqlProgrammabilityProvider<...>` infers default values for input parameters
 * Output:

src/SqlClient.DesignTime/DesignTime.fs

@@ -588,7 +588,10 @@ type DesignTime private() =
                         if p.Optional 
                         then 
                             assert(p.Direction = ParameterDirection.Input)
-                            ProvidedParameter(parameterName, parameterType = typedefof<_ option>.MakeGenericType(p.TypeInfo.ClrType) , optionalValue = null)
+                            if p.DefaultValue.IsNone then
+                              ProvidedParameter(parameterName, parameterType = typedefof<_ option>.MakeGenericType(p.TypeInfo.ClrType))
+                            else
+                              ProvidedParameter(parameterName, parameterType = typedefof<_ option>.MakeGenericType(p.TypeInfo.ClrType), optionalValue = null)
                         else
                             if p.Direction.HasFlag(ParameterDirection.Output)
                             then

src/SqlClient.DesignTime/SqlCommandProvider.fs

@@ -70,7 +70,7 @@ type SqlCommandProvider(config : TypeProviderConfig) as this =
 <param name='ResultType'>A value that defines structure of result: Records, Tuples, DataTable, or SqlDataReader.</param>
 <param name='SingleRow'>If set the query is expected to return a single row of the result set. See MSDN documentation for details on CommandBehavior.SingleRow.</param>
 <param name='ConfigFile'>The name of the configuration file that’s used for connection strings at DESIGN-TIME. The default value is app.config or web.config.</param>
-<param name='AllParametersOptional'>If set all parameters become optional. NULL input values must be handled inside T-SQL.</param>
+<param name='AllParametersOptional'>If set all parameters become Option-wrapped. NULL input values must be handled inside T-SQL.</param>
 <param name='ResolutionFolder'>A folder to be used to resolve relative file paths to *.sql script files at compile time. The default value is the folder that contains the project or script.</param>
 <param name='DataDirectory'>The name of the data directory that replaces |DataDirectory| in connection strings. The default value is the project or script directory.</param>
 <param name='TempTableDefinitions'>Temp tables create command.</param>

tests/SqlClient.Tests/CreateCommand.fs

@@ -45,7 +45,7 @@ let udttAndTuplesOutput() =
 let optionalParams() = 
     use cmd = DB.CreateCommand<"SELECT CAST(@x AS INT) + ISNULL(CAST(@y AS INT), 1)", SingleRow = true, AllParametersOptional = true>()
     Assert.Equal( Some( Some 14), cmd.Execute(Some 3, Some 11))    
-    Assert.Equal( Some( Some 12), cmd.Execute(x = Some 11))    
+    Assert.Equal( Some( Some 12), cmd.Execute(x = Some 11, y = None))    
 
 [<Literal>]
 let evenNumbers = "select value, svalue = cast(value as char(1)) from (values (2), (4), (6), (8)) as T(value)"

tests/SqlClient.Tests/OptionalParamsTests.fs

@@ -19,9 +19,9 @@ let BothOptinalParamsSupplied() =
     Assert.Equal( Some( Some 14), cmd.Execute(Some 3, Some 11))    
 
 [<Fact>]
-let SkipYParam() = 
+let YParamNull() = 
     use cmd = new QueryWithNullableParam()
-    Assert.Equal( Some( Some 12), cmd.Execute(x = Some 11))    
+    Assert.Equal( Some( Some 12), cmd.Execute(Some 11, None))    
 
 [<Fact>]
 let NullableStringInputParameter() = 
@@ -32,11 +32,6 @@ let NullableStringInputParameter() =
         actual = cmd.Execute( None)
     )
 
-    Assert.Equal(
-        expected = Some "",
-        actual = cmd.Execute()
-    )
-
     Assert.Equal(
         expected = Some "boo",
         actual = cmd.Execute( Some "boo")

tests/SqlClient.Tests/ProgrammabilityTests.fs

@@ -159,7 +159,7 @@ let FunctionWithParamOfValueTypeWithNullDefault() =
     use cmd2 = new AdventureWorks.dbo.ufnGetStock2()
     Assert.Equal(cmd1.Execute(1), cmd2.Execute(Some 1))
 
-    Assert.Equal(Some 83173, cmd2.Execute())
+    Assert.Equal(Some 83173, cmd2.Execute(None))
 
 [<Fact>]
 let SpWithParamOfRefTypeWithNullDefault() = 
@@ -169,7 +169,7 @@ let SpWithParamOfRefTypeWithNullDefault() =
     Assert.Equal( Some(Some (box 42)), echo.ExecuteSingle 42)
 
     use echoText = new AdventureWorks.dbo.EchoText()
-    Assert.Equal<string[]>([| "<NULL>" |], echoText.Execute() |> Seq.toArray)
+    Assert.Equal<string[]>([| "<NULL>" |], echoText.Execute(null) |> Seq.toArray)
 
     let param = "Hello, world!"
     Assert.Equal<string[]>([| param |], echoText.Execute( param) |> Seq.toArray)