duty

README

duty

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

Documentation

Index

• Constants
• Variables
• func DefaultGormConfig() *gorm.Config
• func FindConnection(ctx context.Context, db *gorm.DB, connectionType, name string) (*models.Connection, error)
• func FindConnectionByURL(ctx context.Context, db *gorm.DB, connectionString 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 HydratedConnectionByURL(ctx context.Context, db *gorm.DB, k8sClient kubernetes.Interface, ...) (*models.Connection, error)
• func Migrate(connection string, opts *migrate.MigrateOptions) 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 QueryCheckSummary(ctx context.Context, dbpool *pgxpool.Pool) (models.Checks, error)
• func RefreshCheckStatusSummary(dbpool *pgxpool.Pool) error
• type Tags
• type TopologyOptions
  • func (opt TopologyOptions) String() string
• type TopologyResponse
  • func QueryTopology(ctx context.Context, dbpool *pgxpool.Pool, params TopologyOptions) (*TopologyResponse, error)

Constants

const DefaultDepth = 5

Variables

var DefaultQueryTimeout = 30 * time.Second

var (
	ErrNotFound = errors.New("NOT_FOUND")
)

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 FindConnectionByURL

func FindConnectionByURL(ctx context.Context, db *gorm.DB, connectionString string) (*models.Connection, error)

FindConnectionByURL retrieves a connection from the given connection string. The connection string is expected to be of the form: connection://<type>/<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 HydratedConnectionByURL

func HydratedConnectionByURL(ctx context.Context, db *gorm.DB, k8sClient kubernetes.Interface, namespace, connectionString string) (*models.Connection, error)

HydratedConnectionByURL retrieves a connection from the given connection string. The connection string is expected to be of the form: connection://<type>/<name>

func Migrate

func Migrate(connection string, opts *migrate.MigrateOptions) 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 QueryCheckSummary

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

func RefreshCheckStatusSummary

func RefreshCheckStatusSummary(dbpool *pgxpool.Pool) error

Types

type Tags

type Tags map[string][]string

Map of tag keys to the list of available values

type TopologyOptions

type TopologyOptions struct {
	ID      string
	Owner   string
	Labels  map[string]string
	Flatten bool
	Depth   int
	// TODO: Filter status and types in DB Query
	Types  []string
	Status []string
}

func (TopologyOptions) String

func (opt TopologyOptions) String() string

type TopologyResponse

type TopologyResponse struct {
	Components     models.Components `json:"components"`
	HealthStatuses []string          `json:"healthStatuses"`
	Teams          []string          `json:"teams"`
	Tags           Tags              `json:"tags"`
	Types          []string          `json:"types"`
}

func QueryTopology

func QueryTopology(ctx context.Context, dbpool *pgxpool.Pool, params TopologyOptions) (*TopologyResponse, error)