options

package
v0.0.0-debug-20260702 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 2, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DefaultBulkTomestoneTxnThreshold = 10000 // rows
	DefaultLockMergePruneInterval    = time.Minute

	DefaultBlockMaxRows    = objectio.BlockMaxRows
	DefaultBlocksPerObject = uint16(256)

	DefaultScannerInterval              = time.Second * 5
	DefaultCheckpointFlushInterval      = time.Minute
	DefaultCheckpointTransferInterval   = time.Second * 5
	DefaultCheckpointMinCount           = int64(100)
	DefaultCheckpointIncremetalInterval = time.Minute
	DefaultCheckpointGlobalMinCount     = 10
	DefaultGlobalVersionInterval        = time.Hour
	DefaultGCCheckpointInterval         = time.Minute
	DefaultOverallFlushMemControl       = common.Const1GBytes

	DefaultScanGCInterval    = time.Minute * 30
	DefaultGCTTL             = time.Hour
	DefaultGCInMemoryTTL     = time.Hour
	DefaultGCMergeCount      = 40
	DefaultGCScanCount       = 10
	DefaultGCDeleteBatchSize = 1000
	DefaultGCDeleteTimeout   = time.Minute * 10
	DefaultGCDeleteWorkerNum = 4

	DefaultCatalogGCInterval = time.Minute * 3

	DefaultIOWorkers    = int(16)
	DefaultAsyncWorkers = int(16)

	DefaultLogtailTxnPageSize = 256
)

Variables

This section is empty.

Functions

func WithCatalogGCInterval added in v0.7.0

func WithCatalogGCInterval(internal time.Duration) func(*Options)

func WithCheckpointGlobalMinCount added in v0.7.0

func WithCheckpointGlobalMinCount(count int64) func(*Options)

func WithCheckpointIncrementaInterval added in v0.6.0

func WithCheckpointIncrementaInterval(interval time.Duration) func(*Options)

func WithCheckpointMinCount added in v0.6.0

func WithCheckpointMinCount(count int64) func(*Options)

func WithCheckpointScanInterval added in v0.6.0

func WithCheckpointScanInterval(interval time.Duration) func(*Options)

func WithDisableGCCatalog added in v0.7.0

func WithDisableGCCatalog() func(*Options)

func WithDisableGCCheckpoint added in v0.7.0

func WithDisableGCCheckpoint() func(*Options)

func WithFlushInterval added in v0.7.0

func WithFlushInterval(interval time.Duration) func(*Options)

func WithGCCheckpointInterval added in v0.7.0

func WithGCCheckpointInterval(interval time.Duration) func(*Options)

func WithGlobalVersionInterval added in v0.7.0

func WithGlobalVersionInterval(interval time.Duration) func(*Options)

func WithReserveWALEntryCount added in v1.0.0

func WithReserveWALEntryCount(count uint64) func(*Options)

func WithTransferTableTTL added in v0.6.0

func WithTransferTableTTL(ttl time.Duration) func(*Options)

func WithWalClientFactory

func WithWalClientFactory(factory logservicedriver.LogServiceClientFactory) func(*Options)

Types

type CatalogCfg added in v0.7.0

type CatalogCfg struct {
	GCInterval time.Duration
	DisableGC  bool
}

type CheckpointCfg

type CheckpointCfg struct {
	FlushInterval             time.Duration `toml:"flush-inerterval"`
	TransferInterval          time.Duration `toml:"transfer-interval"`
	MetadataCheckInterval     time.Duration `toml:"metadata-check-inerterval"`
	MinCount                  int64         `toml:"checkpoint-min-count"`
	ScanInterval              time.Duration `toml:"scan-interval"`
	IncrementalInterval       time.Duration `toml:"checkpoint-incremental-interval"`
	GlobalMinCount            int64         `toml:"checkpoint-global-interval"`
	OverallFlushMemControl    uint64        `toml:"overall-flush-mem-control"`
	ForceUpdateGlobalInterval bool
	GlobalVersionInterval     time.Duration `toml:"global-version-interval"`
	GCCheckpointInterval      time.Duration
	DisableGCCheckpoint       bool
	ReservedWALEntryCount     uint64
	TableIDHistoryDuration    time.Duration `toml:"table-id-history-duration"`
	TableIDSinkerThreshold    int           `toml:"table-id-sinker-threshold"`

	// only for test
	// it is used to control the block rows of the checkpoint
	BlockRows int
	Size      int
}

