db

Documentation

Index

• Constants
• type Config
• type Curator
  • func NewCurator(cfg Config) Curator
  • func (c *Curator) Delete() error
  • func (c *Curator) GetStore() (*reader.Reader, error)
  • func (c *Curator) ImportFrom(dbArchivePath string) error
  • func (c *Curator) IsUpdateAvailable() (bool, *curation.ListingEntry, error)
  • func (c *Curator) Status() Status
  • func (c *Curator) Update() (bool, error)
  • func (c *Curator) UpdateTo(listing *curation.ListingEntry, ...) error
  • func (c *Curator) Validate() error
• type Status

Constants

const (
	FileName = grypeDB.VulnerabilityStoreFileName
)

Types

type Config

type Config struct {
	DbRootDir           string
	ListingURL          string
	ValidateByHashOnGet bool
}

type Curator

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

func NewCurator

func NewCurator(cfg Config) Curator

func (*Curator) Delete

func (c *Curator) Delete() error

Delete removes the DB and metadata file for this specific schema.

func (*Curator) GetStore

func (c *Curator) GetStore() (*reader.Reader, error)

func (*Curator) ImportFrom

func (c *Curator) ImportFrom(dbArchivePath string) error

ImportFrom takes a DB archive file and imports it into the final DB location.

func (*Curator) IsUpdateAvailable

func (c *Curator) IsUpdateAvailable() (bool, *curation.ListingEntry, error)

IsUpdateAvailable indicates if there is a new update available as a boolean, and returns the latest listing information available for this schema.

func (*Curator) Status

func (c *Curator) Status() Status

func (*Curator) Update

func (c *Curator) Update() (bool, error)

Update the existing DB, returning an indication if any action was taken.

func (*Curator) UpdateTo

func (c *Curator) UpdateTo(listing *curation.ListingEntry, downloadProgress, importProgress *progress.Manual, stage *progress.Stage) error

UpdateTo updates the existing DB with the specific other version provided from a listing entry.

func (*Curator) Validate

func (c *Curator) Validate() error

Validate checks the current database to ensure file integrity and if it can be used by this version of the application.

type Status

type Status struct {
	Built         time.Time `json:"built"`
	SchemaVersion int       `json:"schemaVersion"`
	Location      string    `json:"location"`
	Checksum      string    `json:"checksum"`
	Err           error     `json:"error"`
}