admindb

Documentation

Overview

Package admindb handles the admin storage on SQLite3.

Auto Migration

Table schemas will be auto migrated on db opening, that means tables will be automatically created on the first time banshee starts.

Persistence

Users, Rules and Projects are stored on disk in sqlite3, the relation between them is:

User:Project    N:M
Rule:Project    N:1

To get gorm DB handle:

adminDBInstance.DB()

Rules Cache

To access rules faster in detector, rules are cached in memory, in a safemap with RWLock.

To get the rulesCache handle:

adminDBInstance.RulesCache

Index

• type DB
  • func Open(fileName string) (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) DB() *gorm.DB

Types

type DB

type DB struct {

	// Cache
	RulesCache *rulesCache
	// contains filtered or unexported fields
}

DB handles admin storage.

func Open

func Open(fileName string) (*DB, error)

Open DB by fileName.

func (*DB) Close

func (db *DB) Close() error

Close DB.

func (*DB) DB

func (db *DB) DB() *gorm.DB

DB returns db handle.