dbfwd connects a program such as usql to a
database that runs on Kubernetes. It reads a URL such as
k+cnpg://pg.prod/app or k://pg-rw.prod/, finds the database, starts a
port-forward, and gives back an ordinary URL for a local port. The URL holds
no password: dbfwd reads it from the cluster.
dbfwd is a Go package, and a command, dbfwd, that runs the native client
of a database or usql through the forward:
go run github.com/xo/dbfwd/cmd/dbfwd@latest k+cnpg://pg.prod/It is an early implementation for Kubernetes. docs/PLAN.md
says where it stands.
| Document | What it holds |
|---|---|
docs/PLAN.md |
The aim, where the work stands, what other projects give, and the next steps |
docs/API.md |
The Go API of the package |
docs/URL.md |
The URL that dbfwd reads |
docs/LOOKUP.md |
How dbfwd finds a database from a name, with or without an operator |
docs/OPERATORS.md |
What each supported operator creates, and where dbfwd reads it |
docs/CLI.md |
The dbfwd command, which runs a native client or usql through a forward |
docs/TESTING.md |
How dbfwd is tested, locally and in CI |
docs/decisions/ |
Every decision, one file each |
AGENTS.md |
The rules for a coding agent. Every rule applies to a perso 5DBB n too |
CONTRIBUTING.md |
How to send a change |
MIT. See LICENSE.