package wal

Import Path
	github.com/polarsignals/frostdb/wal (on go.dev)

Dependency Relation
	imports 17 packages, and imported by one package

Involved Source Files

	    wal.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type FileWAL (struct)

		Methods (total 9)
			(*FileWAL) Close() error
			(*FileWAL) FirstIndex() (uint64, error)
			(*FileWAL) LastIndex() (uint64, error)
			(*FileWAL) Log(tx uint64, record *walpb.Record) error
			(*FileWAL) LogRecord(tx uint64, table string, record arrow.Record) error
			(*FileWAL) Replay(tx uint64, handler ReplayHandlerFunc) (err error)
			(*FileWAL) Reset(nextTx uint64) error
			(*FileWAL) RunAsync()
			(*FileWAL) Truncate(tx uint64) error
				Truncate queues a truncation of the WAL at the given tx. Note that the
				truncation will be performed asynchronously. A nil error does not indicate
				a successful truncation.

		Implements (at least 3)
			*FileWAL : github.com/polarsignals/frostdb.WAL
			*FileWAL : github.com/prometheus/common/expfmt.Closer
			*FileWAL : io.Closer
		As Outputs Of (at least one exported)
			func Open(logger log.Logger, path string, opts ...Option) (*FileWAL, error)

	 type Metrics (struct)

		Fields (total 6)
			FailedLogs prometheus.Counter
			LastTruncationAt prometheus.Gauge
			WalCloseTimeouts prometheus.Counter
			WalQueueSize prometheus.Gauge
			WalRepairs prometheus.Counter
			WalRepairsLostRecords prometheus.Counter
		As Inputs Of (at least one exported)
			func WithMetrics(m *Metrics) Option

	 type NopWAL (struct)

		Methods (total 8)
			(*NopWAL) Close() error
			(*NopWAL) FirstIndex() (uint64, error)
			(*NopWAL) LastIndex() (uint64, error)
			(*NopWAL) Log(_ uint64, _ *walpb.Record) error
			(*NopWAL) LogRecord(_ uint64, _ string, _ arrow.Record) error
			(*NopWAL) Replay(_ uint64, _ ReplayHandlerFunc) error
			(*NopWAL) Reset(_ uint64) error
			(*NopWAL) Truncate(_ uint64) error
		Implements (at least 3)
			*NopWAL : github.com/polarsignals/frostdb.WAL
			*NopWAL : github.com/prometheus/common/expfmt.Closer
			*NopWAL : io.Closer

	 type Option (func)

		As Outputs Of (at least 5)
			func WithMetrics(m *Metrics) Option
			func WithStoreMetrics(m *wal.Metrics) Option
			func WithTestingCallbackWithDroppedLogsOnClose(cb func([]types.LogEntry)) Option
			func WithTestingLogStoreWrapper(newLogStoreWrapper func(wal.LogStore) wal.LogStore) Option
			func WithTestingLoopTicker(t Ticker) Option
		As Inputs Of (at least 2)
			func Open(logger log.Logger, path string, opts ...Option) (*FileWAL, error)
			func github.com/polarsignals/frostdb.WithTestingWalOptions(opts ...Option) frostdb.TestingOption

	 type ReplayHandlerFunc (func)

		As Inputs Of (at least 3)
			func (*FileWAL).Replay(tx uint64, handler ReplayHandlerFunc) (err error)
			func (*NopWAL).Replay(_ uint64, _ ReplayHandlerFunc) error
			func github.com/polarsignals/frostdb.WAL.Replay(tx uint64, handler ReplayHandlerFunc) error

	 type Ticker (interface)

		Methods (total 2)
			( Ticker) C() <-chan time.Time
			( Ticker) Stop()
		As Inputs Of (at least one exported)
			func WithTestingLoopTicker(t Ticker) Option


Package-Level Functions (total 6)

	 func Open(logger log.Logger, path string, opts ...Option) (*FileWAL, error)
	 func WithMetrics(m *Metrics) Option
	 func WithStoreMetrics(m *wal.Metrics) Option
	 func WithTestingCallbackWithDroppedLogsOnClose(cb func([]types.LogEntry)) Option
		WithTestingCallbackWithDroppedLogsOnClose is called when the WAL times out on
		close with all the entries that could not be written.

	 func WithTestingLogStoreWrapper(newLogStoreWrapper func(wal.LogStore) wal.LogStore) Option
	 func WithTestingLoopTicker(t Ticker) Option
		WithTestingLoopTicker allows the caller to force processing of pending WAL
		entries by providing a custom ticker implementation.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.