Enhance ListDataReader<T> documentation

pwelter34 · pwelter34 · commit 994f4db63e3a · 2025-12-03T09:24:39.000-06:00
diff --git a/src/Serilog.Sinks.SqlServer/ListDataReader.cs b/src/Serilog.Sinks.SqlServer/ListDataReader.cs
@@ -9,6 +9,8 @@ namespace Serilog.Sinks.SqlServer;
 /// <remarks>
 /// This class enables bulk insert operations by wrapping an enumerable collection and exposing it through the IDataReader interface.
 /// Column mappings are defined through the <see cref="MappingContext{T}"/> which specifies how to extract values from each item.
+/// The <see cref="MappingContext{T}"/> instance should be created once and reused across multiple <see cref="ListDataReader{T}"/> instances
+/// to avoid the overhead of recreating column mappings and schema information for each operation.
 /// </remarks>
 public class ListDataReader<T> : IDataReader
 {

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ namespace Serilog.Sinks.SqlServer;`
`9`	`9`	`/// <remarks>`
`10`	`10`	`/// This class enables bulk insert operations by wrapping an enumerable collection and exposing it through the IDataReader interface.`
`11`	`11`	`/// Column mappings are defined through the <see cref="MappingContext{T}"/> which specifies how to extract values from each item.`
	`12`	`+/// The <see cref="MappingContext{T}"/> instance should be created once and reused across multiple <see cref="ListDataReader{T}"/> instances`
	`13`	`+/// to avoid the overhead of recreating column mappings and schema information for each operation.`
`12`	`14`	`/// </remarks>`
`13`	`15`	`public class ListDataReader<T> : IDataReader`
`14`	`16`	`{`