modeldocumenter

package
v0.0.0-...-7f6939c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 6, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ColumnInfo

type ColumnInfo struct {
	Name        string
	Type        string
	Nullable    bool
	PrimaryKey  bool
	Description string
	Default     string
}

ColumnInfo contains information about a database column

type ForeignKeyInfo

type ForeignKeyInfo struct {
	Name              string
	Columns           []string
	ReferencedTable   string
	ReferencedColumns []string
}

ForeignKeyInfo contains information about a foreign key

type IndexInfo

type IndexInfo struct {
	Name    string
	Columns []string
	Unique  bool
}

IndexInfo contains information about a database index

type ModelDocumenter

type ModelDocumenter struct {
	// contains filtered or unexported fields
}

ModelDocumenter generates documentation for data models

func NewModelDocumenter

func NewModelDocumenter(db *sqlx.DB) *ModelDocumenter

NewModelDocumenter creates a new ModelDocumenter

func (*ModelDocumenter) GenerateDocumentation

func (d *ModelDocumenter) GenerateDocumentation() (string, error)

GenerateDocumentation generates documentation for all models

type TableInfo

type TableInfo struct {
	Name        string
	Description string
	Columns     []ColumnInfo
	Indexes     []IndexInfo
	ForeignKeys []ForeignKeyInfo
}

TableInfo contains information about a database table

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL