Skip to content

Use canonical commands in database benchmarks #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PrzemyslawKlys merged 1 commit into from
Aug 14, 2026
Merged

Use canonical commands in database benchmarks #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 42 additions & 42 deletions Module/Examples/Benchmark.OfficeFileRoundTrip.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,27 +217,27 @@ $settings = {
$officeIMOExcelAssemblyIdentity = & $getAssemblyIdentity -SimpleName 'OfficeIMO.Excel'
$officeIMOCsvAssemblyIdentity = & $getAssemblyIdentity -SimpleName 'OfficeIMO.CSV'
$epplusAssemblyIdentity = & $getAssemblyIdentity -SimpleName 'EPPlus'
benchmark 'office-file-roundtrip' -out $outputRootBase {
policy -Warmup $benchmarkWarmupCount -Iterations $benchmarkIterationCount -Order Rotated -MemoryCleanup BeforeIteration -OutlierMode None
profile Current -Cleanup KeepOnFailure
metadata ProcessorAffinity $appliedProcessorAffinity
metadata ProcessPriority $appliedProcessPriority
metadata BenchmarkScript $benchmarkScript
metadata BenchmarkSupport $benchmarkSupport
metadata SqlServer $sqlServerIdentity
metadata DbaClientXModule $dbaClientXModuleIdentity
metadata DbaClientXAssembly $dbaClientXAssemblyIdentity
metadata PSWriteOfficeModule $psWriteOfficeModuleIdentity
metadata PSWriteOfficeAssembly $psWriteOfficeAssemblyIdentity
metadata OfficeIMOExcelAssembly $officeIMOExcelAssemblyIdentity
metadata OfficeIMOCsvAssembly $officeIMOCsvAssemblyIdentity
metadata ParallelCsvRead $parallelCsvRead
metadata CsvReaderMaxDegreeOfParallelism $csvReaderMaxDegreeOfParallelism
metadata CsvReaderParallelBatchSize $csvReaderParallelBatchSize
metadata ImportExcelModule $importExcelModuleIdentity
metadata EPPlusAssembly $epplusAssemblyIdentity

caseSource {
New-BenchmarkSuite 'office-file-roundtrip' -OutputRoot $outputRootBase {
Set-BenchmarkPolicy -Warmup $benchmarkWarmupCount -Iterations $benchmarkIterationCount -Order Rotated -MemoryCleanup BeforeIteration -OutlierMode None
Set-BenchmarkProfile Current -Cleanup KeepOnFailure
Add-BenchmarkMetadata ProcessorAffinity $appliedProcessorAffinity
Add-BenchmarkMetadata ProcessPriority $appliedProcessPriority
Add-BenchmarkMetadata BenchmarkScript $benchmarkScript
Add-BenchmarkMetadata BenchmarkSupport $benchmarkSupport
Add-BenchmarkMetadata SqlServer $sqlServerIdentity
Add-BenchmarkMetadata DbaClientXModule $dbaClientXModuleIdentity
Add-BenchmarkMetadata DbaClientXAssembly $dbaClientXAssemblyIdentity
Add-BenchmarkMetadata PSWriteOfficeModule $psWriteOfficeModuleIdentity
Add-BenchmarkMetadata PSWriteOfficeAssembly $psWriteOfficeAssemblyIdentity
Add-BenchmarkMetadata OfficeIMOExcelAssembly $officeIMOExcelAssemblyIdentity
Add-BenchmarkMetadata OfficeIMOCsvAssembly $officeIMOCsvAssemblyIdentity
Add-BenchmarkMetadata ParallelCsvRead $parallelCsvRead
Add-BenchmarkMetadata CsvReaderMaxDegreeOfParallelism $csvReaderMaxDegreeOfParallelism
Add-BenchmarkMetadata CsvReaderParallelBatchSize $csvReaderParallelBatchSize
Add-BenchmarkMetadata ImportExcelModule $importExcelModuleIdentity
Add-BenchmarkMetadata EPPlusAssembly $epplusAssemblyIdentity

Add-BenchmarkCaseSource {
foreach ($rowCount in $rowCounts) {
foreach ($fileKind in $fileKinds) {
foreach ($columnShape in $columnShapes) {
Expand All @@ -258,7 +258,7 @@ $settings = {
}
}

setup {
Set-BenchmarkSetup {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand Down Expand Up @@ -327,7 +327,7 @@ IF OBJECT_ID(N'dbo.$($run.SourceTable)', N'U') IS NOT NULL DROP TABLE dbo.$($run
}
}

skip {
Add-BenchmarkSkipRule {
param($case)

if ($case.Engine -eq 'dbatools') {
Expand All @@ -349,8 +349,8 @@ IF OBJECT_ID(N'dbo.$($run.SourceTable)', N'U') IS NOT NULL DROP TABLE dbo.$($run
return $false
}

engine DbaClientX {
operation RoundTrip {
Add-BenchmarkEngine DbaClientX {
Add-BenchmarkOperation RoundTrip {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand Down Expand Up @@ -508,8 +508,8 @@ IF OBJECT_ID(N'dbo.$($run.SourceTable)', N'U') IS NOT NULL DROP TABLE dbo.$($run
}
}

engine NativePowerShell {
operation RoundTrip {
Add-BenchmarkEngine NativePowerShell {
Add-BenchmarkOperation RoundTrip {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand All @@ -527,8 +527,8 @@ IF OBJECT_ID(N'dbo.$($run.SourceTable)', N'U') IS NOT NULL DROP TABLE dbo.$($run
}
}

engine ImportExcel {
operation RoundTrip {
Add-BenchmarkEngine ImportExcel {
Add-BenchmarkOperation RoundTrip {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand All @@ -546,8 +546,8 @@ IF OBJECT_ID(N'dbo.$($run.SourceTable)', N'U') IS NOT NULL DROP TABLE dbo.$($run
}
}

engine dbatools {
operation RoundTrip {
Add-BenchmarkEngine dbatools {
Add-BenchmarkOperation RoundTrip {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand Down Expand Up @@ -607,7 +607,7 @@ IF OBJECT_ID(N'dbo.$($run.SourceTable)', N'U') IS NOT NULL DROP TABLE dbo.$($run
}
}

validate {
Add-BenchmarkValidation {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand Down Expand Up @@ -677,43 +677,43 @@ FULL OUTER JOIN dbo.$($run.SourceTable) AS source
}
}

metric RowsProcessed {
Add-BenchmarkMetric RowsProcessed {
param($case, $run)

$run.RowsProcessed
}

metric ExportMs {
Add-BenchmarkMetric ExportMs {
param($case, $run)

$run.ExportMs
}

metric LoadMs {
Add-BenchmarkMetric LoadMs {
param($case, $run)

$run.LoadMs
}

metric IdSum {
Add-BenchmarkMetric IdSum {
param($case, $run)

$run.IdSum
}

metric ScoreSum {
Add-BenchmarkMetric ScoreSum {
param($case, $run)

$run.ScoreSum
}

metric ExactMismatchCount {
Add-BenchmarkMetric ExactMismatchCount {
param($case, $run)

$run.ExactMismatchCount
}

metric RowsPerSecond {
Add-BenchmarkMetric RowsPerSecond {
param($case, $run)

if ($run.DurationMs -le 0) {
Expand All @@ -724,12 +724,12 @@ FULL OUTER JOIN dbo.$($run.SourceTable) AS source
}

if ($selectedEngines.Count -gt 1) {
comparison Engine -Baseline $engineComparisonBaseline -Metric MedianMs -TieTolerance 0.05 -RequireBaselineFastest
Add-BenchmarkComparison Engine -Baseline $engineComparisonBaseline -Metric MedianMs -TieTolerance 0.05 -RequireBaselineFastest
if ($updateReadme -and (Test-Path -LiteralPath $readmePath)) {
readme $readmePath -Block 'office-file-roundtrip-benchmark' -Renderer ComparisonTable
Add-BenchmarkReadmeBlock $readmePath -Block 'office-file-roundtrip-benchmark' -Renderer ComparisonTable
}
}
artifacts Json, Csv, Markdown
Set-BenchmarkArtifacts Json, Csv, Markdown
}
}.GetNewClosure()

Expand Down
64 changes: 32 additions & 32 deletions Module/Examples/Benchmark.SqlServerCsvExport.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,14 +305,14 @@ FROM numbers;
$getSeedQuery = ${function:Get-DbaClientXCsvExportSeedQuery}
$getFileMetrics = ${function:Get-DbaClientXCsvExportFileMetrics}

benchmark 'sqlserver-csv-export' -out $outputRootBase {
policy -Warmup $benchmarkWarmupCount -Iterations $benchmarkIterationCount -Order Rotated -MemoryCleanup BeforeIteration -OutlierMode None
profile Current -Cleanup KeepOnFailure
metadata ProcessorAffinity $appliedProcessorAffinity
metadata ProcessPriority $appliedProcessPriority
metadata Culture InvariantCulture

caseSource {
New-BenchmarkSuite 'sqlserver-csv-export' -OutputRoot $outputRootBase {
Set-BenchmarkPolicy -Warmup $benchmarkWarmupCount -Iterations $benchmarkIterationCount -Order Rotated -MemoryCleanup BeforeIteration -OutlierMode None
Set-BenchmarkProfile Current -Cleanup KeepOnFailure
Add-BenchmarkMetadata ProcessorAffinity $appliedProcessorAffinity
Add-BenchmarkMetadata ProcessPriority $appliedProcessPriority
Add-BenchmarkMetadata Culture InvariantCulture

Add-BenchmarkCaseSource {
foreach ($rowCount in $rowCounts) {
[pscustomobject]@{
Scenario = "$rowCount rows / CSV export"
Expand All @@ -321,7 +321,7 @@ FROM numbers;
}
}

setup {
Set-BenchmarkSetup {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand Down Expand Up @@ -387,7 +387,7 @@ ORDER BY Id;
}
}

skip {
Add-BenchmarkSkipRule {
param($case)

if ($case.Engine -in @('DbaClientXDataTable', 'DbaClientXPowerShellStream', 'DbaClientXReader', 'DbaClientXPartitionedReader')) {
Expand All @@ -413,8 +413,8 @@ ORDER BY Id;
return $false
}

engine DbaClientXDataTable {
operation Export {
Add-BenchmarkEngine DbaClientXDataTable {
Add-BenchmarkOperation Export {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand All @@ -430,8 +430,8 @@ ORDER BY Id;
}
}

engine DbaClientXPowerShellStream {
operation Export {
Add-BenchmarkEngine DbaClientXPowerShellStream {
Add-BenchmarkOperation Export {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand All @@ -447,8 +447,8 @@ ORDER BY Id;
}
}

engine DbaClientXReader {
operation Export {
Add-BenchmarkEngine DbaClientXReader {
Add-BenchmarkOperation Export {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand All @@ -471,8 +471,8 @@ ORDER BY Id;
}
}

engine DbaClientXPartitionedReader {
operation Export {
Add-BenchmarkEngine DbaClientXPartitionedReader {
Add-BenchmarkOperation Export {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand Down Expand Up @@ -524,8 +524,8 @@ ORDER BY Id;
}
}

engine dbatools {
operation Export {
Add-BenchmarkEngine dbatools {
Add-BenchmarkOperation Export {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand All @@ -549,8 +549,8 @@ ORDER BY Id;
}
}

engine bcp {
operation Export {
Add-BenchmarkEngine bcp {
Add-BenchmarkOperation Export {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand All @@ -574,8 +574,8 @@ ORDER BY Id;
}
}

engine FastBCP {
operation Export {
Add-BenchmarkEngine FastBCP {
Add-BenchmarkOperation Export {
param($case, $run)

$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
Expand Down Expand Up @@ -617,7 +617,7 @@ ORDER BY Id;
}
}

validate {
Add-BenchmarkValidation {
param($case, $run)

$outputFiles = if ($case.Engine -eq 'FastBCP') {
Expand Down Expand Up @@ -675,25 +675,25 @@ ORDER BY Id;
}
}

metric RowsExported {
Add-BenchmarkMetric RowsExported {
param($case, $run)

$run.RowsExported
}

metric FileBytes {
Add-BenchmarkMetric FileBytes {
param($case, $run)

$run.FileBytes
}

metric OutputFileCount {
Add-BenchmarkMetric OutputFileCount {
param($case, $run)

if ($null -ne $run.OutputFileCount) { $run.OutputFileCount } else { 1 }
}

metric RowsPerSecond {
Add-BenchmarkMetric RowsPerSecond {
param($case, $run)

if ($run.DurationMs -le 0) {
Expand All @@ -703,11 +703,11 @@ ORDER BY Id;
[double] $case.RowCount / ($run.DurationMs / 1000)
}

comparison Engine -Baseline DbaClientXReader -Metric MedianMs -TieTolerance 0.05 -RequireBaselineFastest
Add-BenchmarkComparison Engine -Baseline DbaClientXReader -Metric MedianMs -TieTolerance 0.05 -RequireBaselineFastest
if ($updateReadme -and (Test-Path -LiteralPath $readmePath)) {
readme $readmePath -Block 'sqlserver-csv-export-benchmark' -Renderer ComparisonTable
Add-BenchmarkReadmeBlock $readmePath -Block 'sqlserver-csv-export-benchmark' -Renderer ComparisonTable
}
artifacts Json, Csv, Markdown
Set-BenchmarkArtifacts Json, Csv, Markdown
}
}.GetNewClosure()

Expand Down
Loading