Shell Programming and Scripting

Hi All,

I am supposed to present the documentation for the PLSQL code (PACKAGES, PROCEDURE, FUNCTIONS) of my application. There are sufficient comments in my code. Has anyone written any Shell Script Utility which can parse the PLSQL code and generate some kind of document ( preferrably HTML not necessarily though ) ?

Any help / advice would be greatly appreciated.

regards
Gaurav

You can describe packages etc at the sql prompt, e.g...

Code:

SQL> desc sys.dbms_job;
Element            Type      
------------------ --------- 
ANY_INSTANCE       CONSTANT  
ISUBMIT            PROCEDURE 
SUBMIT             PROCEDURE 
REMOVE             PROCEDURE 
CHANGE             PROCEDURE 
WHAT               PROCEDURE 
NEXT_DATE          PROCEDURE 
INSTANCE           PROCEDURE 
INTERVAL           PROCEDURE 
BROKEN             PROCEDURE 
RUN                PROCEDURE 
USER_EXPORT        PROCEDURE 
BACKGROUND_PROCESS FUNCTION  
IS_JOBQ            FUNCTION  
 
SQL> desc sys.dbms_job.submit;
Parameter Type           Mode Default? 
--------- -------------- ---- -------- 
JOB       BINARY_INTEGER OUT           
WHAT      VARCHAR2       IN            
NEXT_DATE DATE           IN   Y        
INTERVAL  VARCHAR2       IN   Y        
NO_PARSE  BOOLEAN        IN   Y        
INSTANCE  BINARY_INTEGER IN   Y        
FORCE     BOOLEAN        IN   Y        
 
SQL>

: https://www.unix.com/shell-programmin...#post302280756
XXX wrote:
> present the documentation for PLSQL. Any script which can ...
> generate document[ation] -- preferrably HTML....

Hello Gaurav,

Your query has an <unhappy emoticon> next to it because
it is difficult to answer a technical question when _all_
information is not clearly provided and presented.

While it is true that Dana French wrote a ksh93 script
that implements a SQL (not PL/SQL!) database, I doubt this
is what you intend.

shql, kshSQL, kshSQL:
! Dana French Unix Korn Shell Curses Javascript Menu


What you want is presumably not a script or app, but
a software tool that can be invoked by a shell command.

"Parsing" is a very specific concept, and while _I_ have used
shellscript to parse language constructs, it is unlikely you
mean a parser, but probably a "prettyprinter," a "documentation
system," or a "literate programming" tool.

If what you desire is the first alternative, to have and
use a software tool to present a preformatted listing of a
given PL/SQL script, then you may investigate Genji

One of many, many documents that discusses this, (have
you done a search?) is:

PL/SQL, Java, JSP, and Javascript Code 'Beautifiers' (Reformatters)

("Formatter+" is now rolled into TOAD, which is now
commercialware; but, have you considered using the 30-
day trial versions of PL/SQL IDEs?)

My personal links collection contains these unchecked
entries:

"documentor.plsql": "generate HTML-type documentation for Oracle objects"
http://www.orafaq.com/scripts/plsql/documentator.zip

"Instant SQL Formatter": "SQL prettyprinter"
Instant SQL Formatter

"Instant SQL Formatter",2.6.2,Instant SQL Formatter

"SQLinForm.{class,exe}": "SQL & PL/SQL prettyprinter"
SQL Formatter / SQLFormatter formats SQL Statements

"PL/Formatter": "PL/SQL prettyprinter"

"SQL and PL/SQL Code Formatter": "prettyprint PL/SQL etal"
Online SQL and PL/SQL Formatter
^ http://www.orafaq.com/cgi-bin/sqlfor...lformatter.tpl
^ Instant SQL Formatter

"documentor.plsql": generate HTML-type documentation for Oracle objects"
http://www.orafaq.com/scripts/plsql/documentator.zip

As for options (2) and (3), Google the respective keywords
for many, many such choices.

BTW, why not have PL/SQL parse and generate its _own_
prettyprinted code into either HTML or PDF? I have not had
success finding the free and available packages I know are
available, but they should be findable through a dedicated search.

=Brian