Documentation
¶
Overview ¶
Package stroppy turns one test definition into a standalone Stroppy application.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisteredMain ¶
func RegisteredMain(identity ...string)
RegisteredMain runs every workload registered through bench.Register. Generated portable Stroppy binaries use this entrypoint after blank-importing built-in and selected custom workload packages.
Types ¶
type Application ¶
type Application struct {
// contains filtered or unexported fields
}
Application is one standalone Stroppy workload.
func New ¶
func New(test bench.Test) (*Application, error)
New validates a Test and creates a standalone application.
func NewCatalog ¶
func NewCatalog(catalog *bench.Catalog) (*Application, error)
NewCatalog creates an application over an explicit catalog without global registration.
func (*Application) Execute ¶
func (a *Application) Execute( ctx context.Context, args []string, stdout, stderr io.Writer, ) error
Execute runs standalone command behavior without exiting host process.
func (*Application) Name ¶
func (a *Application) Name() string
Name returns standalone workload identity.
func (*Application) Run ¶
func (a *Application) Run(ctx context.Context, request *RunRequest) (*report.Run, error)
Run returns report data without automatic filesystem persistence.
type RunRequest ¶
type RunRequest struct {
Test string
Drivers map[string]bench.DriverConfig
Params bench.ParamInputs
Steps []string
NoSteps []string
Logger bench.Logger
Metrics *bench.MetricsConfig
ReportOptions bench.ReportOptions
NoReport bool
Capture *bench.CaptureOptions
Profiling *profiling.Config
}
RunRequest contains programmatic inputs for one workload run.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
dstparse
command
dstparse transforms TPC-DS dsdgen `.dst` distribution files into the uniform Dict-shaped JSON document consumed by the relations data generator.
|
dstparse transforms TPC-DS dsdgen `.dst` distribution files into the uniform Dict-shaped JSON document consumed by the relations data generator. |
|
stroppy
command
|
|
|
stroppy/commands/baseline
Package baseline implements `stroppy baseline`: it measures stroppy's own overhead on the current machine — the noop-driver framework ceiling and the pg-wire protocol ceiling against a pg-noop blackhole server — and saves a versioned report for future comparison.
|
Package baseline implements `stroppy baseline`: it measures stroppy's own overhead on the current machine — the noop-driver framework ceiling and the pg-wire protocol ceiling against a pg-noop blackhole server — and saves a versioned report for future comparison. |
|
stroppy/commands/help
Package help implements the `stroppy help <topic>` subcommand.
|
Package help implements the `stroppy help <topic>` subcommand. |
|
stroppy/commands/probe
Package probe lists embedded workload presets and driver capabilities.
|
Package probe lists embedded workload presets and driver capabilities. |
|
tpcds-answers
command
tpcds-answers parses the official TPC-DS kit reference answer sets (`answer_sets/*.ans`) into a single `answers_sf1.json` document keyed by the query-statement names used in the baked per-dialect SQL (`query_1` … `query_99`, with the two-part queries 14/23/24/39 split into `_a`/`_b`).
|
tpcds-answers parses the official TPC-DS kit reference answer sets (`answer_sets/*.ans`) into a single `answers_sf1.json` document keyed by the query-statement names used in the baked per-dialect SQL (`query_1` … `query_99`, with the two-part queries 14/23/24/39 split into `_a`/`_b`). |
|
tpcds-diff
command
tpcds-diff compares two TPC-DS query-result dumps produced by the workload's ANSWER_DUMP mode (lines "__TPCDS_DUMP__\t<name>\t<json-rows|ERR:msg>" in a run log).
|
tpcds-diff compares two TPC-DS query-result dumps produced by the workload's ANSWER_DUMP mode (lines "__TPCDS_DUMP__\t<name>\t<json-rows|ERR:msg>" in a run log). |
|
tpch-answers
command
tpch-answers parses a directory of TPC-H reference answer files into a single `answers_sf1.json` document.
|
tpch-answers parses a directory of TPC-H reference answer files into a single `answers_sf1.json` document. |
|
tpch-dists
command
tpch-dists transforms upstream TPC-H `dists.dss` into the uniform Dict-shaped JSON document consumed by the relations data generator.
|
tpch-dists transforms upstream TPC-H `dists.dss` into the uniform Dict-shaped JSON document consumed by the relations data generator. |
|
examples
|
|
|
authoring
Package authoring contains small workloads using only the supported author API.
|
Package authoring contains small workloads using only the supported author API. |
|
authoring/main
command
|
|
|
internal
|
|
|
author
Package author scaffolds standalone projects from explicitly published workload files.
|
Package author scaffolds standalone projects from explicitly published workload files. |
|
author/generate
command
Command generate refreshes explicitly published builtin source support files.
|
Command generate refreshes explicitly published builtin source support files. |
|
capture
Package capture writes bounded run recordings independently of database work.
|
Package capture writes bounded run recordings independently of database work. |
|
cli
Package cli assembles Stroppy's reusable command interface.
|
Package cli assembles Stroppy's reusable command interface. |
|
jsonschema-gen
command
Command jsonschema-gen emits the JSON Schema for pkg/config's file envelope.
|
Command jsonschema-gen emits the JSON Schema for pkg/config's file envelope. |
|
pgnoop
Package pgnoop manages the external pg-noop blackhole server binary used by the baseline command: resolving it from an embedded copy, the local cache, or the pinned GitHub release, and running it for the duration of a run.
|
Package pgnoop manages the external pg-noop blackhole server binary used by the baseline command: resolving it from an embedded copy, the local cache, or the pinned GitHub release, and running it for the duration of a run. |
|
rowmap
Package rowmap shares shallow SQL-row conversion with ordinary struct sources.
|
Package rowmap shares shallow SQL-row conversion with ordinary struct sources. |
|
testdriver
Package testdriver scopes database-free backend selection to one test run.
|
Package testdriver scopes database-free backend selection to one test run. |
|
toolchain
Package toolchain resolves system or Stroppy-owned Go compilers.
|
Package toolchain resolves system or Stroppy-owned Go compilers. |
|
workloadcatalog
Package workloadcatalog stores compiled custom workloads owned by Stroppy.
|
Package workloadcatalog stores compiled custom workloads owned by Stroppy. |
|
pkg
|
|
|
bench/mpp
Package mpp is what the analytical workloads share about Greenplum-family engines (Greenplum, Greengage, WarehousePG, Apache Cloudberry): the dialect name and the check that keeps a run on the dialect that matches the server it is connected to.
|
Package mpp is what the analytical workloads share about Greenplum-family engines (Greenplum, Greengage, WarehousePG, Apache Cloudberry): the dialect name and the check that keeps a run on the dialect that matches the server it is connected to. |
|
bench/testkit
Package testkit runs ordinary workloads without a database or report history.
|
Package testkit runs ordinary workloads without a database or report history. |
|
config
Package config holds the plain-Go application configuration types for run, workload, driver, pool, logger, exporter, and isolation settings.
|
Package config holds the plain-Go application configuration types for run, workload, driver, pool, logger, exporter, and isolation settings. |
|
datagen/source
Package source defines the row-production contract that every load-time data generator implements and every driver consumes.
|
Package source defines the row-production contract that every load-time data generator implements and every driver consumes. |
|
driver/common
Package common hosts driver-agnostic building blocks shared by every Stroppy database driver.
|
Package common hosts driver-agnostic building blocks shared by every Stroppy database driver. |
|
driver/csv
Package csv implements an ephemeral Stroppy driver that writes generator output to CSV files on the local filesystem instead of a database.
|
Package csv implements an ephemeral Stroppy driver that writes generator output to CSV files on the local filesystem instead of a database. |
|
driver/insertprogress
Package insertprogress provides driver-agnostic insert operation progress tracking.
|
Package insertprogress provides driver-agnostic insert operation progress tracking. |
|
driver/noop
Package noop provides a no-op database driver that discards all operations without performing any I/O. It is intended for benchmarking stroppy's own framework overhead in isolation from actual database latency.
|
Package noop provides a no-op database driver that discards all operations without performing any I/O. It is intended for benchmarking stroppy's own framework overhead in isolation from actual database latency. |
|
driver/recording
Package recording implements a database-free driver that records operations.
|
Package recording implements a database-free driver that records operations. |
|
gen
Package gen provides deterministic data-generation primitives for stroppy workloads.
|
Package gen provides deterministic data-generation primitives for stroppy workloads. |
|
profiling
Package profiling provides opt-in, process-wide Go diagnostics for Stroppy applications.
|
Package profiling provides opt-in, process-wide Go diagnostics for Stroppy applications. |
|
record
Package record provides structured, deterministic operation recordings for workload tests.
|
Package record provides structured, deterministic operation recordings for workload tests. |
|
report
Package report defines Stroppy's versioned machine-readable run report.
|
Package report defines Stroppy's versioned machine-readable run report. |
|
report/compare
Package compare calculates explicit, dimension-preserving comparisons of saved runs.
|
Package compare calculates explicit, dimension-preserving comparisons of saved runs. |
|
report/view
Package view renders saved run reports without changing their data.
|
Package view renders saved run reports without changing their data. |
|
Package workloads provides workload-owned embedded SQL, JSON, and documentation files.
|
Package workloads provides workload-owned embedded SQL, JSON, and documentation files. |
|
all
Package all registers every built-in workload through blank imports.
|
Package all registers every built-in workload through blank imports. |
|
banking
Package banking is a bank-transfer invariant workload: every transfer must preserve the total balance and the token multiset, under concurrency and injected faults.
|
Package banking is a bank-transfer invariant workload: every transfer must preserve the total balance and the token multiset, under concurrency and injected faults. |
|
banking/published/workloadtest
Package workloadtest provides contract assertions for embedded workload assets.
|
Package workloadtest provides contract assertions for embedded workload assets. |
|
baseline
Package baseline provides Stroppy's machine-benchmark workload.
|
Package baseline provides Stroppy's machine-benchmark workload. |
|
execute_sql
Package execute_sql runs named queries from inline or file SQL sources.
|
Package execute_sql runs named queries from inline or file SQL sources. |
|
internal/workloadtest
Package workloadtest provides contract assertions for embedded workload assets.
|
Package workloadtest provides contract assertions for embedded workload assets. |
|
simple
Package simple provides Stroppy's minimal workload example.
|
Package simple provides Stroppy's minimal workload example. |
|
tpcb
Package tpcb owns Stroppy's TPC-B implementation, tests, and dialect SQL.
|
Package tpcb owns Stroppy's TPC-B implementation, tests, and dialect SQL. |
|
tpcb/published/workloadtest
Package workloadtest provides contract assertions for embedded workload assets.
|
Package workloadtest provides contract assertions for embedded workload assets. |
|
tpcc
Package tpcc implements the five TPC-C transactions as ordered DML steps inside driver transactions with the standard 45/43/4/4/4 mix.
|
Package tpcc implements the five TPC-C transactions as ordered DML steps inside driver transactions with the standard 45/43/4/4/4 mix. |
|
tpcc/published/workloadtest
Package workloadtest provides contract assertions for embedded workload assets.
|
Package workloadtest provides contract assertions for embedded workload assets. |
|
tpcds
Package tpcds owns Stroppy's TPC-DS implementation, tests, dialect SQL, and answer data.
|
Package tpcds owns Stroppy's TPC-DS implementation, tests, dialect SQL, and answer data. |
|
tpcds/dsdgen
Package dsdgen is a spec-faithful Go port of the TPC-DS data generator (dsdgen, v4.0.0).
|
Package dsdgen is a spec-faithful Go port of the TPC-DS data generator (dsdgen, v4.0.0). |
|
tpcds/dsqgen
Package dsqgen is a lean port of the TPC-DS query generator (dsqgen).
|
Package dsqgen is a lean port of the TPC-DS query generator (dsqgen). |
|
tpcds/dsqgen/cmd/dsqgen
command
Command dsqgen renders TPC-DS query streams for a target SQL dialect, drawing valid, scale-correct parameter values with a seeded RNG (it does not reproduce the C dsqgen's exact value stream).
|
Command dsqgen renders TPC-DS query streams for a target SQL dialect, drawing valid, scale-correct parameter values with a seeded RNG (it does not reproduce the C dsqgen's exact value stream). |
|
tpcds/published/source
Package source defines the row-production contract that every load-time data generator implements and every driver consumes.
|
Package source defines the row-production contract that every load-time data generator implements and every driver consumes. |
|
tpcds/published/workloadtest
Package workloadtest provides contract assertions for embedded workload assets.
|
Package workloadtest provides contract assertions for embedded workload assets. |
|
tpcds/tpcdsgen
Package tpcdsgen adapts the ported TPC-DS dsdgen generator (third_party/gotpcds/dsdgen) to the source.Partitionable contract, so the spec-faithful, byte-exact generator feeds any Stroppy driver through the same load path as the native evaluator and the TPC-H generator.
|
Package tpcdsgen adapts the ported TPC-DS dsdgen generator (third_party/gotpcds/dsdgen) to the source.Partitionable contract, so the spec-faithful, byte-exact generator feeds any Stroppy driver through the same load path as the native evaluator and the TPC-H generator. |
|
tpch
Package tpch owns Stroppy's TPC-H implementation, tests, dialect SQL, and answer data.
|
Package tpch owns Stroppy's TPC-H implementation, tests, dialect SQL, and answer data. |
|
tpch/published/source
Package source defines the row-production contract that every load-time data generator implements and every driver consumes.
|
Package source defines the row-production contract that every load-time data generator implements and every driver consumes. |
|
tpch/published/workloadtest
Package workloadtest provides contract assertions for embedded workload assets.
|
Package workloadtest provides contract assertions for embedded workload assets. |
|
tpch/tpchgen
Package tpchgen adapts the vendored TPC-H dbgen generator (third_party/gotpc/dbgen) to the source.Partitionable contract so the ported, spec-faithful generator can feed any Stroppy driver through the same load path as the native evaluator.
|
Package tpchgen adapts the vendored TPC-H dbgen generator (third_party/gotpc/dbgen) to the source.Partitionable contract so the ported, spec-faithful generator can feed any Stroppy driver through the same load path as the native evaluator. |