AsciidoctorJ Liquibase Extension

Asciidoctor extension to render changesets as entity relationship diagram

License	MIT
Categories	Liquibase Data Databases
GroupId	de.uniqueck.asciidoctorj.extensions
ArtifactId	asciidoctorj-liquibase-extension
Last Version	0.1.1
Release Date	Apr 5, 2021
Type	jar
Description	AsciidoctorJ Liquibase Extension Asciidoctor extension to render changesets as entity relationship diagram
Project URL	https://github.com/uniqueck/asciidoctorj-liquibase-extension
Source Code Management	https://github.com/uniqueck/asciidoctorj-liquibase-extension

Download asciidoctorj-liquibase-extension

Filename	Size
asciidoctorj-liquibase-extension-0.1.1.pom
asciidoctorj-liquibase-extension-0.1.1.jar	25 KB
asciidoctorj-liquibase-extension-0.1.1-sources.jar	16 KB
asciidoctorj-liquibase-extension-0.1.1-javadoc.jar	61 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/de.uniqueck.asciidoctorj.extensions/asciidoctorj-liquibase-extension/ -->
<dependency>
    <groupId>de.uniqueck.asciidoctorj.extensions</groupId>
    <artifactId>asciidoctorj-liquibase-extension</artifactId>
    <version>0.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/de.uniqueck.asciidoctorj.extensions/asciidoctorj-liquibase-extension/
implementation 'de.uniqueck.asciidoctorj.extensions:asciidoctorj-liquibase-extension:0.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/de.uniqueck.asciidoctorj.extensions/asciidoctorj-liquibase-extension/
implementation ("de.uniqueck.asciidoctorj.extensions:asciidoctorj-liquibase-extension:0.1.1")

Apache Buildr

'de.uniqueck.asciidoctorj.extensions:asciidoctorj-liquibase-extension:jar:0.1.1'

Apache Ivy

<dependency org="de.uniqueck.asciidoctorj.extensions" name="asciidoctorj-liquibase-extension" rev="0.1.1">
  <artifact name="asciidoctorj-liquibase-extension" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='de.uniqueck.asciidoctorj.extensions', module='asciidoctorj-liquibase-extension', version='0.1.1')
)

Scala SBT

libraryDependencies += "de.uniqueck.asciidoctorj.extensions" % "asciidoctorj-liquibase-extension" % "0.1.1"

Leiningen

[de.uniqueck.asciidoctorj.extensions/asciidoctorj-liquibase-extension "0.1.1"]

Dependencies

compile (5)

Group / Artifact	Type	Version
de.uniqueck.asciidoctorj.extensions : asciidoctorj-extension-support	jar	0.1.0
org.slf4j : slf4j-api	jar	1.7.28
ch.qos.logback : logback-classic	jar	1.2.3
org.jdom : jdom2	jar	2.0.6
org.asciidoctor : asciidoctorj-diagram	jar	2.1.1

provided (1)

Group / Artifact	Type	Version
org.projectlombok : lombok	jar	1.18.8

test (2)

Group / Artifact	Type	Version
de.uniqueck.asciidoctorj.extensions : asciidoctorj-extension-test-support	jar	0.1.0
commons-io : commons-io	jar	2.6

Project Modules

There are no modules declared in this project.

AsciidoctorJ Liquibase Extension

This AsciidoctorJ extension provides a macro to generate a entity relationship diagram based on liquibase changeset files. Currently only xml format for liquibase changeset files are supported. This extensions needs asciidoctor-diagram extension to work probably.

Installation

To use this extension declare it as a dependency in asciidoctor-maven-plugin configuration or asciidoctor-gradle-plugin.

Prerequisites: * graphviz - https://graphviz.org/

<plugin>
	<groupId>org.asciidoctor</groupId>
	<artifactId>asciidoctor-maven-plugin</artifactId>
	<version>LATEST</version>
	<executions>
		<execution>
			<id>output-html</id>
			<phase>generate-resources</phase>
			<goals>
				<goal>process-asciidoc</goal>
			</goals>
			<configuration>
				<backend>html</backend>
			</configuration>
		</execution>
	</executions>
	<dependencies>
		<dependency> <!--(1)-->
			<groupId>com.uniqueck</groupId>
			<artifactId>asciidoctorj-liquibase-extension</artifactId>
			<version>LATEST</version> <!--(2)-->
		</dependency>
	</dependencies>
</plugin>

1. asciidoctorj-liquibase-extension is added

2. check for the latest version at Maven central

How To Use

liquibase macro without attributes

liquibase::src/test/resources/db/db.changelog-master.xml[]

Figure 1. Generated image for liquibase macro

liquibase macro with attribute tillTag set to 1.X.FINAL

liquibase::src/test/resources/db/db.changelog-master.xml[tillTag=1.X.FINAL]

Figure 2. Generated image for liquibase macro with attribute tillTag

liquibase macro with attribute fileName set to diagram

liquibase::src/test/resources/db/db.changelog-master.xml[fileName = diagram]

liquibase macro with attribute outputFormat set to svg

liquibase::src/test/resources/db/db.changelog-master.xml[fileName = diagram, outputFormat = svg]

Attributes

• tillTag parse liquibase changeset files only until tagDatabase matched definied value

• fileName generates a diagram with the specified file name.

• outputFormat generates a diagram with the specified format. Only png and svg formats are supported.

Note: the fileName attribute has to be present for the output format to be considered.

ToDo

• Styling of PlantUML like Draw IO

• Support both styles of ERD

• Styling options

  • with or without datatypes

  • line connections

• see for grouping and associations http://plantuml.com/de/class-diagram

• see for entity relationship diagram http://plantuml.com/de/ie-diagram

• define how to detect cardinality of relationships

Versions

Version
0.1.1 Apr 5, 2021
0.1.0 Apr 5, 2021