datamodeldiagram

Documentation

Index

• func GenerateDataDiagramWithAppAndType(m *sysl.Module, appName string, typeName string) (string, error)
• func GenerateDataDiagramWithMapper(mapper *syslwrapper.AppMapper, appName string, typeName string) (string, error)
• func GenerateFullDataDiagram(m *sysl.Module) (string, error)
• func GeneratePrimitive(typeName string) string

Functions

func GenerateDataDiagramWithAppAndType

func GenerateDataDiagramWithAppAndType(m *sysl.Module, appName string, typeName string) (string, error)

GenerateDataDiagramWithAppAndType generates the data model for a specific type

func GenerateDataDiagramWithMapper

func GenerateDataDiagramWithMapper(mapper *syslwrapper.AppMapper, appName string, typeName string,
) (string, error)

GenerateDataDiagramWithMapper generates the data model diagram for a specific type with a provided mapper The mapper should first be initialised using mapper := syslwrapper.MakeAppMapper(module) mapper.IndexTypes() mapper.ConvertTypes()

func GenerateFullDataDiagram

func GenerateFullDataDiagram(m *sysl.Module) (string, error)

GenerateFullDataDiagram accepts a sysl module and returns a string (and an error if any) The resulting string is the mermaid code for the data model for that module

func GeneratePrimitive

func GeneratePrimitive(typeName string) string