db

Documentation

Index

• Constants
• func New(ctx context.Context, ts oauth2.TokenSource, ...) (types.NpmDB, error)
• type FirestoreDB
  • func (f *FirestoreDB) GetFromDB(ctx context.Context, key string) (*types.NpmAuditData, error)
  • func (f *FirestoreDB) PutInDB(ctx context.Context, key string, issueId int64, created time.Time) error

Constants

const (

	// NPM audits collection name.
	NpmAuditDataCol = "NpmAuditData"
	// Downloaded packages examiner collection name.
	DownloadedPackagesExaminerCol = "DownloadedPackagesExaminer"
)

Functions

func New

func New(ctx context.Context, ts oauth2.TokenSource, fsNamespace, fsProjectId, collectionName string) (types.NpmDB, error)

New returns an instance of FirestoreDB.

Types

type FirestoreDB

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

FirestoreDB uses Cloud Firestore for storage and implements the types.NpmDB interface.

func (*FirestoreDB) GetFromDB

func (f *FirestoreDB) GetFromDB(ctx context.Context, key string) (*types.NpmAuditData, error)

GetFromDB gets a NpmAuditData document snapshot from Firestore. If the document is not found then (nil, nil) is returned.

func (*FirestoreDB) PutInDB

func (f *FirestoreDB) PutInDB(ctx context.Context, key string, issueId int64, created time.Time) error

PutInDB puts NpmAuditData into the DB. If the specified key already exists then it is updated.