stores

package
v0.1.0-beta Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 1, 2023 License: MIT Imports: 32 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrHostNotFound   = errors.New("host doesn't exist in hostdb")
	ErrNegativeOffset = errors.New("offset can not be negative")
)
View Source 
var (
	// ErrSlabNotFound is returned if get is unable to retrieve a slab from the
	// database.
	ErrSlabNotFound = errors.New("slab not found in database")

	// ErrContractNotFound is returned when a contract can't be retrieved from
	// the database.
	ErrContractNotFound = errors.New("couldn't find contract")

	// ErrContractSetNotFound is returned when a contract can't be retrieved
	// from the database.
	ErrContractSetNotFound = errors.New("couldn't find contract set")
)

Functions

func DBConfigFromEnv 

func DBConfigFromEnv() (uri, user, password, dbName string)

func NewEphemeralSQLiteConnection 

func NewEphemeralSQLiteConnection(name string) gorm.Dialector

NewEphemeralSQLiteConnection creates a connection to an in-memory SQLite DB. NOTE: Use simple names such as a random hex identifier or the filepath.Base of a test's name. Certain symbols will break the cfg string and cause a file to be created on disk. 

mode: set to memory for in-memory database
cache: set to shared which is required for in-memory databases
_foreign_keys: enforce foreign_key relations

func NewMySQLConnection 

func NewMySQLConnection(user, password, addr, dbName string) gorm.Dialector

NewMySQLConnection creates a connection to a MySQL database.

func NewSQLLogger 

func NewSQLLogger(l *zap.Logger, config *LoggerConfig) logger.Interface

func NewSQLiteConnection 

func NewSQLiteConnection(path string) gorm.Dialector

NewSQLiteConnection opens a sqlite db at the given path. 

_busy_timeout: set to prevent concurrent transactions from failing and
  instead have them block
_foreign_keys: enforce foreign_key relations
_journal_mode: set to WAL instead of delete since it's usually the fastest.
  Only downside is that the db won't work on network drives. In that case this
  should be made configurable and set to TRUNCATE or any of the other options.
  For reference see https://github.com/mattn/go-sqlite3#connection-string.

Types

type ContractCommon 

type ContractCommon struct {
	FCID        fileContractID `gorm:"unique;index;NOT NULL;column:fcid;size:32"`
	RenewedFrom fileContractID `gorm:"index;size:32"`

	TotalCost      currency
	ProofHeight    uint64 `gorm:"index;default:0"`
	RevisionHeight uint64 `gorm:"index;default:0"`
	RevisionNumber string `gorm:"NOT NULL;default:'0'"` // string since db can't store math.MaxUint64
	StartHeight    uint64 `gorm:"index;NOT NULL"`
	WindowStart    uint64 `gorm:"index;NOT NULL;default:0"`
	WindowEnd      uint64 `gorm:"index;NOT NULL;default:0"`

	// spending fields
	UploadSpending      currency
	DownloadSpending    currency
	FundAccountSpending currency
}

type EphemeralAutopilotStore 

type EphemeralAutopilotStore struct {
	// contains filtered or unexported fields
}

EphemeralAutopilotStore implements autopilot.Store in memory.

func NewEphemeralAutopilotStore 

func NewEphemeralAutopilotStore() *EphemeralAutopilotStore

NewEphemeralAutopilotStore returns a new EphemeralAutopilotStore.

func (*EphemeralAutopilotStore) Config 

func (s *EphemeralAutopilotStore) Config() api.AutopilotConfig

Config implements autopilot.Store.

func (*EphemeralAutopilotStore) ProcessConsensusChange 

func (s *EphemeralAutopilotStore) ProcessConsensusChange(cc modules.ConsensusChange)

ProcessConsensusChange implements chain.Subscriber.

func (*EphemeralAutopilotStore) SetConfig 

func (s *EphemeralAutopilotStore) SetConfig(c api.AutopilotConfig) error

SetConfig implements autopilot.Store.

type EphemeralWalletStore 

type EphemeralWalletStore struct {
	// contains filtered or unexported fields
}

EphemeralWalletStore implements wallet.SingleAddressStore in memory.

func NewEphemeralWalletStore 

func NewEphemeralWalletStore(addr types.Address) *EphemeralWalletStore

NewEphemeralWalletStore returns a new EphemeralWalletStore.

func (*EphemeralWalletStore) Balance 

func (s *EphemeralWalletStore) Balance() (sc types.Currency)

Balance implements wallet.SingleAddressStore.

func (*EphemeralWalletStore) ProcessConsensusChange 

func (s *EphemeralWalletStore) ProcessConsensusChange(cc modules.ConsensusChange)

ProcessConsensusChange implements modules.ConsensusSetSubscriber.

func (*EphemeralWalletStore) Transactions 

func (s *EphemeralWalletStore) Transactions(since time.Time, max int) ([]wallet.Transaction, error)

