duty

README

duty

Duty (Database Utility) is a home for common database tools, models and helpers.

Documentation

Index

• Constants
• func DefaultGormConfig() *gorm.Config
• func FindConnection(ctx context.Context, db *gorm.DB, connectionType, name string) (*models.Connection, error)
• func GetComponent(ctx context.Context, db *gorm.DB, id string) (*models.Component, error)
• func GetConfigMapFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)
• func GetConnection(ctx context.Context, client kubernetes.Interface, db *gorm.DB, ...) (*models.Connection, error)
• func GetEnvStringFromCache(c kubernetes.Interface, env string, namespace string) (string, error)
• func GetEnvValueFromCache(c kubernetes.Interface, input types.EnvVar, namespace string) (string, error)
• func GetSecretFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)
• func HydrateConnection(ctx context.Context, client kubernetes.Interface, db *gorm.DB, ...) (*models.Connection, error)
• func Migrate(connection string) error
• func NewDB(connection string) (*sql.DB, error)
• func NewGorm(connection string, config *gorm.Config) (*gorm.DB, error)
• func NewPgxPool(connection string) (*pgxpool.Pool, error)
• func Query(ctx context.Context, conn *pgxpool.Pool, query string) ([]map[string]any, error)
• func QueryCheckSummary(dbpool *pgxpool.Pool) (models.Checks, error)
• func QueryTopology(dbpool *pgxpool.Pool, params TopologyOptions) ([]*models.Component, error)
• func RefreshCheckStatusSummary(dbpool *pgxpool.Pool) error
• type TopologyOptions
  • func (opt TopologyOptions) String() string

Constants

const DefaultDepth = 5

Functions

func DefaultGormConfig

func DefaultGormConfig() *gorm.Config

func FindConnection

func FindConnection(ctx context.Context, db *gorm.DB, connectionType, name string) (*models.Connection, error)

FindConnection returns the connection with the given type and name

func GetComponent

func GetComponent(ctx context.Context, db *gorm.DB, id string) (*models.Component, error)

func GetConfigMapFromCache

func GetConfigMapFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)

func GetConnection

func GetConnection(ctx context.Context, client kubernetes.Interface, db *gorm.DB, connectionType string, name string, namespace string) (*models.Connection, error)

func GetEnvStringFromCache

func GetEnvStringFromCache(c kubernetes.Interface, env string, namespace string) (string, error)

func GetEnvValueFromCache

func GetEnvValueFromCache(c kubernetes.Interface, input types.EnvVar, namespace string) (string, error)

func GetSecretFromCache

func GetSecretFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)

func HydrateConnection

func HydrateConnection(ctx context.Context, client kubernetes.Interface, db *gorm.DB, connection *models.Connection, namespace string) (*models.Connection, error)

Create a cache with a default expiration time of 5 minutes, and which purges expired items every 10 minutes var connectionCache = cache.New(5*time.Minute, 10*time.Minute)

func Migrate

func Migrate(connection string) error

func NewDB

func NewDB(connection string) (*sql.DB, error)

func NewGorm

func NewGorm(connection string, config *gorm.Config) (*gorm.DB, error)

creates a new Gorm DB connection using the global pgx connection pool, must be called after NewPgxPool

func NewPgxPool

func NewPgxPool(connection string) (*pgxpool.Pool, error)

func Query

func Query(ctx context.Context, conn *pgxpool.Pool, query string) ([]map[string]any, error)

Query runs the given SQL query against the provided db connection. The rows are returned as a map of columnName=>columnValue.

func QueryCheckSummary

func QueryCheckSummary(dbpool *pgxpool.Pool) (models.Checks, error)

func QueryTopology

func QueryTopology(dbpool *pgxpool.Pool, params TopologyOptions) ([]*models.Component, error)

func RefreshCheckStatusSummary

func RefreshCheckStatusSummary(dbpool *pgxpool.Pool) error

Types

type TopologyOptions

type TopologyOptions struct {
	ID      string
	Owner   string
	Labels  map[string]string
	Flatten bool
	Depth   int
	Types   []string
	Status  []string
}

func (TopologyOptions) String

func (opt TopologyOptions) String() string