Usage guides for the go-typeql packages. For an introduction to the library, see the project README. For complete API signatures, see pkg.go.dev or the reference docs.
See Upgrading to v3 for the breaking changes and migration steps of v3, and Upgrading to v2 for v2.
| Guide | What you'll learn |
|---|---|
| Models | Defining entities and relations, struct tags, type registration |
| CRUD | Insert, Get, Update, Delete, Put, batch ops, transactions |
| Selected fields | Read selected attributes without unsafe partial-model updates |
| Typed iteration | Read models through a callback without retaining the full model slice |
| Queries | Filters, sorting, pagination, aggregations, group-by, function queries |
| Schema | Schema generation, migration workflows, sequential migrations |
| Generator | tqlgen: generate Go structs from TypeQL schemas |
| AST | Low-level TypeQL AST for programmatic query building |
| Driver | Rust FFI driver setup, TypeDB 3.13 setup, server version, address translation |
Generated from source via gomarkdoc. Regenerate with:
~/go/bin/gomarkdoc ./ast/ > docs/api/reference/ast.md
~/go/bin/gomarkdoc ./given/ > docs/api/reference/given.md
~/go/bin/gomarkdoc ./gotype/ > docs/api/reference/gotype.md
~/go/bin/gomarkdoc ./tqlgen/ > docs/api/reference/tqlgen.md
~/go/bin/gomarkdoc --tags "cgo,typedb" ./driver/ > docs/api/reference/driver.md| Package | Reference |
|---|---|
| ast | reference/ast.md |
| driver | reference/driver.md |
| given | reference/given.md |
| gotype | reference/gotype.md |
| tqlgen | reference/tqlgen.md |