shithub: furgit

ref: 6e917f2b9b6b64721d046d66311aa64589e19d9f
dir: /ref/store/batch.go/

package refstore

import objectid "codeberg.org/lindenii/furgit/object/id"

// Batch stages reference operations for one non-atomic apply.
//
// Unlike Transaction, Batch may reject some queued operations while still
// applying others successfully when Apply runs.
//
// A batch borrows its underlying store and is invalid after that store is
// closed.
type Batch interface {
	// Create creates one detached reference, requiring that the logical
	// reference does not already exist.
	Create(name string, newID objectid.ObjectID)
	// Update updates one detached reference, requiring that the current logical
	// reference value matches oldID.
	Update(name string, newID, oldID objectid.ObjectID)
	// Delete deletes one detached reference, requiring that the current logical
	// reference value matches oldID.
	Delete(name string, oldID objectid.ObjectID)
	// Verify verifies that the current logical reference value matches oldID.
	Verify(name string, oldID objectid.ObjectID)

	// CreateSymbolic creates one symbolic reference, requiring that the named
	// reference does not already exist.
	CreateSymbolic(name, newTarget string)
	// UpdateSymbolic updates one symbolic reference directly, requiring that its
	// current target matches oldTarget.
	UpdateSymbolic(name, newTarget, oldTarget string)
	// DeleteSymbolic deletes one symbolic reference directly, requiring that its
	// current target matches oldTarget.
	DeleteSymbolic(name, oldTarget string)
	// VerifySymbolic verifies that the named symbolic reference currently points
	// at oldTarget.
	VerifySymbolic(name, oldTarget string)

	// Apply validates and applies queued operations, returning one result per
	// queued operation in order. Fatal backend failures are returned separately.
	//
	// Apply is terminal. Further use of the batch is undefined behavior.
	Apply() ([]BatchResult, error)
	// Abort abandons the batch and releases any resources it holds.
	//
	// Abort is terminal. Further use of the batch is undefined behavior.
	Abort() error
}

// BatchStatus reports the outcome for one queued batch operation.
type BatchStatus uint8

const (
	BatchStatusApplied BatchStatus = iota
	BatchStatusRejected
	BatchStatusFatal
	BatchStatusNotAttempted
)

// BatchResult reports the outcome for one queued batch operation.
type BatchResult struct {
	Name   string
	Status BatchStatus
	Error  error
}