database

Documentation

Index

• Constants
• Variables
• func CleanseCommand(command string) string
• type BoltDB
  • func NewBoltDB(path string, readonly bool) (b *BoltDB, err error)
  • func (b *BoltDB) CheckDupeCmds(command string, count int) (countReached bool)
  • func (b *BoltDB) Close() error
  • func (b *BoltDB) DeleteScript(alias []byte) error
  • func (b *BoltDB) GetRecent(tty, username string, count int) ([]models.HistoryRecord, error)
  • func (b *BoltDB) GetScript(alias []byte) (command *models.DocumentedScript)
  • func (b *BoltDB) IgnoreCommand(command, username string) (err error)
  • func (b *BoltDB) IgnoreWord(word, username string) (err error)
  • func (b *BoltDB) Init() error
  • func (b *BoltDB) PruneHistory(max int) error
  • func (b *BoltDB) QueryHistory(regex *regexp.Regexp, username string, all bool) ([]models.HistoryRecord, error)
  • func (b *BoltDB) QueryScripts(tags ...string) ([]models.DocumentedScript, error)
  • func (b *BoltDB) Save(id []byte, instance interface{}, overwrite bool) (err error)
  • func (b *BoltDB) SaveBatch(toSave <-chan HasID, bucket []byte) <-chan error
  • func (b *BoltDB) ShouldIgnoreCommand(command, username string) (yes bool)
  • func (b *BoltDB) ShouldIgnoreWord(word, username string) (yes bool)
  • func (b *BoltDB) UnignoreCommand(command, username string) (err error)
  • func (b *BoltDB) UnignoreWord(word, username string) (err error)
• type HasID

Constants

const (
	Wildcard  = "?"
	TrashTag  = "coach.trash.983476" // just something arbitrary that is unlikely to be used by anything else
	FilePerms = 0660
)

Variables

var (
	HistoryBucket    = []byte("history")
	SavedCmdsBucket  = []byte("commands")
	IgnoreBucket     = []byte("ignore")
	IgnoreWordBucket = []byte("ignore-word")

	ErrNotFound      = errors.New("not found")
	ErrAlreadyExists = errors.New("already exists")
)

Functions

func CleanseCommand

func CleanseCommand(command string) string

CleanseCommand converts a command to what it would look like in the database

Types

type BoltDB

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

func NewBoltDB

func NewBoltDB(path string, readonly bool) (b *BoltDB, err error)

func (*BoltDB) CheckDupeCmds

func (b *BoltDB) CheckDupeCmds(command string, count int) (countReached bool)

func (*BoltDB) Close

func (b *BoltDB) Close() error

Close closes the bolt db file.

func (*BoltDB) DeleteScript

func (b *BoltDB) DeleteScript(alias []byte) error

func (*BoltDB) GetRecent

func (b *BoltDB) GetRecent(tty, username string, count int) ([]models.HistoryRecord, error)

GetRecent retrieves the last count (arg) lines of history from specified tty (arg).

func (*BoltDB) GetScript

func (b *BoltDB) GetScript(alias []byte) (command *models.DocumentedScript)

func (*BoltDB) IgnoreCommand

func (b *BoltDB) IgnoreCommand(command, username string) (err error)

func (*BoltDB) IgnoreWord

func (b *BoltDB) IgnoreWord(word, username string) (err error)

func (*BoltDB) Init

func (b *BoltDB) Init() error

func (*BoltDB) PruneHistory

func (b *BoltDB) PruneHistory(max int) error

func (*BoltDB) QueryHistory

func (b *BoltDB) QueryHistory(regex *regexp.Regexp, username string, all bool) ([]models.HistoryRecord, error)

func (*BoltDB) QueryScripts

func (b *BoltDB) QueryScripts(tags ...string) ([]models.DocumentedScript, error)

func (*BoltDB) Save

func (b *BoltDB) Save(id []byte, instance interface{}, overwrite bool) (err error)

func (*BoltDB) SaveBatch

func (b *BoltDB) SaveBatch(toSave <-chan HasID, bucket []byte) <-chan error

func (*BoltDB) ShouldIgnoreCommand

func (b *BoltDB) ShouldIgnoreCommand(command, username string) (yes bool)

func (*BoltDB) ShouldIgnoreWord

func (b *BoltDB) ShouldIgnoreWord(word, username string) (yes bool)

func (*BoltDB) UnignoreCommand

func (b *BoltDB) UnignoreCommand(command, username string) (err error)

func (*BoltDB) UnignoreWord

func (b *BoltDB) UnignoreWord(word, username string) (err error)

type HasID

type HasID interface {
	GetId() []byte
}