Documentation
¶
Overview ¶
Package database provides the persistence layer for the application.
Index ¶
- Variables
- func Put(db *Database)
- type Database
- func (db *Database) Begin() error
- func (db *Database) BlacklistAdd(item blacklist.Item) error
- func (db *Database) BlacklistGetAll() ([]blacklist.Item, error)
- func (db *Database) BlacklistHit(item blacklist.Item) error
- func (db *Database) Close() error
- func (db *Database) Commit() error
- func (db *Database) FileAdd(f *model.File) error
- func (db *Database) FileDelete(f *model.File) error
- func (db *Database) FileGetAll() ([]*model.File, error)
- func (db *Database) FileGetByID(id int64) (*model.File, error)
- func (db *Database) FileGetByPath(path string) (*model.File, error)
- func (db *Database) FileGetByPattern(pat string) ([]*model.File, error)
- func (db *Database) FileGetNoMeta() ([]*model.File, error)
- func (db *Database) FileUpdateCtime(f *model.File, ctime time.Time) error
- func (db *Database) MetaAdd(m *model.FileMeta) error
- func (db *Database) MetaGetAll() ([]*model.FileMeta, error)
- func (db *Database) MetaGetByFile(f *model.File) (*model.FileMeta, error)
- func (db *Database) MetaGetByRoot(r *model.Root) ([]*model.FileMeta, error)
- func (db *Database) MetaGetOutdated() ([]*model.FileMeta, error)
- func (db *Database) MetaSearch(qstr string) ([]*model.File, error)
- func (db *Database) MetaUpsert(m *model.FileMeta) error
- func (db *Database) PerformMaintenance() error
- func (db *Database) Rollback() error
- func (db *Database) RootAdd(r *model.Root) error
- func (db *Database) RootDelete(r *model.Root) error
- func (db *Database) RootGetAll() ([]*model.Root, error)
- func (db *Database) RootGetByID(id int64) (*model.Root, error)
- func (db *Database) RootGetByPath(path string) (*model.Root, error)
- func (db *Database) RootMarkScan(r *model.Root, timestamp time.Time) error
- func (db *Database) SavepointCreate(name string) error
- func (db *Database) SavepointRelease(name string) error
- func (db *Database) SavepointRollback(name string) error
- type Pool
Constants ¶
This section is empty.
Variables ¶
var ErrEmptyUpdate = errors.New("Update operation does not change any values")
ErrEmptyUpdate indicates that an update operation would not change any values.
var ErrInvalidSavepoint = errors.New("that save point does not exist")
ErrInvalidSavepoint is returned when a user of the Database uses an unkown (or expired) savepoint name.
var ErrInvalidValue = errors.New("Invalid value for parameter")
ErrInvalidValue indicates that one or more parameters passed to a method had values that are invalid for that operation.
var ErrNoTxInProgress = errors.New("There is no transaction in progress")
ErrNoTxInProgress indicates that an attempt was made to finish a transaction when none was active.
var ErrObjectNotFound = errors.New("object was not found in database")
ErrObjectNotFound indicates that an Object was not found in the database.
var ErrTxInProgress = errors.New("A Transaction is already in progress")
ErrTxInProgress indicates that an attempt to initiate a transaction failed because there is already one in progress.
Functions ¶
Types ¶
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
Database wraps a database connection and associated state.
func Get ¶
func Get() *Database
Get returns one connection from the global Pool, blocking if necessary.
func Open ¶
Open opens a Database. If the database specified by the path does not exist, yet, it is created and initialized.
func (*Database) Begin ¶
Begin begins an explicit database transaction. Only one transaction can be in progress at once, attempting to start one, while another transaction is already in progress will yield ErrTxInProgress.
func (*Database) BlacklistAdd ¶
BlacklistAdd adds a new Blacklist Item to the database
func (*Database) BlacklistGetAll ¶
BlacklistGetAll loads all Blacklist Items from the database
func (*Database) BlacklistHit ¶
BlacklistHit increases the hit count for the given Item
func (*Database) Close ¶
Close closes the database. If there is a pending transaction, it is rolled back.
func (*Database) Commit ¶
Commit ends the active transaction, making any changes made during that transaction permanent and visible to other connections. If no transaction is active, it returns ErrNoTxInProgress
func (*Database) FileDelete ¶
FileDelete removes a File from the database
func (*Database) FileGetAll ¶
FileGetAll loads *all* Files from the database. Use with caution
func (*Database) FileGetByID ¶
FileGetByID loads a File by its ID
func (*Database) FileGetByPath ¶
FileGetByPath fetches a File by its path
func (*Database) FileGetByPattern ¶
FileGetByPattern loads all Files whose Path matches the given pattern
func (*Database) FileGetNoMeta ¶
FileGetNoMeta loads all Files from the Database that have no Metadata, yet.
func (*Database) FileUpdateCtime ¶
FileUpdateCtime updates a File's CTime
func (*Database) MetaGetAll ¶
MetaGetAll loads ALL metadata from the database
func (*Database) MetaGetByFile ¶
MetaGetByFile fetches the metadata of the given File, if it exists.
func (*Database) MetaGetByRoot ¶
MetaGetByRoot loads the metadata of all Files that belong to the given Root.
func (*Database) MetaGetOutdated ¶
MetaGetOutdated loads the metadata for all Files that have metadata whose timestamp is older than the File's CTime.
func (*Database) MetaSearch ¶
MetaSearch searches files using SQLite's fulltext search feature.
func (*Database) MetaUpsert ¶
MetaUpsert adds or updates Metadata for a File.
func (*Database) PerformMaintenance ¶
PerformMaintenance performs some maintenance operations on the database. It cannot be called while a transaction is in progress and will block pretty much all access to the database while it is running.
func (*Database) Rollback ¶
Rollback terminates a pending transaction, undoing any changes to the database made during that transaction. If no transaction is active, it returns ErrNoTxInProgress
func (*Database) RootDelete ¶
RootDelete deletes a Root directory from the database.
func (*Database) RootGetAll ¶
RootGetAll fetches all Roots from the database.
func (*Database) RootGetByID ¶
RootGetByID loads a Root directory by its ID
func (*Database) RootGetByPath ¶
RootGetByPath loads a Root directory by its path
func (*Database) RootMarkScan ¶
RootMarkScan updates a Root's LastScan timestamp
func (*Database) SavepointCreate ¶
SavepointCreate creates a savepoint with the given name.
Savepoints only make sense within a running transaction, and just like with explicit transactions, managing them is the responsibility of the user of the Database.
Creating a savepoint without a surrounding transaction is not allowed, even though SQLite allows it.
For details on how Savepoints work, check the excellent SQLite documentation, but here's a quick guide:
Savepoints are kind-of-like transactions within a transaction: One can create a savepoint, make some changes to the database, and roll back to that savepoint, discarding all changes made between creating the savepoint and rolling back to it. Savepoints can be quite useful, but there are a few things to keep in mind:
Savepoints exist within a transaction. When the surrounding transaction is finished, all savepoints created within that transaction cease to exist, no matter if the transaction is commited or rolled back.
When the database is recovered after being interrupted during a transaction, e.g. by a power outage, the entire transaction is rolled back, including all savepoints that might exist.
When a savepoint is released, nothing changes in the state of the surrounding transaction. That means rolling back the surrounding transaction rolls back the entire transaction, regardless of any savepoints within.
Savepoints do not nest. Releasing a savepoint releases it and *all* existing savepoints that have been created before it. Rolling back to a savepoint removes that savepoint and all savepoints created after it.
func (*Database) SavepointRelease ¶
SavepointRelease releases the Savepoint with the given name, and all Savepoints created before the one being release.
func (*Database) SavepointRollback ¶
SavepointRollback rolls back the running transaction to the given savepoint.
type Pool ¶
type Pool struct {
// contains filtered or unexported fields
}
Pool is a pool of database connections
func NewPool ¶
NewPool creates a Pool of database connections. The number of connections to use is given by the parameter cnt.
func (*Pool) Close ¶
Close closes all open database connections currently in the pool and empties the pool. Any connections retrieved from the pool that are in use at the time Close is called are unaffected.
func (*Pool) Get ¶
Get returns a DB connection from the pool. If the pool is empty, it waits for a connection to be returned.
func (*Pool) GetNoWait ¶
GetNoWait returns a DB connection from the pool. If the pool is empty, it creates a new one.
Source Files
Directories