scripts.plantuml.py Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of schemacrawler-scripting Show documentation
There is a newer version: 16.25.2
Show newest version
from __future__ import print_function
import re

print("@startuml")
print("""
!theme plain
hide empty methods

!procedure $schema($name, $slug)
package "$name" as $slug <>
!endprocedure

!procedure $table($name, $slug)
entity "$name" as $slug << (T, Orange) table >>
!endprocedure

!procedure $view($name, $slug)
entity "$name" as $slug << (V, Aquamarine) view >>
!endprocedure

!procedure $pk($name)
<&key> $name
!endprocedure

!procedure $fk($name)
<&key> $name
!endprocedure

!procedure $column($name)
{field} <&media-record> $name
!endprocedure

""")

print('title "' + title + '"')
print('')
print('legend bottom right')
print('generated by ' + catalog.crawlInfo.schemaCrawlerVersion.toString())
print('generated on ' + catalog.crawlInfo.crawlTimestamp)
print('end legend')
print('')
print('')

# Tables
for schema in catalog.getSchemas():
    if not catalog.getTables(schema):
        continue
    print('$schema("' + re.sub(r'\"', '', schema.fullName)  + '", "' + schema.key().slug() + '") {')
    print('')
    for table in catalog.getTables(schema):
        if not table.tableType.isView():
            print('$table', end='')
        else:
            print('$view', end='')
        print('("' + re.sub(r'\"', '', table.name) + '", "' + table.key().slug() + '") {')
        for column in table.columns:
            if column.isPartOfPrimaryKey():
                print('  $pk', end='')
            elif column.isPartOfForeignKey():
                print('  $fk', end='')
            else:
                print('  $column', end='')
            print('("' + column.name + '"): ' + column.columnDataType.name, end='')
            print(' ', end='')
            if not column.nullable:
                print('NOT NULL', end='')
            print('')
        print('}')
        print('')
        if table.remarks:
            print('note left of ' + table.key().slug() + ' #LemonChiffon')
            print(table.remarks)
            print('end note')
            print('')
        for column in table.columns:
            if column.remarks:
                print('note right of ' + table.key().slug() + '::' + column.name \
                    + ' #LightCyan')
                print(column.remarks)
                print('end note')
                print('')
        print('')
        print('')
    print('')
    print('}')
    print('')
    print('')

# Foreign keys
for table in catalog.tables:
    for fk in table.exportedForeignKeys:
        pkTable = fk.primaryKeyTable
        fkTable = fk.foreignKeyTable
        for columnReference in fk.columnReferences:
            pkColumn = columnReference.primaryKeyColumn
            fkColumn = columnReference.foreignKeyColumn
            print('' \
                  + pkTable.schema.key().slug() + '.'
                  + pkTable.key().slug() + '::'
                  + re.sub(r'\"', '', pkColumn.name)
                  + '  ||--o{ ' \
                  + fkTable.schema.key().slug() + '.'
                  + fkTable.key().slug() + '::'
                  + re.sub(r'\"', '', fkColumn.name)
                  , end='')
            if fk.name and not fk.name.startswith('SCHCRWLR_'):
                print(' : '
                      + fk.name, end='')
            print('')
print('')

print("@enduml")