engine

type BenchmarkConfig struct {
	Plugin string `mapstructure:"benchmark"`

	// Plugin specific config
	PluginConfig interface{}
}

type Config struct {
	GlobalCfg    GlobalConfig      `mapstructure:"global"`
	DB           util.DBConnParams `mapstructure:"database"`
	GeneratorCfg GeneratorConfig   `mapstructure:"generator"`
	WriterCfg    WriterConfig      `mapstructure:"writer"`
	BenchmarkCfg BenchmarkConfig   `mapstructure:"benchmark"`

	// print config usage
	Usage func()

	NewGeneratorFunc NewGeneratorFunc
	NewWriterFunc    NewWriterFunc
	NewBenchmarkFunc NewBenchmarkFunc
}

type ConfigurablePlugin interface {
	// CreatePluginConfig returns a plugin specific config struct, can have any k=>v pairs
	// It is plugin author's responsibility to tag "`mapstructure:"<key-name>"`" on struct members
	// to make it able to export/import with config file
	CreatePluginConfig() interface{}

	// GetDefaultFlags returns a flagSet struct which have all flags with specified name, value, and usage string.
	// Those key names should be consistent with tags "`mapstructure:"<key-name>"`" on the config struct
	// The second return value is the plugin config struct created inside this function
	GetDefaultFlags() (*pflag.FlagSet, interface{})
}

type Engine struct {
	IGenerator IGenerator
	IWriter    IWriter
	IBenchmark IBenchmark
	Metadata   *metadata.Metadata
	VolumeDesc VolumeDesc

	Config *Config
	// contains filtered or unexported fields
}

type ExecBenchFunc func(context.Context, Query, Stat) error

type ExecBenchOption struct {
	Parallel int
	RunTimes int64
	Duration time.Duration
}

type ExecBenchStat struct {
	TPS        int           `json:"tps"`
	AvgLatency time.Duration `json:"avg-latency"`
	MaxLatency time.Duration `json:"max-latency"`
	P75Latency time.Duration `json:"p75-latency"`
	P50Latency time.Duration `json:"p50-latency"`
	P25Latency time.Duration `json:"p25-latency"`

	TimeElapsed int64 `json:"overall-duration"`
	// contains filtered or unexported fields
}

type ExecDDLFunc func() error

type ExecSetGUCsFunc func() error

type GeneratorConfig struct {
	Plugin string `mapstructure:"generator"`

	// Plugin specific config
	PluginConfig interface{}

	// derived from elsewhere
	GlobalConfig *GlobalConfig
}

type GeneratorPrediction struct {
	Count, Size int64
}

type GetTableSizeFunc func() (int64, error)

type GlobalConfig struct {
	SchemaName               string               `mapstructure:"schema-name"`
	TableName                string               `mapstructure:"table-name"`
	TagNum                   int64                `mapstructure:"tag-num"`
	TimestampStart           string               `mapstructure:"ts-start"`
	TimestampEnd             string               `mapstructure:"ts-end"`
	PartitionIntervalInHour  int64                `mapstructure:"partition-inteval-in-hour"`
	IsRealtimeMode           bool                 `mapstructure:"realtime"`
	MetricsType              metadata.MetricsType `mapstructure:"metrics-type"`
	TotalMetricsCount        int64                `mapstructure:"total-metrics-count"`
	TimestampStepInSecond    uint64               `mapstructure:"ts-step-in-second"`
	Dump                     bool                 `mapstructure:"dump"`
	MetricsDescriptions      string               `mapstructure:"metrics-descriptions"`
	Workspace                string               `mapstructure:"workspace"`
	DDLFilePath              string               `mapstructure:"ddl-file-path"`
	SimultaneousLoadAndQuery bool                 `mapstructure:"simultaneous-loading-and-query"`
	PreBenchmarkQuery        string               `mapstructure:"pre-benchmark-query"`
	SkipSetGUCs              bool                 `mapstructure:"skip-set-gucs"`
	StorageType              string               `mapstructure:"storage-type"`
	Degrade                  bool                 `mapstructure:"degrade"`

	// Enhanced signal generation
	SignalFile            string `mapstructure:"signal-file"`
	SignalPreset          string `mapstructure:"signal-preset"`
	MaxSimpleColumnNum    int    `mapstructure:"max-simple-column-num"`
	JSONBSplitMode        string `mapstructure:"jsonb-split-mode"`
	JSONBMaxKeysPerColumn int64  `mapstructure:"jsonb-max-keys-per-column"`

	// Bench-gen-only mode
	BenchGenOnly        bool `mapstructure:"bench-gen-only"`
	BenchGenDurationSec int  `mapstructure:"bench-gen-duration"`

	// misc
	Command       string
	CfgFile       string
	HelpWanted    bool   `mapstructure:"help"`
	VersionWanted bool   `mapstructure:"version"`
	LogLevel      string `mapstructure:"log-level"`
	Watch         bool   `mapstructure:"watch"`
	CPUProfile    bool

	StartAt time.Time
	EndAt   time.Time

	ReportPath   string       `mapstructure:"report-path"`
	ReportFormat ReportFormat `mapstructure:"report-format"`
}

type IBenchmark interface {
	NilCheck
	ConfigurablePlugin
	Run(<-chan error, Config, *metadata.Metadata, ExecBenchFunc) error
	Close() error
	GetStat() Stat
}

type IEngine interface {
	NilCheck
	Run() error
	Close() error
	PrintStat()
	PrintProgress()
	GetFormattedSummary()
}

type IGenerator interface {
	NilCheck
	ConfigurablePlugin
	GetPrediction(*metadata.Table) (GeneratorPrediction, error)
	ModifyMetadataConfig(*metadata.Config)
	Run(GlobalConfig, *metadata.Metadata, WriteFunc) error
	Close() error
	// BenchGenOnly runs a local-only data generation benchmark for the given duration.
	// It generates and discards data, reporting throughput metrics.
	BenchGenOnly(GlobalConfig, *metadata.Metadata, time.Duration) error
}

type IWriter interface {
	NilCheck
	ConfigurablePlugin
	// Close finCh after writer ended.
	Start(Config, VolumeDesc) (finCh <-chan error, err error)
	Stop() error
	Write([]byte, int64, int64) error
	WriteEOF() error
	GetStat() Stat
}

type NewBenchmarkFunc func(cfg BenchmarkConfig) IBenchmark

type NewGeneratorFunc func(cfg GeneratorConfig) IGenerator

type NewWriterFunc func(cfg WriterConfig) IWriter

type NilCheck interface {
	IsNil() bool
}

type Query interface {
	GetSQL() string
	GetName() string
}

type ReportFormat = string

type Stat interface {
	AddSubStat(Stat)

	GetName() string
	GetSummary() string
	GetFormattedSummary() string
	GetProgress() string
	GetSubStats() []Stat

	GetCurrentProgress(opt ...interface{}) map[string]interface{}
}

type VolumeDesc struct {
	GeneratorPrediction GeneratorPrediction
	GetTableSizeFunc    GetTableSizeFunc
}

type WriteFunc func([]byte, int64, int64) error

type WriterConfig struct {
	Plugin string `mapstructure:"writer"`

	// Plugin specific config
	PluginConfig interface{}
}