pg-schema
Safe HaskellNone
LanguageGHC2021

PgSchema.Utils.GenDot

Description

Helper module: export a schema as DOT (Graphviz-style graphs). Useful for debugging and documenting a schema; not the primary API for database work through pg-schema.

It is exposed as a small utility; it could be made non-public in a future release. Avoid depending on it in compatibility-sensitive code unless you really need graph output.

Documentation

data DotOper Source #

Constructors

ExcludeToTab NameNS Text

Exclude relation to given table from DOT representation.

genDot Source #

Arguments

:: forall {k} (sch :: k). CSchema sch 
=> Bool

Whether to use qualified names

-> [DotOper]

Operations to exclude relations from DOT representation

-> Text