Transactions implements wallet.SingleAddressStore.

func (*EphemeralWalletStore) UnspentSiacoinElements 

func (s *EphemeralWalletStore) UnspentSiacoinElements() ([]wallet.SiacoinElement, error)

UnspentSiacoinElements implements wallet.SingleAddressStore.

type JSONAutopilotStore 

type JSONAutopilotStore struct {
	*EphemeralAutopilotStore
	// contains filtered or unexported fields
}

JSONAutopilotStore implements autopilot.Store in memory, backed by a JSON file.

func NewJSONAutopilotStore 

func NewJSONAutopilotStore(dir string) (*JSONAutopilotStore, error)

NewJSONAutopilotStore returns a new JSONAutopilotStore.

func (*JSONAutopilotStore) SetConfig 

func (s *JSONAutopilotStore) SetConfig(c api.AutopilotConfig) error

SetConfig implements autopilot.Store.

type JSONWalletStore 

type JSONWalletStore struct {
	*EphemeralWalletStore
	// contains filtered or unexported fields
}

JSONWalletStore implements wallet.SingleAddressStore in memory, backed by a JSON file.

func NewJSONWalletStore 

func NewJSONWalletStore(dir string, addr types.Address) (*JSONWalletStore, modules.ConsensusChangeID, error)

NewJSONWalletStore returns a new JSONWalletStore.

func (*JSONWalletStore) ProcessConsensusChange 

func (s *JSONWalletStore) ProcessConsensusChange(cc modules.ConsensusChange)

ProcessConsensusChange implements chain.Subscriber.

type LoggerConfig 

type LoggerConfig struct {
	IgnoreRecordNotFoundError bool
	LogLevel                  logger.LogLevel
	SlowThreshold             time.Duration
}

type Model 

type Model struct {
	ID        uint `gorm:"primarykey"`
	CreatedAt time.Time
}

Model defines the common fields of every table. Same as Model but excludes soft deletion since it breaks cascading deletes.

type SQLStore 

type SQLStore struct {
	// contains filtered or unexported fields
}

SQLStore is a helper type for interacting with a SQL-based backend.

func NewSQLStore 

func NewSQLStore(conn gorm.Dialector, migrate bool, persistInterval time.Duration, logger glogger.Interface) (*SQLStore, modules.ConsensusChangeID, error)

NewSQLStore uses a given Dialector to connect to a SQL database. NOTE: Only pass migrate=true for the first instance of SQLHostDB if you connect via the same Dialector multiple times.

func (*SQLStore) Accounts 

func (s *SQLStore) Accounts(ctx context.Context) ([]api.Account, error)

Accounts returns all accounts from the db.

func (*SQLStore) ActiveContracts 

func (s *SQLStore) ActiveContracts(ctx context.Context) ([]api.ContractMetadata, error)

func (*SQLStore) AddContract 

func (s *SQLStore) AddContract(ctx context.Context, c rhpv2.ContractRevision, totalCost types.Currency, startHeight uint64) (_ api.ContractMetadata, err error)

func (*SQLStore) AddRenewedContract 

func (s *SQLStore) AddRenewedContract(ctx context.Context, c rhpv2.ContractRevision, totalCost types.Currency, startHeight uint64, renewedFrom types.FileContractID) (api.ContractMetadata, error)

AddRenewedContract adds a new contract which was created as the result of a renewal to the store. The old contract specified as 'renewedFrom' will be deleted from the active contracts and moved to the archive. Both new and old contract will be linked to each other through the RenewedFrom and RenewedTo fields respectively.

func (*SQLStore) AncestorContracts 

func (s *SQLStore) AncestorContracts(ctx context.Context, id types.FileContractID, startHeight uint64) ([]api.ArchivedContract, error)

func (*SQLStore) Close 

func (s *SQLStore) Close() error

Close closes the underlying database connection of the store.

func (*SQLStore) Contract 

func (s *SQLStore) Contract(ctx context.Context, id types.FileContractID) (api.ContractMetadata, error)

func (*SQLStore) ContractSets 

func (s *SQLStore) ContractSets(ctx context.Context) ([]string, error)

func (*SQLStore) Contracts 

func (s *SQLStore) Contracts(ctx context.Context, set string) ([]api.ContractMetadata, error)

func (*SQLStore) DeleteContractSet 

func (s *SQLStore) DeleteContractSet(ctx context.Context, name string) error

func (*SQLStore) DeleteSetting 

func (s *SQLStore) DeleteSetting(ctx context.Context, key string) error

DeleteSetting implements the bus.SettingStore interface.

func (*SQLStore) Host 

func (ss *SQLStore) Host(ctx context.Context, hostKey types.PublicKey) (hostdb.HostInfo, error)

Host returns information about a host.

func (*SQLStore) HostAllowlist 

