sync

package

v0.15.0 Latest Latest Go to latest Published: Apr 12, 2026 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SpotlightGOV/pbflags

Links

Open Source Insights

Documentation ¶

Overview ¶

Package sync provides flag definition synchronization from parsed descriptors into PostgreSQL. Both pbflags-sync and pbflags-admin (standalone mode) use this package to write definitions to the database.

Index ¶

func FlagTypeString(ft pbflagsv1.FlagType) string
func LayerDBString(layer string) string
type Result
- func SyncDefinitions(ctx context.Context, conn *pgx.Conn, defs []evaluator.FlagDef, ...) (Result, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FlagTypeString ¶

func FlagTypeString(ft pbflagsv1.FlagType) string

FlagTypeString converts a FlagType enum to the string stored in the DB, stripping the "FLAG_TYPE_" prefix (e.g. FLAG_TYPE_BOOL -> "BOOL").

func LayerDBString ¶

func LayerDBString(layer string) string

LayerDBString normalizes the layer name for DB storage (uppercase). Empty or "global" maps to "GLOBAL".

Types ¶

type Result ¶

type Result struct {
	Features      int
	FlagsUpserted int
	FlagsArchived int
}

Result reports what the sync did.

func SyncDefinitions ¶

func SyncDefinitions(ctx context.Context, conn *pgx.Conn, defs []evaluator.FlagDef, logger *slog.Logger) (Result, error)

SyncDefinitions writes the given flag definitions to the database in a single transaction. It upserts features and flags, and archives flags that are no longer present in the descriptor. Runtime state (state, value) is never modified.

Source Files ¶

View all Source files

sync.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL