storagenodedb

Documentation

Index

• Constants
• Variables
• func Schema() map[string]*dbschema.Schema
• type Config
  • func (config Config) LazyFilewalkerConfig() lazyfilewalker.Config
• type DB
  • func OpenExisting(ctx context.Context, log *zap.Logger, config Config) (*DB, error)
  • func OpenNew(ctx context.Context, log *zap.Logger, config Config) (*DB, error)
  • func (db *DB) APIKeys() apikeys.DB
  • func (db *DB) Bandwidth() bandwidth.DB
  • func (db *DB) CheckVersion(ctx context.Context) error
  • func (db *DB) Close() error
  • func (db *DB) Config() Config
  • func (db *DB) DBDirectory() string
  • func (db *DB) GCFilewalkerProgress() pieces.GCFilewalkerProgressDB
  • func (db *DB) MigrateToLatest(ctx context.Context) error
  • func (db *DB) Migration(ctx context.Context) *migrate.Migration
  • func (db *DB) Notifications() notifications.DB
  • func (db *DB) Orders() orders.DB
  • func (db *DB) Payout() payouts.DB
  • func (db *DB) PieceExpirationDB() pieces.PieceExpirationDB
  • func (db *DB) PieceSpaceUsedDB() pieces.PieceSpaceUsedDB
  • func (db *DB) Pieces() blobstore.Blobs
  • func (db *DB) Preflight(ctx context.Context) (err error)
  • func (db *DB) Pricing() pricing.DB
  • func (db *DB) RawDatabases() map[string]DBContainer
  • func (db *DB) Reputation() reputation.DB
  • func (db *DB) Satellites() satellites.DB
  • func (db *DB) StorageUsage() storageusage.DB
  • func (db *DB) UsedSpacePerPrefix() pieces.UsedSpacePerPrefixDB
  • func (db *DB) V0PieceInfo() pieces.V0PieceInfoDB
• type DBContainer

Constants

const APIKeysDBName = "secret"

APIKeysDBName represents the database name.

const BandwidthDBName = "bandwidth"

BandwidthDBName represents the database name.

const DeprecatedInfoDBName = "info"

DeprecatedInfoDBName represents the database name.

const GCFilewalkerProgressDBName = "garbage_collection_filewalker_progress"

GCFilewalkerProgressDBName represents the database name.

const HeldAmountDBName = "heldamount"

HeldAmountDBName represents the database name.

const NotificationsDBName = "notifications"

NotificationsDBName represents the database name.

const OrdersDBName = "orders"

OrdersDBName represents the database name.

const PieceExpirationDBName = "piece_expiration"

PieceExpirationDBName represents the database filename.

const PieceInfoDBName = "pieceinfo"

PieceInfoDBName represents the database name.

const PieceSpaceUsedDBName = "piece_spaced_used"

PieceSpaceUsedDBName represents the database name.

const PricingDBName = "pricing"

PricingDBName represents the database name.

const ReputationDBName = "reputation"

ReputationDBName represents the database name.

const SatellitesDBName = "satellites"

SatellitesDBName represents the database name.

const StorageUsageDBName = "storage_usage"

StorageUsageDBName represents the database name.

const UsedSerialsDBName = "used_serial"

UsedSerialsDBName represents the database name.

const UsedSpacePerPrefixDBName = "used_space_per_prefix"

UsedSpacePerPrefixDBName represents the database name.

const VersionTable = "versions"

VersionTable is the table that stores the version info in each db.

Variables

var (

	// ErrDatabase represents errors from the databases.
	ErrDatabase = errs.Class("database")
	// ErrNoRows represents database error if rows weren't affected.
	ErrNoRows = errs.New("no rows affected")
	// ErrPreflight represents an error during the preflight check.
	ErrPreflight = errs.Class("preflight")
)

var (
	// ErrPieceExpiration represents errors from the piece expiration database.
	ErrPieceExpiration = errs.Class("pieceexpirationdb")

	// MaxPieceExpirationBufferSize is the maximum number of pieces that can be stored in the buffer before
	// they are written to the database.
	MaxPieceExpirationBufferSize = 1000 // TODO: make this configurable and set it at the top level.
)

var ErrAPIKeysDB = errs.Class("apikeysdb")

ErrAPIKeysDB represents errors from the api keys database.

var ErrBandwidth = errs.Class("bandwidthdb")

ErrBandwidth represents errors from the bandwidthdb database.

var (
	// ErrGCProgress represents errors from the filewalker database.
	ErrGCProgress = errs.Class("gc_filewalker_progress_db")
)

var ErrNotificationsDB = errs.Class("notificationsdb")

ErrNotificationsDB represents errors from the notifications database.

var ErrOrders = errs.Class("ordersdb")

ErrOrders represents errors from the ordersdb database.

var ErrPayout = errs.Class("payouts")

ErrPayout represents errors from the payouts database.

var ErrPieceInfo = errs.Class("v0pieceinfodb")

ErrPieceInfo represents errors from the piece info database.

var ErrPieceSpaceUsed = errs.Class("piece space used")

ErrPieceSpaceUsed represents errors from the piece spaced used database.

