pslog.sql

pl/sql中记log的函数

(
    pCTX        IN  LOG_CTX                      -- Context
)
RETURN boolean;

/**
<B>Levels Management</B> : return true if default level is Info
*/
FUNCTION isInfoEnabled
RETURN boolean;



/**
<B>Levels Management</B> : return true if current level is Warn
*/
FUNCTION isWarnEnabled
(
    pCTX        IN  LOG_CTX                      -- Context
)
RETURN boolean;

/**
<B>Levels Management</B> : return true if default level is Warn
*/
FUNCTION isWarnEnabled
RETURN boolean;

/**
<B>Levels Management</B> : return true if current level is Error
*/
FUNCTION isErrorEnabled
(
    pCTX        IN LOG_CTX                      -- Context
)
RETURN boolean;

/**
<B>Levels Management</B> : return true if default level is Error
*/
FUNCTION isErrorEnabled
RETURN boolean;

/**
<B>Levels Management</B> : return true if current level is Fatal
*/
FUNCTION isFatalEnabled
(
    pCTX        IN LOG_CTX                      -- Context
)
RETURN boolean;

/**
<B>Levels Management</B> : return true if default level is Fatal
*/
FUNCTION isFatalEnabled
RETURN boolean;



/**
<B>Transactional management </B> : define a transaction mode<BR/> 
parameter transactional mode <BR/> 
TRUE => Log in transaction <BR/> 
FALSE => Log out off transaction <BR/> 
*/
PROCEDURE setTransactionMode
(
    pCTX          IN OUT NOCOPY LOG_CTX                      ,  -- Context
    inTransaction IN boolean default TRUE                       -- TRUE => Log in transaction 
                                                                -- FALSE => Log out off transaction 
);

/**
<B>Transactional management </B> : retun a transaction mode<BR/> 
TRUE => Log in transaction <BR/> 
FALSE => Log out off transaction <BR/> 
*/
FUNCTION getTransactionMode 
(
    pCTX        IN OUT NOCOPY LOG_CTX                      -- Context
)
RETURN boolean;
/**
<B>Transactional management </B> : retun a default transaction mode<BR/> 
TRUE => Log in transaction <BR/> 
FALSE => Log out off transaction <BR/> 
*/
FUNCTION getTransactionMode 
RETURN boolean;


/**
<B>USE_LOG4J management </B> : define a USE_LOG4J destination mode<BR/> 
TRUE => Log is send to log4j<BR/> 
FALSE => Log is not send to log4j<BR/> 
*/
PROCEDURE setUSE_LOG4JMode
(
    pCTX          IN OUT NOCOPY LOG_CTX                      ,  -- Context
    inUSE_LOG4J   IN boolean default TRUE                       -- TRUE => Log is send to USE_LOG4J
                                                                -- FALSE => Log is not send to USE_LOG4J 
);

/**
<B>USE_LOG4J management </B> : retun a USE_LOG4J mode<BR/> 
TRUE => Log is send to USE_LOG4J<BR/> 
FALSE => Log is not send to USE_LOG4J<BR/> 
*/
FUNCTION getUSE_LOG4JMode 
(
    pCTX        IN OUT NOCOPY LOG_CTX                      -- Context
)
RETURN boolean;
/**
<B>USE_LOG4J management </B> : retun a USE_LOG4J mode<BR/> 
TRUE => Log is send to USE_LOG4J<BR/> 
FALSE => Log is not send to USE_LOG4J<BR/> 
*/
FUNCTION getUSE_LOG4JMode 
RETURN boolean;


/**
<B>LOG_TABLE management </B> : define a LOG_TABLE destination mode<BR/> 
TRUE => Log is send to LOG_TABLE<BR/> 
FALSE => Log is not send to LOG_TABLE<BR/> 
*/
PROCEDURE setLOG_TABLEMode
(
    pCTX          IN OUT NOCOPY LOG_CTX                      ,  -- Context
    inLOG_TABLE       IN boolean default TRUE                   -- TRUE => Log is send to LOG_TABLE
                                                                -- FALSE => Log is not send to LOG_TABLE 
);

/**
<B>LOG_TABLE management </B> : retun a LOG_TABLE mode<BR/> 
TRUE => Log is send to LOG_TABLE<BR/> 
FALSE => Log is not send to LOG_TABLE<BR/> 
*/
FUNCTION getLOG_TABLEMode 
(
    pCTX        IN OUT NOCOPY LOG_CTX                      -- Context
)
RETURN boolean;
/**
<B>LOG_TABLE management </B> : retun a LOG_TABLE mode<BR/> 
TRUE => Log is send to LOG_TABLE<BR/> 
FALSE => Log is not send to LOG_TABLE<BR/> 
*/
FUNCTION getLOG_TABLEMode 
RETURN boolean;

