HyperSQL

Description

HyperSQL is like a doxygen plus javadoc for SQL, hypermapping SQL views, packages, procedures, and functions to HTML source code listings and showing all code locations where these are used, while some basic syntax highlighting is applied to the SQL code. The internal "where used" functionality also scans C++ and Java source files.

History

The original version (1.0) was written by Randy Phillips in September 2001. A customer of mine required a script like this, but some additions were required as well. At this time, the latest release was version 1.0 from 2001, and no update was ever published since (see  original project site). It also looked very much like Randy abandoned the project.

So I decided to adopt the project at least temporarily (after establishing contact with Randy, he decided to hand over the project to me completely). It was (and still is) using the GPL, so there were no problems from the license side. As said, I very much liked the idea of HyperSQL, but felt it needs some polish. So on one day in February 2010, I sat down and wrote version 1.1.. Versions 1.2 and 1.3 followed the next day - and as you can see here, development still goes on. You can find the always latest code via the code browser tab on top of this page - or get the latest release via our Download page.

Features

• flexible configuration by use of .ini files
• offering a lot of command line options to override configuration options on-the-fly
• generates nicely formatted HTML files, CSS adjustable by use of .css files
• parses SQL, C++ and Java files according to file extensions you configured
• parses Oracle Forms XML files
• generates hyperlinked listings of all objects found (SQL views, packages, functions, procedures, forms, etc.)
• hyperlinks object names to their appearance in the source code
• generates "where used" and "what used" lists, to show where your objects have been used by other objects (if they have) - helps you to find unused code if not, or example usages if found
• generates dependency graphs
• generates API references from JavaDoc style comments
• generates a central bug and a central todo list, compiled from all the @bug and @todo items in your JavaDoc comments
• checks validity of your JavaDoc style comments up to a certain degree, and you even may define "mandatory tags"
• generates XML for UnitTests from your JavaDoc-embedded @testcases

Future

I cannot promise anything. It could very well be my development stops as well at some day. But I will try my very best.

So what is planned? Since this probably will change permanently, I rather point you to the roadmap and tickets for the answer. If you miss something there (or found a bug), feel free to add a request at this place! If you miss something, or find some bug: Feel free to use the ticket system to let me know about.