Merge pull request #640 from serilog-mssql/dev

ckadluba · web-flow · commit a5c158c3508f · 2025-10-18T00:10:55.000+02:00
# 9.0.0 * Updated SqlClient to 6.1.1 and removed Azure.Identity workaround for issue #624 * Updated all dependencies except .NET 9 NuGets * Implemented #636: Added support for non-clustered index sort direction (thanks to @gumbarros)
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,8 @@
+# 9.0.0
+* Updated SqlClient to 6.1.1 and removed Azure.Identity workaround for issue #624
+* Updated all dependencies except .NET 9 NuGets
+* Implemented #636: Added support for non-clustered index sort direction (thanks to @gumbarros)
+
 # 8.2.2
 * Fixed issue #624: Enforce new version of transient dependency to fix vulnerability and avoid nuget.org version de-listing until SqlClient 6.1 is released.
 
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -6,7 +6,7 @@ Whenever the `dev` branch is updated (after merging a pull request), the `Releas
 
 ## Creating a latest Release
 
-### Normal Update (no major version change) {#normal-update}
+### Normal Update (no major version change)
 
 1. On the `dev` branch, update CHANGES.md and `VersionPrefix` in Serilog.Sinks.MSSqlServer.csproj.
 
@@ -18,6 +18,6 @@ Whenever the `dev` branch is updated (after merging a pull request), the `Releas
 
 1. On the `dev` branch, update CHANGES.md and increase the major version in `VersionPrefix` in Serilog.Sinks.MSSqlServer.csproj. Also set `EnablePackageValidation` to false because on an intial release of a new major version you don't have a baseline version yet on nuget.org to compare with.
 
-1. Create a PR to merge the `dev` branch into `main`. The `Release` action will be triggered. This works the same as described above under [Normal Update]({#normal-update).
+1. Create a PR to merge the `dev` branch into `main`. The `Release` action will be triggered. This works the same as described above under [Normal Update](#normal-update-no-major-version-change).
 
 1. After the release is done make some changes in Serilog.Sinks.MSSqlServer.csproj on the `dev` branch. Set `EnablePackageValidation` back to true and `PackageValidationBaselineVersion` to the version of the new major release you just created (e.g. 7.0.0). Then also increase the patch version number in `VersionPrefix` (e.g. 7.0.1).
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -3,23 +3,22 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="BenchmarkDotNet" Version="0.14.0" />
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageVersion Include="BenchmarkDotNet" Version="0.15.2" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
     <PackageVersion Include="System.Configuration.ConfigurationManager" Version="8.0.1" />
-    <PackageVersion Include="Microsoft.Data.SqlClient" Version="5.2.3" />
+    <PackageVersion Include="Microsoft.Data.SqlClient" Version="6.1.1" />
     <PackageVersion Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="8.0.1" />
     <PackageVersion Include="Microsoft.Extensions.Hosting" Version="8.0.1" />
     <PackageVersion Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
-    <PackageVersion Include="Microsoft.Identity.Client" Version="4.73.1" />
     <PackageVersion Include="coverlet.collector" Version="3.2.0" />
-    <PackageVersion Include="FluentAssertions" Version="6.12.1" />
-    <PackageVersion Include="Dapper.StrongName" Version="2.1.35" />
-    <PackageVersion Include="Moq" Version="4.18.2" />
-    <PackageVersion Include="xunit" Version="2.9.2" />
+    <PackageVersion Include="FluentAssertions" Version="8.6.0" />
+    <PackageVersion Include="Dapper.StrongName" Version="2.1.66" />
+    <PackageVersion Include="Moq" Version="4.20.72" />
+    <PackageVersion Include="xunit" Version="2.9.3" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
-    <PackageVersion Include="Serilog" Version="4.1.0" />
+    <PackageVersion Include="Serilog" Version="4.3.0" />
     <PackageVersion Include="Serilog.Extensions.Hosting" Version="8.0.0" />
     <PackageVersion Include="Serilog.Settings.Configuration" Version="8.0.4" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/README.md b/README.md
@@ -110,6 +110,7 @@ columnOpts.Store.Add(StandardColumn.LogEvent);
 columnOpts.LogEvent.DataLength = 2048;
 columnOpts.PrimaryKey = columnOpts.TimeStamp;
 columnOpts.TimeStamp.NonClusteredIndex = true;
+columnOpts.TimeStamp.NonClusteredIndexDirection = SqlIndexDirection.Desc;
 
 var log = new LoggerConfiguration()
     .WriteTo.MSSqlServer(
@@ -349,6 +350,7 @@ Each Standard Column in the `ColumnOptions.Store` list and any custom columns yo
 * `AllowNull`
 * `DataLength`
 * `NonClusteredIndex`
+* `NonClusteredIndexDirection`
 
 ### ColumnName
 
@@ -412,9 +414,20 @@ Supported SQL column data types that use this property:
 
 Any individual column can be defined as a non-clustered index, including the table primary key. Use this with caution, indexing carries a relatively high write-throughput penalty. One way to mitigate this is to keep non-clustered indexes offline and use batch reindexing on a scheduled basis.
 
+### NonClusteredIndexDirection
+
+Specifies the sort direction (`ASC` or `DESC`) for a non-clustered index on the SQL column.
+The default value is `ASC`.
+
+It is especially useful for the timestamp column,
+where choosing the correct sort direction can optimize query performance for workloads that typically scan
+recent data first.
+
+This only has effect if `NonClusteredIndex` is `true`.
+
 ## Standard Columns
 
-By default (and consistent with the SQL DDL to create a table shown earlier) these columns are included in a new `ColumnOptions.Store` list:
+By default (and consistent with the SQL DDL to create a table shown earlier), these columns are included in a new `ColumnOptions.Store` list:
 
  - `StandardColumn.Id`
  - `StandardColumn.Message`
diff --git a/sample/WorkerServiceDemo/appsettings.json b/sample/WorkerServiceDemo/appsettings.json
@@ -25,7 +25,10 @@
             "removeStandardColumns": [ "MessageTemplate", "Properties" ],
             "timeStamp": {
               "columnName": "Timestamp",
-              "convertToUtc": false
+              "allowNulls": false,
+              "convertToUtc": false,
+              "nonClusteredIndex": true,
+              "nonClusteredIndexDirection": "Desc"
             },
             "customColumns": [
               {
@@ -43,6 +46,12 @@
                 "propertyName": "NonstructuredProperty.WithNameContainingDots.Name",
                 "resolveHierarchicalPropertyName": false,
                 "dataType": "12"
+              },
+              {
+                "columnName": "AdditionalColumn4",
+                "dataType": "0",
+                "nonClusteredIndex": true,
+                "nonClusteredIndexDirection": "Desc"
               }
             ]
           },
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/Microsoft.Extensions.Configuration/MicrosoftExtensionsColumnOptionsProvider.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/Microsoft.Extensions.Configuration/MicrosoftExtensionsColumnOptionsProvider.cs
@@ -34,6 +34,8 @@ private static void SetCommonColumnOptions(IConfigurationSection section, SqlCol
             SetProperty.IfNotNull<bool>(section["allowNull"], (val) => target.AllowNull = val);
             SetProperty.IfNotNull<int>(section["dataLength"], (val) => target.DataLength = val);
             SetProperty.IfNotNull<bool>(section["nonClusteredIndex"], (val) => target.NonClusteredIndex = val);
+            SetProperty.IfEnumNotNull<SqlIndexDirection>(section["nonClusteredIndexDirection"],
+                (val) => target.NonClusteredIndexDirection = val);
         }
 
         private static void AddRemoveStandardColumns(IConfigurationSection config, ColumnOptions columnOptions)
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/SetProperty.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/SetProperty.cs
@@ -29,7 +29,25 @@ public static void IfNotNull<T>(string value, PropertySetter<T> setter)
                 var setting = (T)Convert.ChangeType(value, typeof(T), CultureInfo.InvariantCulture);
                 setter(setting);
             }
-            // don't change the property if the conversion fails 
+            // don't change the property if the conversion fails
+            catch (InvalidCastException) { }
+            catch (OverflowException) { }
+        }
+
+        /// <summary>
+        /// This will only set a value (execute the PropertySetter delegate) if the value is non-null.
+        /// It also converts the provided value to the requested enum type. This allows configuration to only
+        /// apply property changes when external configuration has actually provided a value.
+        /// </summary>
+        public static void IfEnumNotNull<T>(string value, PropertySetter<T> setter) where T : System.Enum
+        {
+            if (value == null || setter == null) return;
+            try
+            {
+                var setting = (T)Enum.Parse(typeof(T), value, ignoreCase: true);
+                setter(setting);
+            }
+            // don't change the property if the conversion fails
             catch (InvalidCastException) { }
             catch (OverflowException) { }
         }
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/ColumnConfig.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/ColumnConfig.cs
@@ -83,6 +83,13 @@ public string NonClusteredIndex
             set { this[nameof(NonClusteredIndex)] = value; }
         }
 
