Skip to main content

Registry

The KeyBuilder registry lets you store and reuse named key templates across your application.

Why use a registry?​

  • Centralizes template management
  • Avoids duplication and typos
  • Enables dynamic configuration
  • Supports global/shared templates

Basic Usage​

import "github.com/kivigo/kivigo/pkg/key"

// Create a registry
reg := key.NewRegistry()
tmpl, err := key.Template("user:{userID}:data:{dataID}")
if err != nil {
    // handle invalid template error
}
err = reg.Register("userKey", tmpl)
if err != nil {
    // handle duplicate name error
}

// Retrieve and use a template
builder, ok := reg.Get("userKey")
if ok {
    key, _ := builder.Build(ctx, map[string]interface{}{ "userID": 42, "dataID": "abc" })
    // key == "user:42:data:abc"
}

Global Registry​

For shared templates, use the package-level global registry:

tmpl, err := key.Template("order:{orderID}")
if err != nil {
    // handle invalid template error
}
err = key.GlobalRegistry().Register("orderKey", tmpl)
if err != nil {
    // handle duplicate name error
}
builder, ok := key.GlobalRegistry().Get("orderKey")

API Reference​

Retrieve a API reference for the Registry in pkg.go.dev/github.com/kivigo/kivigo/pkg/key#Registry

Best Practices​

  • Use constants for template names to avoid typos
  • Document your templates for maintainability
  • Prefer the global registry for cross-package usage
  • Always check the error returned by Register to avoid duplicate names

See also: DSL Details, Overview