func (ss *SQLStore) HostAllowlist(ctx context.Context) (allowlist []types.PublicKey, err error)

func (*SQLStore) HostBlocklist 

func (ss *SQLStore) HostBlocklist(ctx context.Context) (blocklist []string, err error)

func (*SQLStore) Hosts 

func (ss *SQLStore) Hosts(ctx context.Context, offset, limit int) ([]hostdb.Host, error)

Hosts returns non-blocked hosts at given offset and limit.

func (*SQLStore) HostsForScanning 

func (ss *SQLStore) HostsForScanning(ctx context.Context, maxLastScan time.Time, offset, limit int) ([]hostdb.HostAddress, error)

HostsForScanning returns the address of hosts for scanning.

func (*SQLStore) Object 

func (s *SQLStore) Object(ctx context.Context, key string) (object.Object, error)

func (*SQLStore) ObjectEntries 

func (s *SQLStore) ObjectEntries(ctx context.Context, path, prefix string, offset, limit int) ([]string, error)

func (*SQLStore) ObjectsStats 

func (s *SQLStore) ObjectsStats(ctx context.Context) (api.ObjectsStats, error)

ObjectsStats returns some info related to the objects stored in the store. To reduce locking and make sure all results are consistent, everything is done within a single transaction.

func (*SQLStore) ProcessConsensusChange 

func (ss *SQLStore) ProcessConsensusChange(cc modules.ConsensusChange)

ProcessConsensusChange implements consensus.Subscriber.

func (*SQLStore) RecordContractSpending 

func (s *SQLStore) RecordContractSpending(ctx context.Context, records []api.ContractSpendingRecord) error

func (*SQLStore) RecordInteractions 

func (ss *SQLStore) RecordInteractions(ctx context.Context, interactions []hostdb.Interaction) error

RecordHostInteraction records an interaction with a host. If the host is not in the store, a new entry is created for it.

func (*SQLStore) RemoveContract 

func (s *SQLStore) RemoveContract(ctx context.Context, id types.FileContractID) error

func (*SQLStore) RemoveContracts 

func (s *SQLStore) RemoveContracts(ctx context.Context) error

func (*SQLStore) RemoveObject 

func (s *SQLStore) RemoveObject(ctx context.Context, key string) error

func (*SQLStore) RemoveOfflineHosts 

func (ss *SQLStore) RemoveOfflineHosts(ctx context.Context, minRecentFailures uint64, maxDowntime time.Duration) (removed uint64, err error)

func (*SQLStore) SaveAccounts 

func (s *SQLStore) SaveAccounts(ctx context.Context, accounts []api.Account) error

SaveAccounts saves the given accounts in the db, overwriting any existing ones.

func (*SQLStore) SearchHosts 

func (ss *SQLStore) SearchHosts(ctx context.Context, filterMode, addressContains string, keyIn []types.PublicKey, offset, limit int) ([]hostdb.Host, error)

func (*SQLStore) SearchObjects 

func (s *SQLStore) SearchObjects(ctx context.Context, substring string, offset, limit int) ([]string, error)

func (*SQLStore) SetContractSet 

func (s *SQLStore) SetContractSet(ctx context.Context, name string, contractIds []types.FileContractID) error

func (*SQLStore) Setting 

func (s *SQLStore) Setting(ctx context.Context, key string) (string, error)

Setting implements the bus.SettingStore interface.

func (*SQLStore) Settings 

func (s *SQLStore) Settings(ctx context.Context) ([]string, error)

Settings implements the bus.SettingStore interface.

func (*SQLStore) UnhealthySlabs 

func (s *SQLStore) UnhealthySlabs(ctx context.Context, healthCutoff float64, set string, limit int) ([]object.Slab, error)

UnhealthySlabs returns up to 'limit' slabs that do not reach full redundancy in the given contract set. These slabs need to be migrated to good contracts so they are restored to full health.

func (*SQLStore) UpdateHostAllowlistEntries 

func (ss *SQLStore) UpdateHostAllowlistEntries(ctx context.Context, add, remove []types.PublicKey, clear bool) (err error)

func (*SQLStore) UpdateHostBlocklistEntries 

func (ss *SQLStore) UpdateHostBlocklistEntries(ctx context.Context, add, remove []string, clear bool) (err error)

func (*SQLStore) UpdateObject 

func (s *SQLStore) UpdateObject(ctx context.Context, key string, o object.Object, usedContracts map[types.PublicKey]types.FileContractID) error

func (*SQLStore) UpdateSetting 

func (s *SQLStore) UpdateSetting(ctx context.Context, key, value string) error

UpdateSetting implements the bus.SettingStore interface.

func (*SQLStore) UpdateSlab 

func (ss *SQLStore) UpdateSlab(ctx context.Context, s object.Slab, usedContracts map[types.PublicKey]types.FileContractID) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.