+        [ConfigurationProperty("NonClusteredIndexDirection")]
+        public string NonClusteredIndexDirection
+        {
+            get { return (string)this[nameof(NonClusteredIndexDirection)]; }
+            set { this[nameof(NonClusteredIndexDirection)] = value; }
+        }
+
         internal SqlColumn AsSqlColumn()
         {
             var sqlColumn = new SqlColumn();
@@ -106,6 +113,9 @@ internal SqlColumn AsSqlColumn()
 
             SetProperty.IfProvided<bool>(this, nameof(NonClusteredIndex), (val) => sqlColumn.NonClusteredIndex = val);
 
+            SetProperty.IfEnumProvided<SqlIndexDirection>(this, nameof(NonClusteredIndexDirection),
+                (val) => sqlColumn.NonClusteredIndexDirection = val);
+
             return sqlColumn;
         }
     }
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/SetPropertyValueOrigin.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/SetPropertyValueOrigin.cs
@@ -22,6 +22,22 @@ public static void IfProvided<T>(ConfigurationElement element, string propertyNa
             IfNotNull((string)property.Value, setter);
         }
 
+        /// <summary>
+        /// Test the underlying enum property collection's value-origin flag for a non-default string value. Empty strings allowed.
+        /// </summary>
+        public static void IfEnumProvided<T>(ConfigurationElement element, string propertyName, PropertySetter<T> setter)
+            where T : System.Enum
+        {
+            if (element == null)
+            {
+                return;
+            }
+
+            var property = element.ElementInformation.Properties[propertyName];
+            if (property.ValueOrigin == PropertyValueOrigin.Default) return;
+            IfEnumNotNull((string)property.Value, setter);
+        }
+
         /// <summary>
         /// Test the underlying property collection's value-origin flag for a non-default, non-null, non-empty string value.
         /// </summary>
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/SystemConfigurationColumnOptionsProvider.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/SystemConfigurationColumnOptionsProvider.cs
@@ -26,6 +26,7 @@ private static void SetCommonColumnOptions(ColumnConfig source, SqlColumn target
             SetProperty.IfProvided<bool>(source, nameof(target.AllowNull), value => target.AllowNull = value);
             SetProperty.IfProvided<int>(source, nameof(target.DataLength), value => target.DataLength = value);
             SetProperty.IfProvided<bool>(source, nameof(target.NonClusteredIndex), value => target.NonClusteredIndex = value);
+            SetProperty.IfEnumProvided<SqlIndexDirection>(source, nameof(target.NonClusteredIndexDirection), value => target.NonClusteredIndexDirection = value);
         }
 
         private static void ReadPropertiesColumnOptions(MSSqlServerConfigurationSection config, ColumnOptions columnOptions)
diff --git a/src/Serilog.Sinks.MSSqlServer/Serilog.Sinks.MSSqlServer.csproj b/src/Serilog.Sinks.MSSqlServer/Serilog.Sinks.MSSqlServer.csproj
@@ -2,8 +2,8 @@
 
   <PropertyGroup>
     <Description>A Serilog sink that writes events to Microsoft SQL Server and Azure SQL</Description>
-    <VersionPrefix>8.2.2</VersionPrefix>
-    <EnablePackageValidation>true</EnablePackageValidation>
+    <VersionPrefix>9.0.0</VersionPrefix>
+    <EnablePackageValidation>false</EnablePackageValidation>
     <PackageValidationBaselineVersion>8.0.0</PackageValidationBaselineVersion>
     <Authors>Michiel van Oudheusden;Christian Kadluba;Serilog Contributors</Authors>
     <TargetFrameworks>netstandard2.0;net462;net472;net8.0</TargetFrameworks>
@@ -36,7 +36,6 @@
     <PackageReference Include="Microsoft.Data.SqlClient" />
     <PackageReference Include="Microsoft.Extensions.Configuration" />
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" />
-    <PackageReference Include="Microsoft.Identity.Client" />
     <PackageReference Include="Serilog" />
   </ItemGroup>
 
diff --git a/src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/Platform/SqlCreateTableWriter.cs b/src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/Platform/SqlCreateTableWriter.cs
@@ -54,7 +54,7 @@ public string GetSql()
 
                     // collect non-PK indexes for separate output after the table DDL
                     if (common != null && common.NonClusteredIndex && common != _columnOptions.PrimaryKey)
-                        ix.AppendLine(Invariant($"CREATE NONCLUSTERED INDEX [IX{indexCount++}_{_tableName}] ON [{_schemaName}].[{_tableName}] ([{common.ColumnName}]);"));
+                        ix.AppendLine(Invariant($"CREATE NONCLUSTERED INDEX [IX{indexCount++}_{_tableName}] ON [{_schemaName}].[{_tableName}] ([{common.ColumnName}] {common.NonClusteredIndexDirection});"));
                 }
             }
 
diff --git a/src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/SqlColumn.cs b/src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/SqlColumn.cs
@@ -100,6 +100,12 @@ public SqlDbType DataType
         /// </summary>
         public bool NonClusteredIndex { get; set; }
 
