storage

Documentation

Index

• type BlockDatabase
  • func NewBlockDatabase(storageSnapshot snapshot.StorageSnapshot, snapshotTime logical.Time, ...) *BlockDatabase
  • func (database *BlockDatabase) NewCachingSnapshotReadTransaction(parameters state.StateParameters) (Transaction, error)
  • func (database *BlockDatabase) NewSnapshotReadTransaction(parameters state.StateParameters) Transaction
  • func (database *BlockDatabase) NewTransaction(executionTime logical.Time, parameters state.StateParameters) (Transaction, error)
• type Transaction
• type TransactionPreparer

Types

type BlockDatabase

type BlockDatabase struct {
	*primary.BlockData
	*derived.DerivedBlockData
}

BlockDatabase packages the primary index (BlockData) and secondary indices (DerivedBlockData) into a single database via 2PC.

func NewBlockDatabase

func NewBlockDatabase(
	storageSnapshot snapshot.StorageSnapshot,
	snapshotTime logical.Time,
	cachedDerivedBlockData *derived.DerivedBlockData,
) *BlockDatabase

NOTE: storageSnapshot must be thread safe.

func (*BlockDatabase) NewCachingSnapshotReadTransaction

func (database *BlockDatabase) NewCachingSnapshotReadTransaction(
	parameters state.StateParameters,
) (Transaction, error)

NewCachingSnapshotReadTransaction creates a new readonly transaction that allows writing to the derived transaction data table.

func (*BlockDatabase) NewSnapshotReadTransaction

func (database *BlockDatabase) NewSnapshotReadTransaction(
	parameters state.StateParameters,
) Transaction

NewSnapshotReadTransaction creates a new readonly transaction.

func (*BlockDatabase) NewTransaction

func (database *BlockDatabase) NewTransaction(
	executionTime logical.Time,
	parameters state.StateParameters,
) (
	Transaction,
	error,
)

type Transaction

type Transaction interface {
	TransactionPreparer

	// SnapshotTime returns the transaction's current snapshot time.
	SnapshotTime() logical.Time

	// Finalize convert transaction preparer's intermediate state into
	// committable state.
	Finalize() error

	// Validate returns nil if the transaction does not conflict with
	// previously committed transactions.  It returns an error otherwise.
	Validate() error

	// Commit commits the transaction.  If the transaction conflict with
	// previously committed transactions, an error is returned and the
	// transaction is not committed.
	Commit() (*snapshot.ExecutionSnapshot, error)
}

type TransactionPreparer

type TransactionPreparer interface {
	state.NestedTransactionPreparer
	derived.DerivedTransactionPreparer
}