db

package
v0.0.0-...-3c05ffe Latest Latest
Warning

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

 Go to latest Published: Mar 12, 2018 License: MIT Imports: 22 Imported by: 5

Documentation

Index

Constants

View Source 
const (
	// DefaultDatabaseConfigFile databases definition
	DefaultDatabaseConfigFile = "database.xml"
)
View Source 
const (
	// DefaultSparrowConfigFile is the default configuration file
	DefaultSparrowConfigFile = "sparrow.xml"
)
View Source 
const (
	// FolderCommitlog keeps default commitlog folder name
	FolderCommitlog = "commitlog"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Commitlog 

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

Commitlog holds commitlog information

func NewCommitLog 

func NewCommitLog(path string) *Commitlog

NewCommitLog returns new Commitlog

func (*Commitlog) Add 

func (c *Commitlog) Add(key string, status uint16, rev uint32, bs *util.ByteStream) error

Add add entry to commitlog

func (*Commitlog) Get 

func (c *Commitlog) Get(key string) *util.ByteStream

Get returns ByteStream with requested data, nil if not found

func (*Commitlog) GetByHash 

func (c *Commitlog) GetByHash(hKey uint32) *util.ByteStream

GetByHash returns ByteStream with requested data, nil if not found

func (*Commitlog) GetSummary 

func (c *Commitlog) GetSummary() index.Summary

GetSummary returns commitlog index

func (*Commitlog) Keys 

func (c *Commitlog) Keys() []string

Keys return all data keys from commitlog

func (*Commitlog) LoadData 

func (c *Commitlog) LoadData()

LoadData loads commitlog data file

func (*Commitlog) RenameTo 

func (c *Commitlog) RenameTo(newpath string)

RenameTo rename commitlog file

func (*Commitlog) Size 

func (c *Commitlog) Size() (int64, error)

Size returns commitlog file size

type DBManager 

type DBManager struct {
	Config *SparrowConfig
	// contains filtered or unexported fields
}

DBManager holds all databases

func NewDBManager 

func NewDBManager(config *SparrowConfig, dbConfig *DatabaseConfig) *DBManager

NewDBManager returns new DBManager

func (*DBManager) CreateDatabase 

func (dbm *DBManager) CreateDatabase(descriptor DatabaseDescriptor) error

CreateDatabase create database

func (*DBManager) DropDatabase 

func (dbm *DBManager) DropDatabase(dbname string) error

DropDatabase drop database

func (*DBManager) GetData 

func (dbm *DBManager) GetData(dbname string, strKey string) <-chan *model.DataDefinition

GetData returns pointer to DataDefinition and bool if found the data

func (*DBManager) GetDatabase 

func (dbm *DBManager) GetDatabase(dbname string) (*Database, bool)

GetDatabase returns database by database name

func (*DBManager) GetDatabasesNames 

func (dbm *DBManager) GetDatabasesNames() []string

GetDatabasesNames returns all databases names

func (*DBManager) LoadDatabases 

func (dbm *DBManager) LoadDatabases()

LoadDatabases loads databases from disk

func (*DBManager) Start 

func (dbm *DBManager) Start()

Start starts db manager

func (*DBManager) Stop 

func (dbm *DBManager) Stop()

Stop checks and stops all databases

type DataHolder 

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

DataHolder definitive data file after commitlog flush

func NewDataHolder 

func NewDataHolder(sto *engine.Storage, dbPath string, bloomFilterFp float32) (*DataHolder, error)

NewDataHolder returns new DataHolder pointer

func OpenDataHolder 

func OpenDataHolder(path string) (*DataHolder, error)

OpenDataHolder opens data holder for a given path

func (*DataHolder) Get 

func (d *DataHolder) Get(position int64) (*util.ByteStream, error)

Get get ByteStream from dataholder for a given position in data file

func (*DataHolder) GetSummary 

func (d *DataHolder) GetSummary() index.Summary

GetSummary get index summary of current data gile

type Database 

type Database struct {
	Descriptor DatabaseDescriptor
	// contains filtered or unexported fields
}

Database holds database definitions

func NewDatabase 

func NewDatabase(descriptor DatabaseDescriptor) *Database

NewDatabase returns new Database

func OpenDatabase 

func OpenDatabase(descriptor DatabaseDescriptor) *Database

OpenDatabase returns oppened Database

func (*Database) Close 

func (db *Database) Close()

Close closes databases

func (*Database) GetDataByIndexEntry 

func (db *Database) GetDataByIndexEntry(dhIdx int, entry *index.Entry) (*model.DataDefinition, bool)

GetDataByIndexEntry get the image in data holder passing its index

func (*Database) GetDataByKey 

func (db *Database) GetDataByKey(key string) (*model.DataDefinition, bool)

GetDataByKey returns pointer to DataDefinition, bool if found the data and if found in data holder, return data holder index array, or if found in cache or commitlog return -1

func (*Database) GetDataIndexByKey 

func (db *Database) GetDataIndexByKey(hkey uint32) (*index.Entry, int, bool)

GetDataIndexByKey search key in index, returns the index entry, data holder index or -1 if the key is in commitlog and bool if found.

func (*Database) Info 

func (db *Database) Info() DatabaseInfo

Info returns information about database

func (*Database) InsertCheckUpsert 

func (db *Database) InsertCheckUpsert(df *model.DataDefinition, upsert bool) (uint32, error)

InsertCheckUpsert if df not exists insert it. If exits and is upsert, override old data

func (*Database) InsertData 

func (db *Database) InsertData(df *model.DataDefinition) error

InsertData insert data into database

func (*Database) Keys 

func (db *Database) Keys() []string

Keys returns all data keys from database

func (*Database) LoadData 

func (db *Database) LoadData()

LoadData loads index and bloom filter from each data file

type DatabaseConfig 

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

DatabaseConfig holds general configuration of database

func NewDatabaseConfig 

func NewDatabaseConfig(filePath string) *DatabaseConfig

NewDatabaseConfig return configuration from file

func (*DatabaseConfig) DropDatabase 

func (cfg *DatabaseConfig) DropDatabase(dbname string)

DropDatabase saves without database into the XML file

func (*DatabaseConfig) LoadDatabases 

func (cfg *DatabaseConfig) LoadDatabases() []DatabaseDescriptor

LoadDatabases load DatabaseConfigNode from XML file

func (*DatabaseConfig) SaveDatabase 

func (cfg *DatabaseConfig) SaveDatabase(database DatabaseDescriptor)

SaveDatabase saves DatabaseDescriptor into the XML file

type DatabaseDescriptor 

type DatabaseDescriptor struct {
	XMLName        xml.Name `xml:"database"`
	Name           string   `xml:"name" valid:"alphanum,required,length(3|50)"`
	MaxDataLogSize uint64   `xml:"max_datalog_size"`
	MaxCacheSize   uint64   `xml:"max_cache_size"`
	BloomFilterFp  float32  `xml:"bloomfilter_fpp"`
	CronExp        string   `xml:"dataholder_cron_compaction"`
	Path           string   `xml:"path"`
	SnapshotPath   string   `xml:"snapshot_path"`
	TokenActive    bool     `xml:"generate_token"`
	ReadOnly       bool     `xml:"read_only"`
}

DatabaseDescriptor holds database configuration

func (*DatabaseDescriptor) ToJSON 

func (dd *DatabaseDescriptor) ToJSON() []byte

ToJSON returns DatabaseDescriptor as JSON

type DatabaseInfo 

type DatabaseInfo struct {
	DhCount       int   `json:"datafile_count"`
	CommitlogSize int64 `json:"commitlog_size"`
	CacheItems    int64 `json:"cache_item_count"`
	CacheUsed     int64 `json:"cache_used_bytes"`
}

DatabaseInfo returns database information

type SparrowConfig 

type SparrowConfig struct {
	NodeName             string  `xml:"node_name"`
	HTTPPort             string  `xml:"http_port"`
	HTTPHost             string  `xml:"http_host"`
	AdminPort            string  `xml:"admin_port"`
	AdminHost            string  `xml:"admin_host"`
	ReadOnly             bool    `xml:"read_only"`
	MaxDataLogSize       uint64  `xml:"max_datalog_size"`
	MaxCacheSize         uint64  `xml:"max_cache_size"`
	BloomFilterFp        float32 `xml:"bloomfilter_fpp"`
	CronExp              string  `xml:"dataholder_cron_compaction"`
	Path                 string  `xml:"data_file_directory"`
	SnapshotPath         string  `xml:"snapshot_path"`
	TokenActive          bool    `xml:"generate_token"`
	AuthenticationActive bool    `xml:"enable_authentication"`
	UserExpire           int     `xml:"user_expire"`
	EnableWebUI          bool    `xml:"enable_webui"`
}

SparrowConfig holds general configuration of SparrowDB

func NewSparrowConfig 

func NewSparrowConfig(filePath string) *SparrowConfig

NewSparrowConfig return configuration from file

type XMLDatabaseList 

type XMLDatabaseList struct {
	XMLName   xml.Name             `xml:"databases"`
	Databases []DatabaseDescriptor `xml:"database"`
}

XMLDatabaseList holds root node and DatabaseDescriptor list

Source Files

View all Source files

Directories

Path Synopsis

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.