doc_gen

Documentation

Index

• func GeneratorDBDocsWithPostgresqlDSNEnv(provider *provider.Provider) (string, error)
• type DBDocsGenerator
  • func NewDBDocsGenerator(provider *provider.Provider) *DBDocsGenerator
  • func (x *DBDocsGenerator) GenColumn(table *schema.Table, column *schema.Column)
  • func (x *DBDocsGenerator) GenFK()
  • func (x *DBDocsGenerator) GenProjectBlock()
  • func (x *DBDocsGenerator) GenTable(table *schema.Table)
  • func (x *DBDocsGenerator) GenTables()
  • func (x *DBDocsGenerator) Run() string
• type ProviderDocumentGenerator
  • func New(provider *provider.Provider, outputDirectory string) *ProviderDocumentGenerator
  • func (x *ProviderDocumentGenerator) Run() error

Functions

func GeneratorDBDocsWithPostgresqlDSNEnv

func GeneratorDBDocsWithPostgresqlDSNEnv(provider *provider.Provider) (string, error)

Types

type DBDocsGenerator

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

DBDocsGenerator Generate dbdocs(https://dbdocs.io/) support DBML (https://www.dbml.org/home/)

func NewDBDocsGenerator

func NewDBDocsGenerator(provider *provider.Provider) *DBDocsGenerator

func (*DBDocsGenerator) GenColumn

func (x *DBDocsGenerator) GenColumn(table *schema.Table, column *schema.Column)

func (*DBDocsGenerator) GenFK

func (x *DBDocsGenerator) GenFK()

func (*DBDocsGenerator) GenProjectBlock

func (x *DBDocsGenerator) GenProjectBlock()

GenProjectBlock

example:

Project Ecommerce {
 database_type: 'PostgreSQL'
 Note: '''
   # Ecommerce Database
   **markdown content here**
 '''
}

func (*DBDocsGenerator) GenTable

func (x *DBDocsGenerator) GenTable(table *schema.Table)

func (*DBDocsGenerator) GenTables

func (x *DBDocsGenerator) GenTables()

func (*DBDocsGenerator) Run

func (x *DBDocsGenerator) Run() string

type ProviderDocumentGenerator

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

ProviderDocumentGenerator auto generate provider and it's table documentation

func New

func New(provider *provider.Provider, outputDirectory string) *ProviderDocumentGenerator

func (*ProviderDocumentGenerator) Run

func (x *ProviderDocumentGenerator) Run() error