mirror of
https://github.com/luxfi/zapdb.git
synced 2026-10-30 15:12:20 +00:00
zeekayandHanzo Dev
fe8d85d663
The module has been github.com/luxfi/zapdb for a while, but the package inside it still declared itself badger, so every consumer had to write zapdb "github.com/luxfi/zapdb" // package badger and the alias existed only to paper over the mismatch. 56 root files and the 134 qualified references inside the repo now say zapdb. Backward compatible in both directions: an existing consumer with the alias keeps compiling (the alias is now merely redundant), and one without it starts compiling instead of failing on an undefined zapdb. Directory badger/ and its cmd package are untouched — that is the CLI, and its binary is named badger. Build and vet clean; suite green except TestZRestore, which wants a /tmp/zb/src benchmark fixture and fails identically without this change. Co-authored-by: Hanzo Dev <[email protected]>
69 lines
2.6 KiB
Go
69 lines
2.6 KiB
Go
/*
|
|
* SPDX-FileCopyrightText: © 2017-2025 Istari Digital, Inc.
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
package zapdb
|
|
|
|
// Important: Do NOT import the "testing" package, as otherwise, that
|
|
// will pull in imports into the production class that we do not want.
|
|
|
|
// TODO: Consider using this with specific compilation tags so that it only
|
|
// shows up when performing testing (e.g., specify build tag=unit).
|
|
// We are not yet ready to do that, as it may impact customer usage as
|
|
// well as requiring us to update the CI build flags. Moreover, the
|
|
// current model does not actually incur any significant cost.
|
|
// If we do this, we will also want to introduce a parallel file that
|
|
// overrides some of these structs and functions with empty contents.
|
|
|
|
// String constants for messages to be pushed to syncChan.
|
|
const (
|
|
updateDiscardStatsMsg = "updateDiscardStats iteration done"
|
|
endVLogInitMsg = "End: vlog.init(db)"
|
|
)
|
|
|
|
// testOnlyOptions specifies an extension to the type Options that we want to
|
|
// use only in the context of testing.
|
|
type testOnlyOptions struct {
|
|
// syncChan is used to listen for specific messages related to activities
|
|
// that can occur in a DB instance. Currently, this is only used in
|
|
// testing activities.
|
|
syncChan chan string
|
|
}
|
|
|
|
// testOnlyDBExtensions specifies an extension to the type DB that we want to
|
|
// use only in the context of testing.
|
|
type testOnlyDBExtensions struct {
|
|
syncChan chan string
|
|
|
|
// onCloseDiscardCapture will be populated by a DB instance during the
|
|
// process of performing the Close operation. Currently, we only consider
|
|
// using this during testing.
|
|
onCloseDiscardCapture map[uint64]uint64
|
|
}
|
|
|
|
// logToSyncChan sends a message to the DB's syncChan. Note that we expect
|
|
// that the DB never closes this channel; the responsibility for
|
|
// allocating and closing the channel belongs to the test module.
|
|
// if db.syncChan is nil or has never been initialized, this will be
|
|
// silently ignored.
|
|
func (db *DB) logToSyncChan(msg string) {
|
|
if db.syncChan != nil {
|
|
db.syncChan <- msg
|
|
}
|
|
}
|
|
|
|
// captureDiscardStats will copy the contents of the discardStats file
|
|
// maintained by vlog to the onCloseDiscardCapture map specified by
|
|
// db.opt. Of course, if db.opt.onCloseDiscardCapture is nil (as expected
|
|
// for a production system as opposed to a test system), this is a no-op.
|
|
func (db *DB) captureDiscardStats() {
|
|
if db.onCloseDiscardCapture != nil {
|
|
db.vlog.discardStats.Lock()
|
|
db.vlog.discardStats.Iterate(func(id, val uint64) {
|
|
db.onCloseDiscardCapture[id] = val
|
|
})
|
|
db.vlog.discardStats.Unlock()
|
|
}
|
|
}
|