CREATE OR REPLACE PACKAGE documentator
AS
/* **************************************
Set Dependencies
* **************************************/
PROCEDURE getRefObjects(
IN_OBJECT VARCHAR2,
IN_OBJECT_TYPE VARCHAR2);
/* **************************************
Get Table Dependencies
* **************************************/
PROCEDURE getTblRefObjects(
IN_OBJECT VARCHAR2,
IN_OBJECT_TYPE VARCHAR2);
/* **************************************
Get common object details
* **************************************/
PROCEDURE getTopObjectDetails(
IN_OBJECT VARCHAR2,
IN_OBJECT_TYPE VARCHAR2);
/* **************************************
Set Doc Header
* **************************************/
PROCEDURE setDocHeader(
IN_OBJECT VARCHAR2,
IN_OBJECT_TYPE VARCHAR2);
/* **************************************
Get all privileges
* **************************************/
PROCEDURE getUnitAllPrivs(IN_OBJECT VARCHAR2);
/* **************************************
Initialize variables
* **************************************/
PROCEDURE initDoc(IN_OBJECT VARCHAR2);
/* **************************************
Finish documents preparation and send emails
* **************************************/
PROCEDURE finishDoc(
IN_OBJECT VARCHAR2,
IN_FILE_NAME VARCHAR2,
IN_EMAIL VARCHAR2);
/* **************************************
Prepare document for Procedure/Function/Package
* **************************************/
PROCEDURE getPkgDoc(
IN_OBJECT VARCHAR2,
IN_FILE_NAME VARCHAR2);
/* **************************************
Prepare document for Table
* **************************************/
PROCEDURE getTblDoc(
IN_OBJECT VARCHAR2,
IN_OBJECT_TYPE VARCHAR2,
IN_FILE_NAME VARCHAR2);
/* **************************************
Main procedure to generate document
* **************************************/
PROCEDURE generateDocInfo(
IN_OBJECT VARCHAR2,
IN_FILE_NAME VARCHAR2,
IN_EMAIL VARCHAR2);
/* **************************************
Main procedure to generate document for all objects for the given object type
* **************************************/
PROCEDURE generateDocInfoByType(
IN_OBJECT_TYPE VARCHAR2,
IN_FILE_NAME VARCHAR2,
IN_EMAIL VARCHAR2);
/* **************************************
Main procedure to generate document for all objects for the given object types
* **************************************/
PROCEDURE generateDocInfoByTypes(
IN_OBJECT_TYPE VARCHAR2,
IN_FILE_NAME VARCHAR2,
IN_EMAIL VARCHAR2);
/* **************************************
Get list of procedures/functions with arguments
* **************************************/
PROCEDURE getArgumentsList(IN_OBJECT VARCHAR2);
/* **************************************
Get trigger columns
* **************************************/
PROCEDURE getTriggerColumns(IN_OBJECT VARCHAR2);
/* **************************************
Get trigger details
* **************************************/
PROCEDURE getTriggerDetails(IN_OBJECT VARCHAR2);
/* **************************************
Get PL/SQL unit Source
* **************************************/
PROCEDURE getUnitSource(
IN_OBJECT VARCHAR2,
IN_OBJECT_TYPE VARCHAR2);
/* **************************************
Get type status
* **************************************/
PROCEDURE getTypeStatus(
IN_OBJECT VARCHAR2,
IN_OBJECT_TYPE VARCHAR2);
/* **************************************
Get type attributes
* **************************************/
PROCEDURE getTypeAttrs(IN_OBJECT VARCHAR2);
/* **************************************
Get list of type methods
* **************************************/
PROCEDURE getTypeMethods(IN_OBJECT VARCHAR2);
/* **************************************
Get table columns
* **************************************/
PROCEDURE getTblCols(IN_OBJECT VARCHAR2);
/* **************************************
Get Table Constraints
* **************************************/
PROCEDURE getTblConstraints(IN_OBJECT VARCHAR2);
/* **************************************
Get all Table privileges
* **************************************/
PROCEDURE getTblPrivs(IN_OBJECT VARCHAR2);
/* **************************************
Get Table Indexes
* **************************************/
PROCEDURE getTblIndexes(IN_OBJECT VARCHAR2);
PROCEDURE sendEmailAttachments(
IN_FROM_EMAIL VARCHAR2,
IN_TO_EMAILS VARCHAR2,
IN_CC_EMAILS VARCHAR2,
IN_SUBJ VARCHAR2,
IN_TEXT CLOB,
IN_MIME_TYPE VARCHAR2 DEFAULT 'text/plain',
IN_FILENAME_1 VARCHAR2,
IN_CONTENT_1 CLOB,
IN_FILENAME_2 VARCHAR2 DEFAULT NULL,
IN_CONTENT_2 CLOB DEFAULT NULL,
IN_FILENAME_3 VARCHAR2 DEFAULT NULL,
IN_CONTENT_3 CLOB DEFAULT NULL);
END documentator;
/
show error
Package to generate HTML-type documentation for Oracle objects
0 comments:
Post a Comment