gcfm

go-custom-field-model (GCFM)

go-custom-field-model (GCFM) is a Go framework that automates custom field management on RDBs and NoSQL databases. It provides:

• CLI (fieldctl) — schema scanning, drift detection, and YAML registry operations
• SDK (sdk) — Go API for embedding in applications
• API Server (api-server) — exposes a REST API and integrates with gcfm-dashboard

✨ Features

• Schema Scan — automatically detects database schemas and records metadata
• YAML Registry — manages custom field definitions in versioned YAML
• Diff & Apply — detects schema drift and applies differences
• Multi-Tenant — manages a meta database and multiple target databases
• Extensible — extend validators via Go plugins
• Observability — Prometheus metrics and a CI drift guard
• Dashboard UI — operate from the separate gcfm-dashboard repository

🚀 Quick Start

1. Build

make build   # builds the CLI and API server (outputs to bin/)

2. Initialize DB

bin/fieldctl db migrate \
  --table-prefix="gcfm_" \
  --db "root:rootpw@tcp(localhost:3306)/gcfm" \
  --schema public \
  --seed \
  --driver=mysql

3. Start API Server

bin/api-server -addr=:18081 --driver=mysql --dsn "root:rootpw@tcp(localhost:3306)/gcfm"

📷 CLI Examples

Scan existing database

$ fieldctl scan --db "postgres://user:pass@localhost:5432/app" \
    --schema public --driver postgres
INSERT 8  UPDATE 2  SKIP 3 (reserved)

Show drift between DB and registry.yaml

$ fieldctl diff --db "postgres://user:pass@localhost:5432/app" \
    --schema public --driver postgres --file registry.yaml --fail-on-change

--- posts.title (DB)
+++ posts.title (YAML)
- type: varchar(255)
+ type: text

Apply registry.yaml (dry-run)

$ fieldctl apply --db "postgres://user:pass@localhost:5432/app" \
    --schema public --file registry.yaml --dry-run

[DRY-RUN] Would ALTER COLUMN posts.title TYPE text

🖥 Dashboard Example

By using gcfm-dashboard, you can manage fields from the browser.

📚 Documentation

• CLI Commands
• YAML Registry
• SDK Examples
• Multi-Tenant Setup
• Snapshots & Rollback
• Metrics & CI Guard

👉 See docs/index.md for details.

📦 Package Layout

• sdk/ — public SDK
• internal/ — server implementation
• pkg/ — shared utilities
• cmd/fieldctl/ — CLI tool

🤝 Contributing

We welcome pull requests, issues, and feature proposals. See CONTRIBUTING.md for details.

📄 License

MIT License