API Guides

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.

Guides

Guide	What you'll learn
Models	Defining entities and relations, struct tags, type registration
CRUD	Insert, Get, Update, Delete, Put, batch ops, transactions
Queries	Filters, sorting, pagination, aggregations, group-by
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.11 options, server version, address translation

API Reference

Generated from source via gomarkdoc. Regenerate with:

~/go/bin/gomarkdoc ./ast/ > docs/api/reference/ast.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
gotype	reference/gotype.md
tqlgen	reference/tqlgen.md