/**
<B>LOG_ALERT management </B> : define a LOG_ALERT destination mode<BR/> 
TRUE => Log is send to LOG_ALERT<BR/> 
FALSE => Log is not send to LOG_ALERT<BR/> 
*/
PROCEDURE setLOG_ALERTMode
(
    pCTX          IN OUT NOCOPY LOG_CTX                           ,  -- Context
    inLOG_ALERT       IN boolean default TRUE                        -- TRUE => Log is send to LOG_ALERT
                                                                     -- FALSE => Log is not send to LOG_ALERT 
);

/**
<B>LOG_ALERT management </B> : retun a LOG_ALERT mode<BR/> 
TRUE => Log is send to LOG_ALERT<BR/> 
FALSE => Log is not send to LOG_ALERT<BR/> 
*/
FUNCTION getLOG_ALERTMode 
(
    pCTX        IN OUT NOCOPY LOG_CTX                      -- Context
)
RETURN boolean;
/**
<B>LOG_ALERT management </B> : retun a LOG_ALERT mode<BR/> 
TRUE => Log is send to LOG_ALERT<BR/> 
FALSE => Log is not send to LOG_ALERT<BR/> 
*/
FUNCTION getLOG_ALERTMode 
RETURN boolean;


/**
<B>LOG_TRACE management </B> : define a LOG_TRACE destination mode<BR/> 
TRUE => Log is send to LOG_TRACE<BR/> 
FALSE => Log is not send to LOG_TRACE<BR/> 
*/
PROCEDURE setLOG_TRACEMode
(
    pCTX          IN OUT NOCOPY LOG_CTX                           ,  -- Context
    inLOG_TRACE       IN boolean default TRUE                        -- TRUE => Log is send to LOG_TRACE
                                                                     -- FALSE => Log is not send to LOG_TRACE 
);

/**
<B>LOG_TRACE management </B> : retun a LOG_TRACE mode<BR/> 
TRUE => Log is send to LOG_TRACE<BR/> 
FALSE => Log is not send to LOG_TRACE<BR/> 
*/
FUNCTION getLOG_TRACEMode 
(
    pCTX        IN OUT NOCOPY LOG_CTX                      -- Context
)
RETURN boolean;
/**
<B>LOG_TRACE management </B> : retun a LOG_TRACE mode<BR/> 
TRUE => Log is send to LOG_TRACE<BR/> 
FALSE => Log is not send to LOG_TRACE<BR/> 
*/
FUNCTION getLOG_TRACEMode 
RETURN boolean;


/**
<B>DBMS_OUTPUT management </B> : define a DBMS_OUTPUT destination mode<BR/> 
TRUE => Log is send to DBMS_OUTPUT<BR/> 
FALSE => Log is not send to DBMS_OUTPUT<BR/> 
*/
PROCEDURE setDBMS_OUTPUTMode
(
    pCTX          IN OUT NOCOPY LOG_CTX                           ,  -- Context
    inDBMS_OUTPUT       IN boolean default TRUE                      -- TRUE => Log is send to DBMS_OUTPUT
                                                                     -- FALSE => Log is not send to DBMS_OUTPUT 
);

/**
<B>DBMS_OUTPUT management </B> : retun a DBMS_OUTPUT mode<BR/> 
TRUE => Log is send to DBMS_OUTPUT<BR/> 
FALSE => Log is not send to DBMS_OUTPUT<BR/> 
*/
FUNCTION getDBMS_OUTPUTMode 
(
    pCTX        IN OUT NOCOPY LOG_CTX                      -- Context
)
RETURN boolean;
/**
<B>DBMS_OUTPUT management </B> : retun a DBMS_OUTPUT mode<BR/> 
TRUE => Log is send to DBMS_OUTPUT<BR/> 
FALSE => Log is not send to DBMS_OUTPUT<BR/> 
*/
FUNCTION getDBMS_OUTPUTMode 
RETURN boolean;



/**
<B>assert</B> log a messge is pCondition is FALSE if pRaiseExceptionIfFALSE = TRUE the message is raise<BR/> 
@param     pCTX                     IN OUT NOCOPY LOG_CTX        -> Context
@param     pCONDITION               IN BOOLEAN                   -> error condition 
@param     pLogErrorMessageIfFALSE  IN VARCHAR2 default 'assert condition error' -> message if pCondition is true 
@param     pLogErrorCodeIfFALSE     IN NUMBER  default -20000    -> error code is pCondition is true range -20000 .. -20999  
@param     pRaiseExceptionIfFALSE   IN BOOLEAN default FALSE     -> if true raise pException_in if pCondition is true 
@param     pLogErrorReplaceError    IN BOOLEAN default FALSE     -> TRUE, the error is placed on the stack of previous errors. If FALSE (the default), the error replaces all previous errors (see Oracle Documentation RAISE_APPLICATION_ERROR)
@return log a messge if pCondition is FALSE. If pRaiseExceptionIfFALSE = TRUE the message is raise
*/
PROCEDURE assert (
    pCONDITION               IN BOOLEAN                                   , -- error condition 
    pLogErrorMessageIfFALSE  IN VARCHAR2 default 'assert condition error' , -- message if pCondition is true 
    pLogErrorCodeIfFALSE     IN NUMBER   default -20000                   , -- error code is pCondition is true range -20000 .. -20999  
    pRaiseExceptionIfFALSE   IN BOOLEAN  default FALSE                    , -- if true raise pException_in if pCondition is true 
    pLogErrorReplaceError    in BOOLEAN  default FALSE                      -- TRUE, the error is placed on the stack of previous errors. 
                                                                           -- If FALSE (the default), the error replaces all previous errors
                                                                           -- see Oracle Documentation RAISE_APPLICATION_ERROR
);
/**
<B>assert</B> log a messge is pCondition is FALSE if pRaiseExceptionIfFALSE = TRUE the message is raise<BR/> 
@param     pCTX                     IN OUT NOCOPY LOG_CTX        -> Context
@param     pCONDITION               IN BOOLEAN                   -> error condition 
@param     pLogErrorMessageIfFALSE  IN VARCHAR2 default 'assert condition error' -> message if pCondition is true 
@param     pLogErrorCodeIfFALSE     IN NUMBER  default -20000    -> error code is pCondition is true range -20000 .. -20999  
@param     pRaiseExceptionIfFALSE   IN BOOLEAN default FALSE     -> if true raise pException_in if pCondition is true 
@param     pLogErrorReplaceError    IN BOOLEAN default FALSE     -> TRUE, the error is placed on the stack of previous errors. If FALSE (the default), the error replaces all previous errors (see Oracle Documentation RAISE_APPLICATION_ERROR)
@return log a messge if pCondition is FALSE. If pRaiseExceptionIfFALSE = TRUE the message is raise

*/
PROCEDURE assert (
    pCTX                     IN OUT NOCOPY LOG_CTX                        , -- Context
    pCONDITION               IN BOOLEAN                                   , -- error condition 
    pLogErrorMessageIfFALSE  IN VARCHAR2 default 'assert condition error' , -- message if pCondition is true 
    pLogErrorCodeIfFALSE     IN NUMBER   default -20000                   , -- error code is pCondition is true range -20000 .. -20999  
    pRaiseExceptionIfFALSE   IN BOOLEAN  default FALSE                    , -- if true raise pException_in if pCondition is true 
    pLogErrorReplaceError    in BOOLEAN  default FALSE                      -- TRUE, the error is placed on the stack of previous errors. 
                                                                           -- If FALSE (the default), the error replaces all previous errors
                                                                           -- see Oracle Documentation RAISE_APPLICATION_ERROR
);

/**
<B>full_call_stack</B> log result of dbms_utility.format_call_stack<BR/> 
some time is necessary for debug code.
*/
PROCEDURE full_call_stack;
PROCEDURE full_call_stack (
    pCTX                     IN OUT NOCOPY LOG_CTX                       -- Context
);

/**
<B>getLOG4PLSQVersion</B> return a string with a current version<BR/> 
*/
FUNCTION getLOG4PLSQVersion return varchar2;


/**
<B>getLevelInText</B> return a string with a level in send in parameter<BR/> 
*/
FUNCTION getLevelInText (
    pLevel TLOG.LLEVEL%type default PLOGPARAM.DEFAULT_LEVEL 
) return varchar2;

/**
<B>getTextInLevel</B> return a level with a String in send in parameter<BR/> 
*/
FUNCTION getTextInLevel (
    pCode TLOGLEVEL.LCODE%type
) return  TLOG.LLEVEL%type ;


/**
<B>DBMS_PIPE_NAME management </B> 
*/
FUNCTION getDBMS_PIPE_NAME 
(
    pCTX        IN OUT NOCOPY LOG_CTX                      -- Context
)
RETURN varchar2;

FUNCTION getDBMS_PIPE_NAME 
RETURN varchar2;


PROCEDURE setDBMS_PIPE_NAME
(
    pCTX          IN OUT NOCOPY LOG_CTX                           ,  -- Context
    inDBMS_PIPE_NAME IN VARCHAR2
);


-------------------------------------------------------------------
-- 
-------------------------------------------------------------------
/**
<B>admin functionality </B> :  delete rows in table TLOG and commit
*/
PROCEDURE purge ;
PROCEDURE purge
(
    pCTX          IN OUT NOCOPY LOG_CTX                        -- Context
);

/**
<B>admin functionality </B> :  delete rows in table TLOG with date max and commit
*/
PROCEDURE purge
(
    pCTX          IN OUT NOCOPY LOG_CTX                      ,  -- Context
    DateMax       IN Date                                       -- All record to old as deleted
);

END PLOG;
/
/*<TOAD_FILE_CHUNK>*/

sho error

-------------------------------------------------------------------
-- End of document
-------------------------------------------------------------------