+        /// <summary>
+        /// Specifies the sort direction for a non-clustered index on the SQL column.
+        /// The default value is <see cref="SqlIndexDirection.Asc"/>. This property is only used when auto-creating a log table.
+        /// </summary>
+        public SqlIndexDirection NonClusteredIndexDirection { get; set; }
+
         /// <summary>
         /// The name of the Serilog property to use as the value when filling the DataTable.
         /// If not specified, the ColumnName and PropertyName are the same.
diff --git a/src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/SqlIndexDirection.cs b/src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/SqlIndexDirection.cs
@@ -0,0 +1,18 @@
+namespace Serilog.Sinks.MSSqlServer
+{
+    /// <summary>
+    /// Defines the sort order for an SQL index.
+    /// </summary>
+    public enum SqlIndexDirection
+    {
+        /// <summary>
+        /// Represents the ascending direction for SQL indexing.
+        /// </summary>
+        Asc,
+
+        /// <summary>
+        /// Represents the descending direction for SQL indexing.
+        /// </summary>
+        Desc
+    }
+}
diff --git a/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Implementations/Microsoft.Extensions.Configuration/MicrosoftExtensionsColumnOptionsProviderTests.cs b/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Implementations/Microsoft.Extensions.Configuration/MicrosoftExtensionsColumnOptionsProviderTests.cs
diff --git a/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Implementations/System.Configuration/SystemConfigurationColumnOptionsProviderTests.cs b/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Implementations/System.Configuration/SystemConfigurationColumnOptionsProviderTests.cs
diff --git a/test/Serilog.Sinks.MSSqlServer.Tests/Sinks/MSSqlServer/Platform/SqlCreateTableWriterTests.cs b/test/Serilog.Sinks.MSSqlServer.Tests/Sinks/MSSqlServer/Platform/SqlCreateTableWriterTests.cs

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,8 @@ private static void SetCommonColumnOptions(IConfigurationSection section, SqlCol`
`34`	`34`	`SetProperty.IfNotNull<bool>(section["allowNull"], (val) => target.AllowNull = val);`
`35`	`35`	`SetProperty.IfNotNull<int>(section["dataLength"], (val) => target.DataLength = val);`
`36`	`36`	`SetProperty.IfNotNull<bool>(section["nonClusteredIndex"], (val) => target.NonClusteredIndex = val);`
	`37`	`+ SetProperty.IfEnumNotNull<SqlIndexDirection>(section["nonClusteredIndexDirection"],`
	`38`	`+ (val) => target.NonClusteredIndexDirection = val);`
`37`	`39`	`}`
`38`	`40`
`39`	`41`	`private static void AddRemoveStandardColumns(IConfigurationSection config, ColumnOptions columnOptions)`
Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,13 @@ public string NonClusteredIndex`
`83`	`83`	`set { this[nameof(NonClusteredIndex)] = value; }`
`84`	`84`	`}`
`85`	`85`
	`86`	`+ [ConfigurationProperty("NonClusteredIndexDirection")]`
	`87`	`+ public string NonClusteredIndexDirection`
	`88`	`+ {`
	`89`	`+ get { return (string)this[nameof(NonClusteredIndexDirection)]; }`
	`90`	`+ set { this[nameof(NonClusteredIndexDirection)] = value; }`
	`91`	`+ }`
	`92`	`+`
`86`	`93`	`internal SqlColumn AsSqlColumn()`
`87`	`94`	`{`
`88`	`95`	`var sqlColumn = new SqlColumn();`
`@@ -106,6 +113,9 @@ internal SqlColumn AsSqlColumn()`
`106`	`113`
`107`	`114`	`SetProperty.IfProvided<bool>(this, nameof(NonClusteredIndex), (val) => sqlColumn.NonClusteredIndex = val);`
`108`	`115`
	`116`	`+ SetProperty.IfEnumProvided<SqlIndexDirection>(this, nameof(NonClusteredIndexDirection),`
	`117`	`+ (val) => sqlColumn.NonClusteredIndexDirection = val);`
	`118`	`+`
`109`	`119`	`return sqlColumn;`
`110`	`120`	`}`
`111`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ private static void SetCommonColumnOptions(ColumnConfig source, SqlColumn target`
`26`	`26`	`SetProperty.IfProvided<bool>(source, nameof(target.AllowNull), value => target.AllowNull = value);`
`27`	`27`	`SetProperty.IfProvided<int>(source, nameof(target.DataLength), value => target.DataLength = value);`
`28`	`28`	`SetProperty.IfProvided<bool>(source, nameof(target.NonClusteredIndex), value => target.NonClusteredIndex = value);`
	`29`	`+ SetProperty.IfEnumProvided<SqlIndexDirection>(source, nameof(target.NonClusteredIndexDirection), value => target.NonClusteredIndexDirection = value);`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`private static void ReadPropertiesColumnOptions(MSSqlServerConfigurationSection config, ColumnOptions columnOptions)`