Documentation
¶
Index ¶
- func AvailableDatabases() []string
- func New(name string, dbPath string, readOnly bool, config []byte, gatherer interface{}, ...) (database.Database, error)
- func NewFromConfig(cfg DatabaseConfig) (database.Database, error)
- func RegisterDatabase(name string, factory DatabaseFactory)
- type DatabaseConfig
- type DatabaseFactory
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AvailableDatabases ¶ added in v1.2.14
func AvailableDatabases() []string
AvailableDatabases returns the list of available database types
func New ¶
func New( name string, dbPath string, readOnly bool, config []byte, gatherer interface{}, logger log.Logger, metricsPrefix string, meterDBRegName string, ) (database.Database, error)
New creates a new database with the provided configuration
func NewFromConfig ¶ added in v1.0.3
func NewFromConfig(cfg DatabaseConfig) (database.Database, error)
NewFromConfig creates a new database from a DatabaseConfig
func RegisterDatabase ¶ added in v1.2.14
func RegisterDatabase(name string, factory DatabaseFactory)
RegisterDatabase registers a database factory for a given name
Types ¶
type DatabaseConfig ¶ added in v1.0.3
type DatabaseConfig struct {
Type string
Dir string
Name string
ReadOnly bool
Config []byte
MetricsReg prometheus.Registerer
Logger log.Logger
MetricsPrefix string
MeterDBRegName string
}
DatabaseConfig is a convenience struct for database configuration
type DatabaseFactory ¶ added in v1.2.14
type DatabaseFactory func( dbPath string, config []byte, logger log.Logger, registerer prometheus.Registerer, metricsPrefix string, readOnly bool, ) (database.Database, error)
DatabaseFactory is a function that creates a database
Source Files
Click to show internal directories.
Click to hide internal directories.