fix: benchmark params info

SockworkOrange · SockworkOrange · commit f49b582923c8 · 2025-12-17T13:43:11.000+01:00
diff --git a/benchmark/BenchmarkRunner/Benchmarks/BaseReadBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/BaseReadBenchmark.cs
@@ -13,8 +13,6 @@ int QueriesToSubmit
 
 public abstract class BaseReadBenchmark
 {
-    protected const string BenchmarkLegend = "Legend: L=Query Limit, C=Concurrency, Q=Queries To Submit";
-
     [IterationSetup]
     public static void IterationSetup() => Helpers.InvokeGarbageCollection();
     public abstract Task Sqlc_GetCustomerOrders();
diff --git a/benchmark/BenchmarkRunner/Benchmarks/BaseWriteBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/BaseWriteBenchmark.cs
@@ -10,7 +10,6 @@ int BatchSize
 
 public abstract class BaseWriteBenchmark
 {
-    protected const string BenchmarkLegend = "Legend: R=Total Records, B=Batch Size";
     public const int TotalRecordsForSetup = 300000; // 3 million records
     public const int OrderIdsCountForSetup = 1000;
     public const int ProductIdsCountForSetup = 1000;
diff --git a/benchmark/BenchmarkRunner/Benchmarks/MysqlReadBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/MysqlReadBenchmark.cs
@@ -11,7 +11,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
 [CategoriesColumn]
 public class MysqlReadBenchmark : BaseReadBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/MysqlWriteBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/MysqlWriteBenchmark.cs
@@ -13,7 +13,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
 [CategoriesColumn]
 public class MysqlWriteBenchmark : BaseWriteBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/PostgresqlReadBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/PostgresqlReadBenchmark.cs
@@ -11,7 +11,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
 [CategoriesColumn]
 public class PostgresqlReadBenchmark : BaseReadBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/PostgresqlWriteBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/PostgresqlWriteBenchmark.cs
@@ -12,7 +12,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
 [CategoriesColumn]
 public class PostgresqlWriteBenchmark : BaseWriteBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/SqliteReadBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/SqliteReadBenchmark.cs
@@ -12,7 +12,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
 [CategoriesColumn]
 public class SqliteReadBenchmark : BaseReadBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/SqliteWriteBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/SqliteWriteBenchmark.cs
@@ -13,7 +13,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
 [CategoriesColumn]
 public class SqliteWriteBenchmark : BaseWriteBenchmark
 {
diff --git a/docs/07_Benchmark.md b/docs/07_Benchmark.md
@@ -1,17 +1,24 @@
 # Benchmark Results
+
+## Read Benchmarks
+`L=Query Limit, C=Concurrency, Q=Total Queries To Submit`
+
 [PostgreSQL - Reads](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/postgresql/results/BenchmarkRunner.Benchmarks.PostgresqlReadBenchmark-report-github.md) 
 <br/>
 
-[PostgreSQL - Writes](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/postgresql/results/BenchmarkRunner.Benchmarks.PostgresqlWriteBenchmark-report-github.md) 
+[MySQL - Reads](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/mysql/results/BenchmarkRunner.Benchmarks.MysqlReadBenchmark-report-github.md) 
 <br/>
 
-[MySQL - Reads](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/mysql/results/BenchmarkRunner.Benchmarks.MysqlReadBenchmark-report-github.md) 
+[SQLite - Reads](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/sqlite/results/BenchmarkRunner.Benchmarks.SqliteReadBenchmark-report-github.md) 
 <br/>
 
-[MySQL - Writes](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/mysql/results/BenchmarkRunner.Benchmarks.MysqlWriteBenchmark-report-github.md) 
+## Write Benchmarks
+`R=Total Records to Load, B=Batch Size`
+
+[PostgreSQL - Writes](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/postgresql/results/BenchmarkRunner.Benchmarks.PostgresqlWriteBenchmark-report-github.md) 
 <br/>
 
-[SQLite - Reads](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/sqlite/results/BenchmarkRunner.Benchmarks.SqliteReadBenchmark-report-github.md) 
+[MySQL - Writes](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/mysql/results/BenchmarkRunner.Benchmarks.MysqlWriteBenchmark-report-github.md) 
 <br/>
 
 [SQLite - Writes](https://github.com/DaredevilOSS/sqlc-gen-csharp/blob/add-performance-benchmark-with-efcore/benchmark/BenchmarkDotNet.Artifacts/sqlite/results/BenchmarkRunner.Benchmarks.SqliteWriteBenchmark-report-github.md)

Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,6 @@ int QueriesToSubmit`
`13`	`13`
`14`	`14`	`public abstract class BaseReadBenchmark`
`15`	`15`	`{`
`16`		`- protected const string BenchmarkLegend = "Legend: L=Query Limit, C=Concurrency, Q=Queries To Submit";`
`17`		`-`
`18`	`16`	`[IterationSetup]`
`19`	`17`	`public static void IterationSetup() => Helpers.InvokeGarbageCollection();`
`20`	`18`	`public abstract Task Sqlc_GetCustomerOrders();`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@ int BatchSize`
`10`	`10`
`11`	`11`	`public abstract class BaseWriteBenchmark`
`12`	`12`	`{`
`13`		`- protected const string BenchmarkLegend = "Legend: R=Total Records, B=Batch Size";`
`14`	`13`	`public const int TotalRecordsForSetup = 300000; // 3 million records`
`15`	`14`	`public const int OrderIdsCountForSetup = 1000;`
`16`	`15`	`public const int ProductIdsCountForSetup = 1000;`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ namespace BenchmarkRunner.Benchmarks;`
`11`	`11`	`[SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]`
`12`	`12`	`[MemoryDiagnoser]`
`13`	`13`	`[MarkdownExporterAttribute.GitHub]`
`14`		`-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]`
	`14`	`+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]`
`15`	`15`	`[CategoriesColumn]`
`16`	`16`	`public class MysqlReadBenchmark : BaseReadBenchmark`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ namespace BenchmarkRunner.Benchmarks;`
`13`	`13`	`[SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]`
`14`	`14`	`[MemoryDiagnoser]`
`15`	`15`	`[MarkdownExporterAttribute.GitHub]`
`16`		`-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]`
	`16`	`+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]`
`17`	`17`	`[CategoriesColumn]`
`18`	`18`	`public class MysqlWriteBenchmark : BaseWriteBenchmark`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace BenchmarkRunner.Benchmarks;`
`12`	`12`	`[SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]`
`13`	`13`	`[MemoryDiagnoser]`
`14`	`14`	`[MarkdownExporterAttribute.GitHub]`
`15`		`-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]`
	`15`	`+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]`
`16`	`16`	`[CategoriesColumn]`
`17`	`17`	`public class PostgresqlWriteBenchmark : BaseWriteBenchmark`
`18`	`18`	`{`