package storage import ( "context" "github.com/boltdb/bolt" "github.com/pkg/errors" ) // Transactor is used to finalize an active transaction. type Transactor interface { // Commit commits any changes made during the transaction. Commit() error // Rollback rolls back any changes made during the transaction. Rollback() error } // Active hold the metadata for an active snapshot transaction. The ParentIDs // hold the snapshot identifiers for the committed snapshots this active is // based on. The ParentIDs are ordered from the lowest base to highest, meaning // they should be applied in order from the first index to the last index. The // last index should always be considered the active snapshots immediate parent. type Active struct { ID string ParentIDs []string Readonly bool } // MetaStore is used to store metadata related to a snapshot driver. The // MetaStore is intended to store metadata related to name, state and // parentage. Using the MetaStore is not required to implement a snapshot // driver but can be used to handle the persistence and transactional // complexities of a driver implementation. type MetaStore struct { dbfile string } // NewMetaStore returns a snapshot MetaStore for storage of metadata related to // a snapshot driver backed by a bolt file database. This implementation is // strongly consistent and does all metadata changes in a transaction to prevent // against process crashes causing inconsistent metadata state. func NewMetaStore(dbfile string) (*MetaStore, error) { return &MetaStore{ dbfile: dbfile, }, nil } type transactionKey struct{} // TransactionContext creates a new transaction context. func (ms *MetaStore) TransactionContext(ctx context.Context, writable bool) (context.Context, Transactor, error) { db, err := bolt.Open(ms.dbfile, 0600, nil) if err != nil { return ctx, nil, errors.Wrap(err, "failed to open database file") } tx, err := db.Begin(writable) if err != nil { return ctx, nil, errors.Wrap(err, "failed to start transaction") } t := &boltFileTransactor{ db: db, tx: tx, } ctx = context.WithValue(ctx, transactionKey{}, t) return ctx, t, nil }