Merge pull request #217 from smoothdeveloper/expose-table-type

Expose an additional Table type when ResultType.DataTable is used

Author: dmitry-a-morozov

docs/content/output.fsx

@@ -113,6 +113,14 @@ let table = (new QueryPersonInfoSingletoneDataTable()).AsyncExecute(PersonId = 2
 for row in table.Rows do
     printfn "Person info:Id - %i,FirstName - %O,LastName - %O" row.PersonID row.FirstName row.LastName 
 
+// you can refer to the table type
+let table2 : QueryPersonInfoSingletoneDataTable.Table = (new QueryPersonInfoSingletoneDataTable()).Execute(PersonId = 2)
+
+// you can refer to the row type
+for row : QueryPersonInfoSingletoneDataTable.Table.Row in table2.Rows do
+    printfn "Person info:Id - %i,FirstName - %O,LastName - %O" row.PersonID row.FirstName row.LastName 
+
+
 (**
 
  * Same as previous but using `SqlProgrammabilityProvider<...>`

src/SqlClient.Tests/DataTablesTests.fs

@@ -17,7 +17,7 @@ type ProductCostHistory = AdventureWorks.Production.Tables.ProductCostHistory
 
 type GetRowCount = SqlCommandProvider<"SELECT COUNT(*) FROM HumanResources.Shift", ConnectionStrings.AdventureWorksNamed, SingleRow = true>
 type GetShiftTableData = SqlCommandProvider<"SELECT * FROM HumanResources.Shift", ConnectionStrings.AdventureWorksNamed, ResultType.DataReader>
-
+type GetArbitraryDataAsDataTable = SqlCommandProvider<"select 1 a, 2 b, 3 c", ConnectionStrings.AdventureWorksNamed, ResultType.DataTable>
 type DataTablesTests() = 
 
     do
@@ -270,3 +270,14 @@ type DataTablesTests() =
         let t = new AdventureWorks.dbo.Tables.TableHavingColumnNamesWithSpaces()
         t.AddRow()
         Assert.Equal(1, t.Update())
+
+    [<Fact>]
+    member __.``Can use Table type when ResultType = ResultType.DataTable`` () =
+        let t : GetArbitraryDataAsDataTable.Table = (new GetArbitraryDataAsDataTable()).Execute()
+        for (r: GetArbitraryDataAsDataTable.Table.Row) in t.Rows do
+            ()
+
+        Assert.NotNull(t)
+        Assert.Equal(1, t.Rows.[0].a)
+        Assert.Equal(2, t.Rows.[0].b)
+        Assert.Equal(3, t.Rows.[0].c)

src/SqlClient/DesignTime.fs

@@ -175,6 +175,11 @@ type DesignTime private() =
 
         rowType
 
+    static member internal GetDataTableType dataRowType =
+        let tableType = ProvidedTypeBuilder.MakeGenericType(typedefof<_ DataTable>, [ dataRowType ])
+        let tableProvidedType = ProvidedTypeDefinition("Table", Some tableType)
+        tableProvidedType
+
     static member internal GetOutputTypes (outputColumns: Column list, resultType, rank: ResultRank, hasOutputParameters) =    
         if resultType = ResultType.DataReader 
         then 
@@ -185,9 +190,13 @@ type DesignTime private() =
         elif resultType = ResultType.DataTable 
         then
             let dataRowType = DesignTime.GetDataRowType outputColumns
+            let dataTableType = DesignTime.GetDataTableType dataRowType 
+            
+            // add .Row to .Table
+            dataTableType.AddMember dataRowType
 
             {
-                ProvidedType = ProvidedTypeBuilder.MakeGenericType(typedefof<_ DataTable>, [ dataRowType ])
+                ProvidedType = dataTableType
                 ErasedToType = typeof<DataTable<DataRow>>
                 ProvidedRowType = Some dataRowType
                 ErasedToRowType = typeof<Void>
@@ -226,7 +235,6 @@ type DesignTime private() =
 
                     let tupleTypeName = tupleType.PartialAssemblyQualifiedName
                     None, tupleType, <@@ Microsoft.FSharp.Reflection.FSharpValue.PreComputeTupleConstructor (Type.GetType (tupleTypeName))  @@>
-                    //None, tupleType, <@@ fun values -> Type.GetType(tupleTypeName, throwOnError = true).GetConstructors().[0].Invoke(values) @@>
 
             let nullsToOptions = QuotationsFactory.MapArrayNullableItems(outputColumns, "MapArrayObjItemToOption") 
             let combineWithNullsToOptions = typeof<QuotationsFactory>.GetMethod("GetMapperWithNullsToOptions") 
@@ -241,7 +249,7 @@ type DesignTime private() =
                     Some( typedefof<_ option>), typedefof<_ option>.MakeGenericType([| erasedToRowType |])
                 else //ResultRank.ScalarValue
                     None, erasedToRowType
-                          
+
             {
                 ProvidedType = 
                     if providedRowType.IsSome && genericOutputType.IsSome
@@ -499,4 +507,4 @@ type DesignTime private() =
             if factoryMethodName.IsSome
             then 
                 yield upcast ProvidedMethod(factoryMethodName.Value, parameters2, returnType = cmdProvidedType, IsStaticMethod = true, InvokeCode = body2)
-        ]
+        ]

src/SqlClient/SqlClientProvider.fs

@@ -540,7 +540,12 @@ type public SqlProgrammabilityProvider(config : TypeProviderConfig) as this =
                         addRedirectToISqlCommandMethod typeof<string> "ToTraceString" 
 
                     commands.AddMember cmdProvidedType
-                    output.ProvidedRowType |> Option.iter cmdProvidedType.AddMember
+                    if resultType = ResultType.DataTable then
+                        // if we don't do this, we get a compile error
+                        // Error The type provider 'FSharp.Data.SqlProgrammabilityProvider' reported an error: type 'Table' was not added as a member to a declaring type <type instanciation name> 
+                        output.ProvidedType |> cmdProvidedType.AddMember
+                    else
+                        output.ProvidedRowType |> Option.iter cmdProvidedType.AddMember
 
                     let designTimeConfig = 
                         let expectedDataReaderColumns = 

src/SqlClient/SqlCommandProvider.fs

@@ -141,8 +141,13 @@ type public SqlCommandProvider(config : TypeProviderConfig) as this =
         do  
             cmdProvidedType.AddMember(ProvidedProperty("ConnectionStringOrName", typeof<string>, [], IsStatic = true, GetterCode = fun _ -> <@@ connectionStringOrName @@>))
 
-        do  //Record
-            output.ProvidedRowType |> Option.iter cmdProvidedType.AddMember
+        do
+            if resultType = ResultType.Records then
+                // Add .Record
+                output.ProvidedRowType |> Option.iter cmdProvidedType.AddMember
+            elif resultType = ResultType.DataTable then
+                // add .Table
+                output.ProvidedType |>  cmdProvidedType.AddMember
 
         do  //ctors
             let designTimeConfig = 
@@ -218,4 +223,4 @@ type public SqlCommandProvider(config : TypeProviderConfig) as this =
                         reader.ReadToEnd())
                 if not (task.Wait(TimeSpan.FromSeconds(1.))) then failwithf "Couldn't read command from file %s" path
                 task.Result, Some watcher 
-        | _ -> commandTextOrPath, None
+        | _ -> commandTextOrPath, None