debugging, and moved NonClusteredIndex property to CommonColumnOptions base class in prep for #81

Author: MV10

README.md

@@ -164,7 +164,7 @@ If you eliminate the Id column completely, the log table is stored as an unindex
 
 ### Unclustered Id Column
 
-You can also retain the Id column as an `IDENTITY` primary key, but without a clustered index. The log is still stored as an unindexed heap, but writes with non-clustered indexes are slightly faster. The non-clustered indexes will reference the Id primary key. However, read performance will be slightly degraded since it requires two reads (the covering non-clustered index, then dereferencing the heap row from the Id). To create this type of table ahead of time, change the constraint in the previous section to `NONCLUSTERED` and leave out the `WITH` clause.
+You can also retain the Id column as an `IDENTITY` primary key, but using a non-clustered index. The log is still stored as an unindexed heap, but writes with non-clustered indexes are slightly faster. Non-clustered indexes on other columns will reference the Id primary key. However, read performance will be slightly degraded since it requires two reads (the covering non-clustered index, then dereferencing the heap row from the Id). To create this type of table ahead of time, change the constraint in the previous section to `NONCLUSTERED` and leave out the `WITH` clause.
 
 ### Bigint Data Type
 
@@ -291,7 +291,7 @@ As the name suggests, `columnOptionSection` is an entire configuration section i
         { "ColumnName": "Release", "DataType": "varchar", "DataLength": 32 }
     ],
     "disableTriggers": true,
-    "id": { "columnName": "Id", "bigint": true, "clusteredIndex": true },
+    "id": { "columnName": "Id", "bigint": true, "nonClusteredIndex": true },
     "level": { "columnName": "Level", "storeAsEnum": false },
     "properties": { 
         "columnName": "Properties",

src/Serilog.Sinks.MSSqlServer/Configuration/Microsoft.Extensions.Configuration/LoggerConfigurationMSSqlServerExtensions.cs

@@ -221,7 +221,7 @@ private static ColumnOptions ConfigureColumnOptions(ColumnOptions columnOptions,
             {
                 SetIfProvided<string>((val) => { opts.Id.ColumnName = val; }, section["columnName"]);
                 SetIfProvided<bool>((val) => { opts.Id.BigInt = val; }, section["bigInt"]);
-                SetIfProvided<bool>((val) => { opts.Id.ClusteredIndex = val; }, section["clusteredIndex"]);
+                SetIfProvided<bool>((val) => { opts.Id.NonClusteredIndex = val; }, section["nonClusteredIndex"]);
             }
 
             section = config.GetSection("level");
@@ -264,11 +264,11 @@ private static ColumnOptions ConfigureColumnOptions(ColumnOptions columnOptions,
                 SetIfProvided<bool>((val) => { opts.LogEvent.ExcludeAdditionalProperties = val; }, section["excludeAdditionalProperties"]);
             }
 
-            SetIfProvided<string>((val) => { opts.Id.ColumnName = val; }, config.GetSection("message")["columnName"]);
+            SetIfProvided<string>((val) => { opts.Message.ColumnName = val; }, config.GetSection("message")["columnName"]);
 
-            SetIfProvided<string>((val) => { opts.Id.ColumnName = val; }, config.GetSection("exception")["columnName"]);
+            SetIfProvided<string>((val) => { opts.Exception.ColumnName = val; }, config.GetSection("exception")["columnName"]);
 
-            SetIfProvided<string>((val) => { opts.Id.ColumnName = val; }, config.GetSection("messageTemplate")["columnName"]);
+            SetIfProvided<string>((val) => { opts.MessageTemplate.ColumnName = val; }, config.GetSection("messageTemplate")["columnName"]);
 
             return opts;
 

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/ColumnOptions.cs

@@ -19,9 +19,9 @@ public ColumnOptions()
         {
             Id = new IdColumnOptions
             {
-                // Defaults for backwards compatibility only; not recommended, see docs
+                // Defaults for backwards compatibility, see docs
                 BigInt = false,
-                ClusteredIndex = true
+                NonClusteredIndex = false
             };
 
             Level = new LevelColumnOptions();
@@ -128,12 +128,6 @@ public class IdColumnOptions : CommonColumnOptions
             /// If true, stores as bigint (max value 2^64-1) instead of the default int.
             /// </summary>
             public bool BigInt { get; set; }
-
-            /// <summary>
-            /// If false, the log table will be stored as a heap structure. This will improve
-            /// write performance at the cost of query performance. See documentation for details.
-            /// </summary>
-            public bool ClusteredIndex { get; set; }
         }
 
         /// <summary>
@@ -241,6 +235,14 @@ public class CommonColumnOptions
             /// The name of the column in the database.
             /// </summary>
             public string ColumnName { get; set; }
+
+            /// <summary>
+            /// Currently only implemented for the optional Id IDENTITY PK column. Defaults to false.
+            /// If true, the log table will be stored as a heap structure. This can improve
+            /// write performance at the cost of query performance. See documentation for details.
+            /// </summary>
+            public bool NonClusteredIndex { get; set; }
+
         }
 
         /// <summary>

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/MSSqlServerSinkTraits.cs

@@ -265,15 +265,12 @@ private DataTable CreateDataTable()
                         {
                             DataType = ColumnOptions.Id.BigInt ? typeof(long) : typeof(int),
                             ColumnName = ColumnOptions.Id.ColumnName ?? StandardColumn.Id.ToString(),
-                            AutoIncrement = true
+                            AutoIncrement = true,
+                            AllowDBNull = false
                         };
+                        id.ExtendedProperties.Add("NonClusteredIndex", ColumnOptions.Id.NonClusteredIndex);
                         eventsTable.Columns.Add(id);
-                        id.ExtendedProperties.Add("clusteredIndex", false);
-                        if(ColumnOptions.Id.ClusteredIndex)
-                        {
-                            id.ExtendedProperties["clusteredIndex"] = true;
-                            eventsTable.PrimaryKey = new DataColumn[] { id };
-                        }
+                        eventsTable.PrimaryKey = new DataColumn[] { id };
                         break;
 
                     case StandardColumn.Level:

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/SqlTableCreator.cs

@@ -63,8 +63,8 @@ private static string GetSqlFromDataTable(string tableName, DataTable table, str
             // primary keys
             if (hasPrimaryKey)
             {
-                var clusteredIndex = (bool)table.PrimaryKey[0].ExtendedProperties["clusteredIndex"];
-                sql.AppendFormat(" CONSTRAINT [PK_{0}] PRIMARY KEY {1}CLUSTERED (", tableName, clusteredIndex ? string.Empty : "NON" );
+                var NonClusteredIndex = (bool)table.PrimaryKey[0].ExtendedProperties["NonClusteredIndex"];
+                sql.AppendFormat(" CONSTRAINT [PK_{0}] PRIMARY KEY {1}CLUSTERED (", tableName, NonClusteredIndex ? "NON" : string.Empty);
 
                 int numOfKeys = table.PrimaryKey.Length;
                 i = 1;