type GCCfg added in v0.7.0

type GCCfg struct {
	GCTTL             time.Duration `toml:"gc-ttl"`
	GCInMemoryTTL     time.Duration `toml:"gc-in-memory-ttl"`
	ScanGCInterval    time.Duration `toml:"scan-gc-interval"`
	DisableGC         bool          `toml:"disable-gc"`
	CheckGC           bool          `toml:"check-gc"`
	CacheSize         int           `toml:"cache-size"`
	GCMergeCount      int           `toml:"gc-merge-count"`
	GCScanCount       int           `toml:"gc-scan-count"`
	GCestimateRows    int           `toml:"gc-estimate-rows"`
	GCProbility       float64       `toml:"gc-probility"`
	GCDeleteTimeout   time.Duration `toml:"gc-delete-timeout"`
	GCDeleteBatchSize int           `toml:"gc-delete-batch-size"`
	GCDeleteWorkerNum int           `toml:"gc-delete-worker-num"`
}

type LogtailCfg added in v0.6.0

type LogtailCfg struct {
	PageSize int32 `toml:"page-size"`
}

type LogtailServerCfg added in v0.7.0

type LogtailServerCfg struct {
	RpcMaxMessageSize      int64
	RpcEnableChecksum      bool
	RPCStreamPoisonTime    time.Duration
	LogtailCollectInterval time.Duration
	ResponseSendTimeout    time.Duration
	// PullWorkerPoolSize is the size of the pull worker pool.
	// Means there are x pull workers working at most.
	// Default value is defaultPullWorkerPoolSize=50.
	PullWorkerPoolSize int64
}

func NewDefaultLogtailServerCfg added in v0.7.0

func NewDefaultLogtailServerCfg() *LogtailServerCfg

func (*LogtailServerCfg) Validate added in v0.7.0

func (l *LogtailServerCfg) Validate()

type MergeConfig added in v1.2.0

type MergeConfig struct {
	CNMergeMemControlHint uint64
	CNTakeOverAll         bool
	CNTakeOverExceed      uint64
	CNStandaloneTake      bool
	DisableZMBasedMerge   bool
}

type Options

type Options struct {
	StorageCfg    *StorageCfg    `toml:"storage-cfg"`
	CheckpointCfg *CheckpointCfg `toml:"checkpoint-cfg"`
	SchedulerCfg  *SchedulerCfg  `toml:"scheduler-cfg"`
	GCCfg         *GCCfg         `toml:"gc-cfg"`
	LogtailCfg    *LogtailCfg
	MergeCfg      *MergeConfig
	CatalogCfg    *CatalogCfg

	BulkTomestoneTxnThreshold uint64
	TransferTableTTL          time.Duration
	IncrementalDedup          bool
	IsStandalone              bool
	EnableApplyTableData      bool
	GCTimeCheckerFactory      func(any) func(*types.TS) bool

	Fs                fileservice.FileService                  `toml:"-"`
	LocalFs           fileservice.FileService                  `toml:"-"`
	TmpFs             *fileservice.TmpFileService              `toml:"-"`
	WalClientFactory  logservicedriver.LogServiceClientFactory `toml:"-"`
	Ctx               context.Context                          `toml:"-"`
	Shard             metadata.TNShard                         `toml:"-"`
	Clock             clock.Clock                              `toml:"-"`
	TaskServiceGetter taskservice.Getter                       `toml:"-"`
	SID               string                                   `toml:"-"`
}

func (*Options) FillDefaults

func (o *Options) FillDefaults(dirname string) *Options

func (*Options) JsonString

func (o *Options) JsonString() string

type SchedulerCfg

type SchedulerCfg struct {
	IOWorkers    int `toml:"io-workers"`
	AsyncWorkers int `toml:"async-workers"`
}

type StorageCfg

type StorageCfg struct {
	BlockMaxRows    uint32 `toml:"block-max-rows"`
	ObjectMaxBlocks uint16 `toml:"object-max-blocks"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL