Repository: rm-hull/sql_graphviz
Branch: master
Commit: c8f41fd6e671
Files: 6
Total size: 9.7 KB

Directory structure:
gitextract_ytcvt0ow/

├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.md
├── Pipfile
├── README.md
└── sql_graphviz.py

================================================
FILE CONTENTS
================================================

================================================
FILE: .gitignore
================================================
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]

# C extensions
*.so

# Distribution / packaging
.Python
env/
bin/
build/
develop-eggs/
dist/
eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
.venv

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.cache
nosetests.xml
coverage.xml

# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject

# Rope
.ropeproject

# Django stuff:
*.log
*.pot

# Sphinx documentation
docs/_build/



================================================
FILE: CONTRIBUTING.md
================================================
# Contributing

Pull requests (code changes / documentation / typos / feature requests / setup)
are gladly accepted. If you are intending to introduce some large-scale
changes, please get in touch first to make sure we're on the same page: try to
include a docstring for any new method or class, and keep method bodies small,
readable and PEP8-compliant.

## GitHub
The source code is available to clone at: https://github.com/rm-hull/sql_graphviz

## Contributors
* Wouter De Borger (@wouterdb)
* Lev Alexandrovich Neiman (@lan17)
* Max Franke (@mfranke93)
* Greg Brown (@gregplaysguitar)
* @l0r3m1psum
* Luke Shumaker
* Alex Khomenko (@khomenko)
* _could be you?_


================================================
FILE: LICENSE.md
================================================
# The MIT License (MIT)

Copyright (c) 2014 Richard Hull

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

================================================
FILE: Pipfile
================================================
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]

[packages]
pyparsing = "*"

[requires]
python_version = "3.8"


================================================
FILE: README.md
================================================
# SQL Graphviz
[![Maintenance](https://img.shields.io/maintenance/yes/2021.svg?maxAge=2592000)]()

SQL Graphviz is a small python 3 script that generates a [Graphviz](http://www.graphviz.org/)
visualization of a SQL schema dump.

### Dependencies

SQL Graphviz relies on [pyparsing](https://pypi.python.org/pypi/pyparsing/2.0.3) to grok
the schema dump. Ubuntu users should install using:

    $ sudo apt-get install python3-pyparsing

while CheeseShop frequenters should install with pip:

    $ sudo pip3 install pyparsing

Arch linux users can install the dependencies like this:

    $ sudo pacman -S python-pyparsing

Alternatively, using **pipenv** as follows (ensure it is installed first):

    $ pipenv install
    $ pipenv shell

### Usage

Using PostgreSQL, for example, to generate as a PNG file:

    $ pg_dump --schema-only dbname | python sql_graphviz.py | dot -Tpng > graph.png

The program will accept a named file, or if omitted as above, will take from stdin.
Output to SVG:

    $ pg_dump --schema-only dbname > dump.sql
    $ python sql_graphviz.py dump.sql > graph.dot
    $ dot -Tsvg graph.dot > graph.svg

### Example

![SVG](https://rawgithub.com/rm-hull/sql_graphviz/master/example.svg)

## Credits

Extended from http://energyblog.blogspot.co.uk/2006/04/blog-post_20.html by [EnErGy [CSDX]](https://www.blogger.com/profile/09096585177254790874)

## References

* http://pythonhosted.org/pyparsing/

## The MIT License (MIT)

Copyright (c) 2014 Richard Hull & EnErGy [CSDX]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


================================================
FILE: sql_graphviz.py
================================================
#!/usr/bin/env python

import html
import sys
from datetime import datetime
from pyparsing import (
    alphas,
    alphanums,
    CaselessLiteral,
    Word,
    Forward,
    OneOrMore,
    ZeroOrMore,
    CharsNotIn,
    Suppress,
    QuotedString,
    Optional
)


def field_act(s, loc, tok):
    fieldName = tok[0].replace('"', '')
    fieldSpec = html.escape(' '.join(tok[1::]).replace('"', '\\"'))
    # Don't try and format this HTML text string - DOT files are whitespace sensitive
    return '''<tr><td bgcolor="grey96" align="left" port="{0}"><font face="Times-bold"> {0} </font></td><td align="left" port="{0}_right"><font color="#535353"> {1} </font></td></tr>'''.format(fieldName, fieldSpec)


def field_list_act(s, loc, tok):
    return "\n        ".join(tok)


def create_table_act(s, loc, tok):
    # Don't try and format this HTML text string - DOT files are whitespace sensitive
    return '''
    "{tableName}" [
    shape=none
    label=<
      <table border="0" cellspacing="0" cellborder="1">
        <tr><td bgcolor="lightblue2" colspan="2"><font face="Times-bold" point-size="20"> {tableName} </font></td></tr>
        {fields}
      </table>
    >];'''.format(**tok)


def add_fkey_act(s, loc, tok):
    return "\n".join(
        '  "{tableName}":{keyName}_right -> "{fkTable}":{fkCol}'.format(**{
            **tok,
            "keyName": tok['keyName'][i],
            "fkCol": tok['fkCol'][i],
        })
        for i in range(0, len(tok['keyName']))
    )


def other_statement_act(s, loc, tok):
    return ""


def join_string_act(s, loc, tok):
    return "".join(tok).replace('\n', '\\n')


def quoted_default_value_act(s, loc, tok):
    return tok[0] + " " + "".join(tok[1::])


def grammar():
    parenthesis = Forward()
    parenthesis <<= "(" + ZeroOrMore(CharsNotIn("()") | parenthesis) + ")"
    parenthesis.setParseAction(join_string_act)

    quoted_string = "'" + OneOrMore(CharsNotIn("'")) + "'"
    quoted_string.setParseAction(join_string_act)

    quoted_default_value = (CaselessLiteral("DEFAULT")
        + quoted_string
        + OneOrMore(CharsNotIn(", \n\t")))
    quoted_default_value.setParseAction(quoted_default_value_act)

    field_def = OneOrMore(quoted_default_value
        | Word(alphanums + "_\"'`:-/[].")
        | parenthesis)
    field_def.setParseAction(field_act)

    tablename_def = (Word(alphanums + "`_.") | QuotedString("\""))

    field_list_def = field_def + ZeroOrMore(Suppress(",") + field_def)
    field_list_def.setParseAction(field_list_act)

    create_table_def = (CaselessLiteral("CREATE")
        + Optional(CaselessLiteral("UNLOGGED"))
        + CaselessLiteral("TABLE")
        + Optional(CaselessLiteral("IF NOT EXISTS"))
        + tablename_def.setResultsName("tableName")
        + "(" + field_list_def.setResultsName("fields") + ")"
        + ";")
    create_table_def.setParseAction(create_table_act)

    delete_restrict_action = (CaselessLiteral("CASCADE")
        | CaselessLiteral("RESTRICT")
        | CaselessLiteral("NO ACTION")
        | ( CaselessLiteral("SET")
            + ( CaselessLiteral("NULL") | CaselessLiteral("DEFAULT") )))

    fkey_cols = (
        Word(alphanums + "._")
        + ZeroOrMore(Suppress(",") + Word(alphanums + "._"))
    )

    add_fkey_def = (CaselessLiteral("ALTER")
        + CaselessLiteral("TABLE")
        + Optional(CaselessLiteral("ONLY"))
        + tablename_def.setResultsName("tableName")
        + CaselessLiteral("ADD")
        + CaselessLiteral("CONSTRAINT")
        + (Word(alphanums + "_") | QuotedString("\""))
        + CaselessLiteral("FOREIGN")
        + CaselessLiteral("KEY")
        + Optional(CaselessLiteral("IF NOT EXISTS"))
        + "(" + fkey_cols.setResultsName("keyName") + ")"
        + CaselessLiteral("REFERENCES") + tablename_def.setResultsName("fkTable")
        + "(" + fkey_cols.setResultsName("fkCol") + ")"
        + Optional(CaselessLiteral("DEFERRABLE"))
        + Optional(CaselessLiteral("ON") + "UPDATE" + delete_restrict_action)
        + Optional(CaselessLiteral("ON") + "DELETE" + delete_restrict_action)
        + ";")
    add_fkey_def.setParseAction(add_fkey_act)

    other_statement_def = OneOrMore(CharsNotIn(";")) + ";"
    other_statement_def.setParseAction(other_statement_act)

    comment_def = "--" + ZeroOrMore(CharsNotIn("\n"))
    comment_def.setParseAction(other_statement_act)

    return OneOrMore(
        comment_def
        | create_table_def
        | add_fkey_def
        | other_statement_def
    )


def graphviz(filename):
    print("/*")
    print(" * Graphviz of '%s', created %s" % (filename, datetime.now()))
    print(" * Generated from https://github.com/rm-hull/sql_graphviz")
    print(" */")
    print("digraph g { graph [ rankdir = \"LR\" ];")

    for i in grammar().setDebug(False).parseFile(filename):
        if i != "":
            print(i)
    print("}")

if __name__ == '__main__':
    filename = sys.stdin if len(sys.argv) == 1 else sys.argv[1]
    graphviz(filename)