mirror/dolt
1
0
Fork 0
mirror of https://github.com/dolthub/dolt.git synced 2026-02-21 10:09:35 -06:00
Code Issues Packages Projects Releases 136 Wiki Activity

Add docstring for CommitMetaGenerator

Browse Source
This commit is contained in:
Solipsis
2023-03-20 17:10:40 -07:00
parent 5c4e1dd617
commit 4d1a26172e
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
go/libraries/doltcore/doltdb/doltdb.go
View File

@@ -53,6 +53,8 @@ const (
defaultChunksPerTF = 256 * 1024
)
const defaultInitialCommitMessage = "Initialize data repository"
// LocalDirDoltDB stores the db in the current directory
var LocalDirDoltDB = "file://./" + dbfactory.DoltDataDir
@@ -140,11 +142,14 @@ func (ddb *DoltDB) CSMetricsSummary() string {
return datas.GetCSStatSummaryForDB(ddb.db)
}
// CommitMetaGenerator is an interface that generates a sequence of CommitMeta structs, and implements a predicate to check whether
// a proposed commit is acceptable.
type CommitMetaGenerator interface {
next() (*datas.CommitMeta, error)
isGoodHash(hash.Hash) bool
}
// The default implementation of CommitMetaGenerator, which generates a single commit which is always acceptable.
type simpleCommitMetaGenerator struct {
name, email string
timestamp time.Time
@@ -159,8 +164,6 @@ func (simpleCommitMetaGenerator) isGoodHash(hash.Hash) bool {
return true
}
const defaultInitialCommitMessage = "Initialize data repository"
func MakeCommitMetaGenerator(name, email string, timestamp time.Time) CommitMetaGenerator {
return simpleCommitMetaGenerator{name: name, email: email, timestamp: timestamp, message: defaultInitialCommitMessage}
}