database

Documentation

Overview

Copyright 2020 The Flux authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2025 The Flux authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type BadgerDatabase
  • func NewBadgerDatabase(db *badger.DB) *BadgerDatabase
  • func (a *BadgerDatabase) SetTags(repo string, tags []string) error
  • func (a *BadgerDatabase) Tags(repo string) ([]string, error)
• type BadgerGarbageCollector
  • func NewBadgerGarbageCollector(name string, db *badger.DB, interval time.Duration, discardRatio float64) *BadgerGarbageCollector
  • func (gc *BadgerGarbageCollector) Start(ctx context.Context) error

Types

type BadgerDatabase

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

BadgerDatabase provides implementations of the tags database based on Badger.

func NewBadgerDatabase

func NewBadgerDatabase(db *badger.DB) *BadgerDatabase

NewBadgerDatabase creates and returns a new database implementation using Badger for storing the image tags.

func (*BadgerDatabase) SetTags

func (a *BadgerDatabase) SetTags(repo string, tags []string) error

SetTags implements the DatabaseWriter interface, recording the tags against the repo.

It overwrites existing tag sets for the provided repo.

func (*BadgerDatabase) Tags

func (a *BadgerDatabase) Tags(repo string) ([]string, error)

Tags implements the DatabaseReader interface, fetching the tags for the repo.

If the repo does not exist, an empty set of tags is returned.

type BadgerGarbageCollector

type BadgerGarbageCollector struct {
	// DiscardRatio must be a float between 0.0 and 1.0, inclusive
	// See badger.DB.RunValueLogGC for more info
	DiscardRatio float64
	Interval     time.Duration
	// contains filtered or unexported fields
}

BadgerGarbageCollector implements controller runtime's Runnable

func NewBadgerGarbageCollector

func NewBadgerGarbageCollector(name string, db *badger.DB, interval time.Duration, discardRatio float64) *BadgerGarbageCollector

NewBadgerGarbageCollector creates and returns a new BadgerGarbageCollector

func (*BadgerGarbageCollector) Start

func (gc *BadgerGarbageCollector) Start(ctx context.Context) error

Start repeatedly runs the BadgerDB garbage collector with a delay inbetween runs.

Start blocks until the context is cancelled. The database is expected to already be open and not be closed while this context is active.

ctx should be a logr.Logger context.