mirror/dolt
1
0
Fork 0
mirror of https://github.com/dolthub/dolt.git synced 2026-02-13 19:28:50 -06:00
Code Issues Packages Projects Releases 129 Wiki Activity

Beefing up RevisionDatabase interface docs

Browse Source
This commit is contained in:
Jason Fulghum
2022-08-19 15:07:37 -07:00
parent 6da9ccf116
commit c45a224504
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
go/libraries/doltcore/sqle/dsess/revision_db_provider.go
View File

@@ -42,12 +42,19 @@ type RevisionDatabaseProvider interface {
GetRevisionForRevisionDatabase(ctx *sql.Context, dbName string) (string, string, error)
}
// RevisionDatabase allows callers to query a revision database for the commit, branch, or tag it is pinned to.
// RevisionDatabase allows callers to query a revision database for the commit, branch, or tag it is pinned to. For
// example, when using a database with a branch revision specification, that database is only able to use that branch
// and cannot change branch heads. Calling `Revision` on that database will return the branch name. Similarly, for
// databases using a commit revision spec or a tag revision spec, Revision will return the commit or tag, respectively.
// Currently, only explicit branch names, commit hashes, and tag names are allowed as database revision specs. Other
// refspecs, such as "HEAD~2" are not supported yet.
type RevisionDatabase interface {
// Revision returns the branch or commit to which this revision database is pinned. If there is no pinned revision,
// empty string is returned.
// Revision returns the specific branch, commit, or tag to which this revision database has been pinned. Other
// revision specifications (e.g. "HEAD~2") are not supported. If a database implements RevisionDatabase, but
// is not pinned to a specific revision, the empty string is returned.
Revision() string
}
type DoltDatabaseProvider interface {
sql.DatabaseProvider
RevisionDatabaseProvider