Add support for Stats (#97)

Author: shaunrd0

README.md

@@ -2,19 +2,22 @@ TileDB-CSharp
 
 # Build
 ## Download or build tiledb core library
-```
+
+```bash
 cd cpp
 mkdir build && cd build
 cmake ..
 cmake --build . --target install
 ```
 ## Build TileDB.CSharp
-```
+
+```bash
 cd sources/TileDB.CSharp
 dotnet build /p:Platform=x64 -c Release
 ```
 ## Test TileDB.CSharp
-```
+
+```bash
 cd tests/TileDB.CSharp.Test
 dotnet test -c Release
 ```

examples/TileDB.CSharp.Example/TileDB.CSharp.Example.csproj

@@ -6,7 +6,7 @@
     <RollForward>Major</RollForward>
     <RootNamespace>TileDB.CSharp.Examples</RootNamespace>
     <TargetFramework>net5.0</TargetFramework>
-    <Version>5.2.1</Version>
+    <Version>5.2.2</Version>
   </PropertyGroup>
 
   <ItemGroup>

examples/bindings/quickstart_sparse_string/quickstart_sparse_string.csproj

@@ -5,7 +5,7 @@
     <OutputType>Exe</OutputType>
     <RollForward>Major</RollForward>
     <TargetFramework>net5.0</TargetFramework>
-    <Version>5.2.1</Version>
+    <Version>5.2.2</Version>
   </PropertyGroup>
 
   <ItemGroup>

sources/TileDB.CSharp/Stats.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Runtime.InteropServices;
+using TileDB.Interop;
+
+namespace TileDB.CSharp
+{
+    public static unsafe class Stats
+    {
+        private static readonly Context _ctx;
+        static Stats()
+        {
+            _ctx = Context.GetDefault();
+        }
+
+        /// <summary>
+        /// Enable statistic gathering
+        /// </summary>
+        public static void Enable() => _ctx.handle_error(Methods.tiledb_stats_enable());
+
+        /// <summary>
+        /// Disable statistic gathering
+        /// </summary>
+        public static void Disable() => _ctx.handle_error(Methods.tiledb_stats_disable());
+
+        /// <summary>
+        /// Reset all statistics previously gathered
+        /// </summary>
+        public static void Reset() => _ctx.handle_error(Methods.tiledb_stats_reset());
+
+        /// <summary>
+        /// Dump TileDB statistics to stdout
+        /// </summary>
+        public static void Dump() => Console.WriteLine(Get());
+
+        /// <summary>
+        /// Dump TileDB statistics to a file
+        /// </summary>
+        /// <param name="filePath">Path to file to dump statistics</param>
+        public static void Dump(string filePath) => System.IO.File.WriteAllText(filePath, Get());
+
+        /// <summary>
+        /// Get TileDB statistics as string
+        /// </summary>
+        /// <returns>string object containing dumped TileDB statistics</returns>
+        public static string Get()
+        {
+            var ms = (sbyte**)Marshal.StringToHGlobalAnsi("");
+            _ctx.handle_error(Methods.tiledb_stats_dump_str(ms));
+            string stats = new(*ms);
+            _ctx.handle_error(Methods.tiledb_stats_free_str(ms));
+            Marshal.FreeHGlobal((IntPtr)ms);
+            return stats;
+        }
+    }
+}

sources/TileDB.CSharp/TileDB.CSharp.csproj

@@ -6,7 +6,7 @@
     <RollForward>Major</RollForward>
     <RootNamespace>TileDB.CSharp</RootNamespace>
     <TargetFramework>net5.0</TargetFramework>
-    <Version>5.2.1</Version>
+    <Version>5.2.2</Version>
   </PropertyGroup>
 
   <ItemGroup>

sources/TileDB.CSharp/TileDB.CSharp.nuspec

@@ -2,7 +2,7 @@
 <package >
   <metadata>
     <id>TileDB.CSharp</id>
-    <version>5.2.1</version>
+    <version>5.2.2</version>
     <title>$title$</title>
     <authors>TileDB Inc</authors>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>

sources/TileDB.Interop/TileDB.Interop.csproj

@@ -4,6 +4,6 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <RollForward>Major</RollForward>
     <TargetFramework>net5.0</TargetFramework>
-    <Version>5.2.1</Version>
+    <Version>5.2.2</Version>
   </PropertyGroup>
 </Project>

tests/TileDB.CSharp.Test/StatsTest.cs

@@ -0,0 +1,46 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace TileDB.CSharp.Test
+{
+    [TestClass]
+    public class StatsTest
+    {
+        private static readonly string ArrayUri = TestUtil.GetTempPath("test-stats");
+
+        [TestMethod]
+        public void TestStats()
+        {
+            Stats.Enable();
+
+            var ctx = Context.GetDefault();
+            var row = Dimension.Create(ctx, "rows", 1, 4, 2);
+            var col = Dimension.Create(ctx, "cols", 1, 4, 2);
+            var domain = new Domain(ctx);
+            domain.AddDimensions(row, col);
+            var schema = new ArraySchema(ctx, ArrayType.TILEDB_DENSE);
+            schema.SetDomain(domain);
+            schema.AddAttribute(new Attribute(ctx, "a1", DataType.TILEDB_INT32));
+            schema.Check();
+            TestUtil.CreateArray(ctx, ArrayUri, schema);
+
+            var array = new Array(ctx, ArrayUri);
+            array.Open(QueryType.TILEDB_WRITE);
+            var query = new Query(ctx, array);
+            query.SetLayout(LayoutType.TILEDB_ROW_MAJOR);
+            query.SetSubarray(new[] { 1, 4, 1, 4 });
+            query.SetDataBuffer("a1", new[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 });
+            query.Submit();
+            Assert.AreEqual(query.Status(), QueryStatus.TILEDB_COMPLETED);
+
+            string? stats = null;
+            stats = Stats.Get();
+            Assert.IsNotNull(stats);
+            var filePath = TestUtil.GetTempPath("test-stats-dump");
+            Stats.Dump(filePath);
+            Assert.IsTrue(System.IO.File.Exists(filePath));
+
+            Stats.Dump();
+        }
+
+    }
+}