var ErrPricing = errs.Class("pricing")

ErrPricing represents errors from the pricing database.

var ErrReputation = errs.Class("reputation")

ErrReputation represents errors from the reputation database.

var ErrSatellitesDB = errs.Class("satellitesdb")

ErrSatellitesDB represents errors from the satellites database.

var ErrUsedSpacePerPrefix = errs.Class("used_space_per_prefix_db")

ErrUsedSpacePerPrefix represents errors from the used space per prefix database.

Functions

func Schema

func Schema() map[string]*dbschema.Schema

Types

type Config

type Config struct {
	// TODO: figure out better names
	Storage   string
	Cache     string
	Info      string
	Info2     string
	Driver    string // if unset, uses sqlite3
	Pieces    string
	Filestore filestore.Config

	TestingDisableWAL bool
}

Config configures storage node database.

func (Config) LazyFilewalkerConfig

func (config Config) LazyFilewalkerConfig() lazyfilewalker.Config

LazyFilewalkerConfig creates a lazyfilewalker.Config from storagenodedb.Config.

TODO: this is a temporary solution to avoid circular dependencies.

type DB

type DB struct {
	SQLDBs map[string]DBContainer
	// contains filtered or unexported fields
}

DB contains access to different database tables.

func OpenExisting

func OpenExisting(ctx context.Context, log *zap.Logger, config Config) (*DB, error)

OpenExisting opens an existing master database for storage node.

func OpenNew

func OpenNew(ctx context.Context, log *zap.Logger, config Config) (*DB, error)

OpenNew creates a new master database for storage node.

func (*DB) APIKeys

func (db *DB) APIKeys() apikeys.DB

APIKeys returns instance of the APIKeys database.

func (*DB) Bandwidth

func (db *DB) Bandwidth() bandwidth.DB

Bandwidth returns the instance of the Bandwidth database.

func (*DB) CheckVersion

func (db *DB) CheckVersion(ctx context.Context) error

CheckVersion that the version of the migration matches the state of the database.

func (*DB) Close

func (db *DB) Close() error

Close closes any resources.

func (*DB) Config

func (db *DB) Config() Config

Config returns the database configuration used to initialize the database.

func (*DB) DBDirectory

func (db *DB) DBDirectory() string

DBDirectory returns the database directory for testing purposes.

func (*DB) GCFilewalkerProgress

func (db *DB) GCFilewalkerProgress() pieces.GCFilewalkerProgressDB

GCFilewalkerProgress returns the instance of the GCFilewalkerProgress database.

func (*DB) MigrateToLatest

func (db *DB) MigrateToLatest(ctx context.Context) error

MigrateToLatest creates any necessary tables.

func (*DB) Migration

func (db *DB) Migration(ctx context.Context) *migrate.Migration

Migration returns table migrations.

func (*DB) Notifications

func (db *DB) Notifications() notifications.DB

Notifications returns the instance of the Notifications database.

func (*DB) Orders

func (db *DB) Orders() orders.DB

Orders returns the instance of the Orders database.

func (*DB) Payout

func (db *DB) Payout() payouts.DB

Payout returns instance of the SnoPayout database.

func (*DB) PieceExpirationDB

func (db *DB) PieceExpirationDB() pieces.PieceExpirationDB

PieceExpirationDB returns the instance of the PieceExpiration database.

func (*DB) PieceSpaceUsedDB

func (db *DB) PieceSpaceUsedDB() pieces.PieceSpaceUsedDB

PieceSpaceUsedDB returns the instance of the PieceSpacedUsed database.

func (*DB) Pieces

func (db *DB) Pieces() blobstore.Blobs

Pieces returns blob storage for pieces.

func (*DB) Preflight

func (db *DB) Preflight(ctx context.Context) (err error)

Preflight conducts a pre-flight check to ensure correct schemas and minimal read+write functionality of the database tables.

func (*DB) Pricing

func (db *DB) Pricing() pricing.DB

Pricing returns instance of the Pricing database.

func (*DB) RawDatabases

func (db *DB) RawDatabases() map[string]DBContainer

RawDatabases are required for testing purposes.

func (*DB) Reputation

func (db *DB) Reputation() reputation.DB

Reputation returns the instance of the Reputation database.

func (*DB) Satellites

func (db *DB) Satellites() satellites.DB

Satellites returns the instance of the Satellites database.

func (*DB) StorageUsage

func (db *DB) StorageUsage() storageusage.DB

StorageUsage returns the instance of the StorageUsage database.

func (*DB) UsedSpacePerPrefix

func (db *DB) UsedSpacePerPrefix() pieces.UsedSpacePerPrefixDB

UsedSpacePerPrefix returns the instance of the UsedSpacePerPrefix database.

func (*DB) V0PieceInfo

func (db *DB) V0PieceInfo() pieces.V0PieceInfoDB

V0PieceInfo returns the instance of the V0PieceInfoDB database.

type DBContainer

type DBContainer interface {
	Configure(sqlDB tagsql.DB)
	GetDB() tagsql.DB
}

DBContainer defines an interface to allow accessing and setting a SQLDB.