README
¶
dbsgomysql
Stable v1 API
v1.0.0 is the compatibility baseline. Within v1.x, exported Go APIs, stable check identifiers, and documented JSON contracts follow Semantic Versioning; breaking changes wait for v2. Additive APIs and compatible fixes may ship in later v1 releases, so read the changelog when upgrading.
v1 requires Go 1.24 or newer. Oracle MySQL support begins at 8.0.40; support for the EOL 8.0 line is transitional. The complete server and distribution contract is in docs/LIMITATIONS.md.
A reference library of MySQL schema facts and validations for Go.
Module: github.com/dbsmedya/dbsgomysql · Go 1.24+ · Status: stable v1 API
· Version: see CHANGELOG.md
dbsgomysql gives Go projects a single, well-tested answer to questions like
"does this table have a single, composite, or no primary key?", "which
foreign keys point into this set of tables?", or "does the connected account
hold DELETE on these tables?" — plus named validation checks with documented
rationale built on those facts. It also tracks MySQL version-specific
information_schema quirks (8.0 / 8.4 / 9.7, with 26.x watched) so consumers
don't have to rediscover them.
Facts, not policy
The library answers factual questions and reports findings with a documented rationale. It never decides whether a finding matters — mapping a finding to fatal, warning, or ignore is the consumer's policy. That separation is why a check survives one consumer outgrowing it: the question stays answerable for everyone else.
Design principles
- Zero dependencies. Library code imports the Go standard library only.
- Driver-agnostic. You supply the connection — a
*sql.DB,*sql.Conn, or*sql.Tx; the library never opens, configures, or closes one, and never imports a driver. - Never panics, never logs. It returns data and errors. You decide what reaches a terminal.
- Context-first. Every call that touches the database takes a
context.Contextas its first argument.
Installation
go get github.com/dbsmedya/dbsgomysql
Status
Available now: pkg/sqlutil for MySQL identifier validation and quoting, plus
the pkg/validations metadata, column, foreign-key, and privilege facts and all
15 pure catalog checks, including table specification and diff facts.
pkg/replication adds six replication facts — replica channel status, binary
log enablement and coordinates, GTID state, replication configuration, and
registered replicas — with five pure catalog checks over them, tested against a
live source-replica topology on 8.0, 8.4, and 9.7.
Which release added what is recorded in CHANGELOG.md, the sole owner of version history.
Known consumer: goarchive. Planned consumer: gocdc.
Documentation
| docs/validations.md | pkg/validations consumer guide |
| docs/replication.md | pkg/replication consumer guide |
| docs/sqlutil.md | pkg/sqlutil — identifier safety |
| docs/LIMITATIONS.md | Supported distributions and known correctness, visibility, consistency, and scale boundaries |
| docs/COMPAT.md | MySQL version-quirk registry |
| docs/testing.md | Running the test matrix |
| CHANGELOG.md | Version history |
| AGENTS.md | Contributor and agent operating rules |
License
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
testsupport
Package testsupport provides shared test-only infrastructure.
|
Package testsupport provides shared test-only infrastructure. |
|
pkg
|
|
|
replication
Package replication answers factual questions about one MySQL server's replication state and runs named checks over the answers.
|
Package replication answers factual questions about one MySQL server's replication state and runs named checks over the answers. |
|
sqlutil
Package sqlutil makes MySQL identifiers safe to interpolate into SQL.
|
Package sqlutil makes MySQL identifiers safe to interpolate into SQL. |
|
validations
Package validations answers factual questions about a MySQL schema and runs named checks over the answers.
|
Package validations answers factual questions about a MySQL schema and runs named checks over the answers. |