Sergey Shkarupa sshkarupa

Create Nice-looking Schema Diagrams in PlantUML

PlantUML is a descriptive language to generate a number of types of software diagrams, such as sequence, class, deployment and state diagrams, and many others. PlantUML does not generate very good-looking schema diagrams out of the box, but it supports themes and preprocessed macros. If you use themes and macros, you can not only use a simplified syntax, but also generate beautiful diagrams.

Here is an example of a PlantUML schema diagram, and we will build up the code to generate it.

To start, describe your schemas, tables and columns using this syntax as an example.

People

`:bowtie:`	😄 `:smile:`	😆 `:laughing:`
😊 `:blush:`	😃 `:smiley:`	☺️ `:relaxed:`
😏 `:smirk:`	😍 `:heart_eyes:`	😘 `:kissing_heart:`
😚 `:kissing_closed_eyes:`	😳 `:flushed:`	😌 `:relieved:`
😆 `:satisfied:`	😁 `:grin:`	😉 `:wink:`
😜 `:stuck_out_tongue_winking_eye:`	😝 `:stuck_out_tongue_closed_eyes:`	😀 `:grinning:`
😗 `:kissing:`	😙 `:kissing_smiling_eyes:`	😛 `:stuck_out_tongue:`

	@startuml
	' uncomment the line below if you're using computer with a retina display
	' skinparam dpi 300
	!define Table(name,desc) class name as "desc" << (T,#FFAAAA) >>
	' we use bold for primary key
	' green color for unique
	' and underscore for not_null
	!define primary_key(x) <b>x</b>
	!define unique(x) <color:green>x</color>
	!define not_null(x) <u>x</u>

	defmodule Randomizer do
	@moduledoc """
	Random string generator module.
	"""

	@doc """
	Generate random string based on the given legth. It is also possible to generate certain type of randomise string using the options below:

	* :all - generate alphanumeric random string
	* :alpha - generate nom-numeric random string

	# UPD from 2018:
	# This gist was written for pre-1.0 version of Elixir and won't work on post-1.0 versions.
	# You probably consider using something else!

	defmodule SecureRandom do
	@moduledoc """
	Ruby-like SecureRandom module.

	## Examples

	# Simple bijective function
	# Basically encodes any integer into a base(n) string,
	# where n is ALPHABET.length.
	# Based on pseudocode from http://stackoverflow.com/questions/742013/how-to-code-a-url-shortener/742047#742047

	ALPHABET =
	"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789".split(//)
	# make your own alphabet using:
	# (('a'..'z').to_a + ('A'..'Z').to_a + (0..9).to_a).shuffle.join

	defmodule SqlParser do
	def run() do
	input = "select col1 from (
	select col2, col3 from (
	select col4, col5, col6 from some_table
	)
	)
	"
	IO.puts("input: #{inspect(input)}\n")
	IO.inspect(parse(input))

	tap "heroku/brew"
	tap "homebrew/bundle"
	tap "homebrew/cask"
	tap "homebrew/cask-versions"
	tap "homebrew/core"
	tap "heroku/brew"
	brew "ansible"
	brew "asdf"
	brew "awscli"
	brew "fish"

	require 'sidekiq/api'

	# 1. Clear retry set

	Sidekiq::RetrySet.new.clear

	# 2. Clear scheduled jobs

	Sidekiq::ScheduledSet.new.clear