plantuml

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Jul 21, 2025 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package plantuml provides functionality for converting database schemas into PlantUML ERD format. PlantUML is a widely used diagramming tool that supports Entity Relationship Diagrams (ERD). This package implements the dberd.Target interface for PlantUML diagram generation.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Target

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

Target represents a PlantUML diagram formatter that converts database schemas into PlantUML format. It handles the conversion of database schemas to PlantUML ERD diagrams.

func NewTarget

func NewTarget() (*Target, error)

NewTarget creates a new PlantUML diagram formatter instance. It initializes the template from the embedded schema.tmpl file.

Returns an error if the template parsing fails.

func (*Target) Capabilities

func (t *Target) Capabilities() dberd.TargetCapabilities

Capabilities returns target capabilities.

func (*Target) FormatSchema

func (t *Target) FormatSchema(_ context.Context, s dberd.Schema) (dberd.FormattedSchema, error)

FormatSchema converts a database schema into PlantUML ERD format.

func (*Target) RenderSchema

func (t *Target) RenderSchema(_ context.Context, _ dberd.FormattedSchema) ([]byte, error)

RenderSchema is unsupported for plantuml target.

Jump to

Keyboard shortcuts

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