reader

Documentation

Index

• func New(dbFilePath string) (*Reader, CleanupFn, error)
• func Open(cfg *config) (*sqlittle.DB, error)
• type CleanupFn
• type Reader
  • func (b *Reader) GetID() (*v2.ID, error)
  • func (b *Reader) GetVulnerability(namespace, name string) ([]v2.Vulnerability, error)
  • func (b *Reader) GetVulnerabilityMetadata(id, recordSource string) (*v2.VulnerabilityMetadata, error)

Functions

func New

func New(dbFilePath string) (*Reader, CleanupFn, error)

New creates a new instance of the store.

func Open

func Open(cfg *config) (*sqlittle.DB, error)

Open a new connection to the sqlite3 database file

Types

type CleanupFn

type CleanupFn func() error

CleanupFn is a callback for closing a DB connection.

type Reader

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

Reader holds an instance of the database connection.

func (*Reader) GetID

func (b *Reader) GetID() (*v2.ID, error)

GetID fetches the metadata about the databases schema version and build time.

func (*Reader) GetVulnerability

func (b *Reader) GetVulnerability(namespace, name string) ([]v2.Vulnerability, error)

GetVulnerability retrieves one or more vulnerabilities given a namespace and package name.

func (*Reader) GetVulnerabilityMetadata

func (b *Reader) GetVulnerabilityMetadata(id, recordSource string) (*v2.VulnerabilityMetadata, error)

GetVulnerabilityMetadata retrieves metadata for the given vulnerability ID relative to a specific record source.