Reference
Lookup material, as tables rather than prose. Where a guide page explains a mechanism, this says exactly what it accepts.
Each page names the file it was checked against. They are hand-written, so they can fall behind the code — if one disagrees with the source, the source is right, and the page is a bug.
| Checked against | |
|---|---|
| Filter grammar — every operator, which column types accept it, and the reserved parameters | filter/filter.go |
| Column types — constructors, SQL types, Go types, and what each admits | schema/field.go, schema/type.go |
| Capabilities — every method, what it permits, and the struct tag it becomes | schema/field.go |
Codegen options — every field of codegen.Options and its default |
codegen/codegen.go |
| Generated CLI — flags, environment variables, precedence | codegen/gocli.go |
| Rejections — the problem document, and every message it can carry | rest/errors.go, filter/filter.go |
Elsewhere
Section titled “Elsewhere”- pkg.go.dev — the API
reference, with the compiled
Examplefunctions attached to the symbols they document. Those examples are the canonical form: where a documentation page and an example disagree, the example is right. - Compatibility — which of those symbols are frozen, which are provisional, and which will change without ceremony.
- Architecture — the package map, the request path, and the full table of where sqlb fails loudly.