| LEHS - Log- and Exception Handling System for ORACLE | |||||
FRAMES NO FRAMES | ||||||
SUMMARY: FIELD | TYPE | METHOD | DETAIL: FIELD | TYPE | METHOD |
This is an Appender Package for LEHS. Look at
PKG_LEHS_APPENDER
on more detailed Information about developing an Appender Package.
PKG_LEHS_SYSTEM.register_appender
).
LEHS_LOG_TABLE_BASIC
and the Log Transactions to the Tables
LEHS_TRANSACTIONS
and LEHS_TRANSACTION_KEYS
.
These saved Log-Informations are provided by these Views:
original Table | providing View | public Synonym |
---|---|---|
LEHS_LOG_TABLE_BASIC |
LEHS_LOGS_VIEW |
LEHS_LOGS |
LEHS_TRANSACTIONS LEHS_TRANSACTION_KEYS
|
LEHS_TRANSACTION_VIEW |
LEHS_TRANSACTIONS |
Parameter Name | Datatype | valid Values | Description |
---|---|---|---|
RETENTION_TIME |
PKG_LEHS_APPENDER.pst_param_value_number |
0 - 99999. 0 = infinite Retention Time (Default) |
Retention Time (in Minutes) of the Log-Entries |
REMOVE_UNUSED_TRANSACTIONS |
PKG_LEHS_APPENDER.pst_param_value_clob |
|
Should unused Transactions (created Transactions without any Log-Messages) also be removed regardless of the Retention Time? |
REMOVE_LOGS_IN_OPEN_TRX |
PKG_LEHS_APPENDER.pst_param_value_clob |
|
Should Log-Entries, whose Log-Transaction is in an open State, also be removed? |
Field Summary | |
PKG_LEHS_APPENDER.pst_parameter_name | pc_param_remove_open_logs
Parameter Name: REMOVE_LOGS_IN_OPEN_TRX
|
PKG_LEHS_APPENDER.pst_parameter_name | pc_param_remove_unused_trx
Parameter Name: REMOVE_UNUSED_TRANSACTIONS
|
PKG_LEHS_APPENDER.pst_parameter_name | pc_param_retention_time
Parameter Name: RETENTION_TIME
|
Method Summary | |
| add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_transaction BINARY_INTEGER, pi_key VARCHAR2, pi_value CLOB)
Adds a new or change an existing Transaction Key on Table LEHS_TRANSACTION_KEYS . |
| add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_transaction BINARY_INTEGER, pi_key VARCHAR2, pi_value NUMBER)
Adds a new or change an existing Transaction Key on Table LEHS_TRANSACTION_KEYS . |
| add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_transaction BINARY_INTEGER, pi_key VARCHAR2, pi_value DATE)
Adds a new or change an existing Transaction Key on Table LEHS_TRANSACTION_KEYS . |
| add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_transaction BINARY_INTEGER, pi_key VARCHAR2, pi_value TIMESTAMP_UNCONSTRAINED)
Adds a new or change an existing Transaction Key on Table LEHS_TRANSACTION_KEYS . |
| add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_transaction BINARY_INTEGER, pi_key VARCHAR2, pi_value DSINTERVAL_UNCONSTRAINED)
Adds a new or change an existing Transaction Key on Table LEHS_TRANSACTION_KEYS . |
| add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_transaction BINARY_INTEGER, pi_key VARCHAR2, pi_value YMINTERVAL_UNCONSTRAINED)
Adds a new or change an existing Transaction Key on Table LEHS_TRANSACTION_KEYS . |
| check_param(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_name PKG_LEHS_APPENDER.pst_parameter_name, pi_value PKG_LEHS_APPENDER.pst_param_value_number)
Checks the Value of an Appender Parameter. |
| check_param(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_name PKG_LEHS_APPENDER.pst_parameter_name, pi_value PKG_LEHS_APPENDER.pst_param_value_clob)
Checks the Value of an Appender Parameter. |
| cleanup(pi_application PKG_LEHS_APPENDER.pst_application_name)
Cleans up the internal used Buffer for the Log-Application |
| end_log_transaction(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_transaction BINARY_INTEGER)
Updates the Transaction ID at Table LEHS_TRANSACTIONS
to be closed (set the closed Timestamp). |
| log(pi_log_line PKG_LEHS_APPENDER.pr_log_line)
Adds a single Log-Entry to the Table LEHS_LOG_TABLE_BASIC
|
| maintain_tables()
Maintenance of the Log Entries. |
| register(pi_application PKG_LEHS_APPENDER.pst_application_name)
Creates a Partition or reuse an existing Partition on the Table LEHS_LOG_TABLE_BASIC . |
| set_param(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_name PKG_LEHS_APPENDER.pst_parameter_name, pi_value PKG_LEHS_APPENDER.pst_param_value_number)
Sets the registered Appender Parameter during the Initialization of the Appender |
| set_param(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_name PKG_LEHS_APPENDER.pst_parameter_name, pi_value PKG_LEHS_APPENDER.pst_param_value_clob)
Sets the registered Appender Parameter during the Initialization of the Appender |
| start_log_transaction(pi_application PKG_LEHS_APPENDER.pst_application_name, pi_transaction BINARY_INTEGER)
Adds a new Log-Transaction to the Table LEHS_TRANSACTIONS
|
Field Detail |
public PKG_LEHS_APPENDER.pst_parameter_name pc_param_retention_time
RETENTION_TIME
public PKG_LEHS_APPENDER.pst_parameter_name pc_param_remove_unused_trx
REMOVE_UNUSED_TRANSACTIONS
public PKG_LEHS_APPENDER.pst_parameter_name pc_param_remove_open_logs
REMOVE_LOGS_IN_OPEN_TRX
Method Detail |
public register(pi_application PKG_LEHS_APPENDER.pst_application_name)
LEHS_LOG_TABLE_BASIC
.
If this Package will be registered as an Appender by
PKG_LEHS_SYSTEM.register_appender
then this Procedure
will be called (see PKG_LEHS_APPENDER
for more Details on Appender Packages).
If the Table LEHS_LOG_TABLE_BASIC
is list partitioned by
the Column APPLICATION
, then this Procedure either creates
a new Partition named as the Log-Application or it reuses an existing
Partition, where the Log-Application exists within the Value-List of
this existing Partition.
pi_application
-
Name of the Log-Application this Package will
be registered to as an AppenderORA-20001
-
[MANDATORY PARAMETER MISSING] A mandatory Parameter is missingORA-20032
-
[INVALID APPLICATION NAME] The Name of the Log-Application
is invalid to be used by this Appender PackageORA-20033
-
[APPLICATION NOT SERVED BY PARTITION] The Log-Application
is not serviced by the Partition-List of the Partition
named as the Log-Applicationpublic check_param(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_name PKG_LEHS_APPENDER.pst_parameter_name,
pi_value PKG_LEHS_APPENDER.pst_param_value_number)
PKG_LEHS_SYSTEM.set_appender_parameter
pi_application
-
Name of the Log-Applicationpi_name
-
Name of the Appender Parameterpi_value
-
Value of the Appender ParameterORA-20009
-
[INVALID APPENDER PARAMETER NAME] Invalid Parameter
Name or Datatype of this Parameter is invalidORA-20009
-
[FAILED ASSERTION FOR APPENDER PARAMETER WITH REASON]
The Value of the Parameter is invalidpublic check_param(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_name PKG_LEHS_APPENDER.pst_parameter_name,
pi_value PKG_LEHS_APPENDER.pst_param_value_clob)
PKG_LEHS_SYSTEM.set_appender_parameter
pi_application
-
Name of the Log-Applicationpi_name
-
Name of the Appender Parameterpi_value
-
Value of the Appender ParameterORA-20009
-
[INVALID APPENDER PARAMETER NAME] Invalid Parameter
Name or Datatype of this Parameter is invalidORA-20009
-
[FAILED ASSERTION FOR APPENDER PARAMETER WITH REASON]
The Value of the Parameter is invalidpublic set_param(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_name PKG_LEHS_APPENDER.pst_parameter_name,
pi_value PKG_LEHS_APPENDER.pst_param_value_number)
pi_application
-
Name of the Log-Applicationpi_name
-
Name of the Appender Parameterpi_value
-
Value of the Appender Parameterpublic set_param(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_name PKG_LEHS_APPENDER.pst_parameter_name,
pi_value PKG_LEHS_APPENDER.pst_param_value_clob)
pi_application
-
Name of the Log-Applicationpi_name
-
Name of the Appender Parameterpi_value
-
Value of the Appender Parameterpublic log(pi_log_line PKG_LEHS_APPENDER.pr_log_line)
LEHS_LOG_TABLE_BASIC
pi_log_line
-
Log Information provided by LEHSpublic cleanup(pi_application PKG_LEHS_APPENDER.pst_application_name)
pi_application
-
Name of the Log-Applicationpublic start_log_transaction(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_transaction BINARY_INTEGER)
LEHS_TRANSACTIONS
pi_application
-
Name of the Log-Applicationpi_transaction
-
created Transaction IDpublic end_log_transaction(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_transaction BINARY_INTEGER)
LEHS_TRANSACTIONS
to be closed (set the closed Timestamp).
pi_application
-
Name of the Log-Applicationpi_transaction
-
Transaction ID to be closedpublic add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_transaction BINARY_INTEGER,
pi_key VARCHAR2,
pi_value CLOB)
LEHS_TRANSACTION_KEYS
.
If a NULL-Value is given then the existing Transaction Key would be
removed from Table LEHS_TRANSACTION_KEYS
.
pi_application
-
Name of the Log-Applicationpi_transaction
-
existing Transaction IDpi_key
-
Name of the Transaction Keypi_value
-
Value of the Transaction Keypublic add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_transaction BINARY_INTEGER,
pi_key VARCHAR2,
pi_value NUMBER)
LEHS_TRANSACTION_KEYS
.
If a NULL-Value is given then the existing Transaction Key would be
removed from Table LEHS_TRANSACTION_KEYS
.
pi_application
-
Name of the Log-Applicationpi_transaction
-
existing Transaction IDpi_key
-
Name of the Transaction Keypi_value
-
Value of the Transaction Keypublic add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_transaction BINARY_INTEGER,
pi_key VARCHAR2,
pi_value DATE)
LEHS_TRANSACTION_KEYS
.
If a NULL-Value is given then the existing Transaction Key would be
removed from Table LEHS_TRANSACTION_KEYS
.
pi_application
-
Name of the Log-Applicationpi_transaction
-
existing Transaction IDpi_key
-
Name of the Transaction Keypi_value
-
Value of the Transaction Keypublic add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_transaction BINARY_INTEGER,
pi_key VARCHAR2,
pi_value TIMESTAMP_UNCONSTRAINED)
LEHS_TRANSACTION_KEYS
.
If a NULL-Value is given then the existing Transaction Key would be
removed from Table LEHS_TRANSACTION_KEYS
.
pi_application
-
Name of the Log-Applicationpi_transaction
-
existing Transaction IDpi_key
-
Name of the Transaction Keypi_value
-
Value of the Transaction Keypublic add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_transaction BINARY_INTEGER,
pi_key VARCHAR2,
pi_value DSINTERVAL_UNCONSTRAINED)
LEHS_TRANSACTION_KEYS
.
If a NULL-Value is given then the existing Transaction Key would be
removed from Table LEHS_TRANSACTION_KEYS
.
pi_application
-
Name of the Log-Applicationpi_transaction
-
existing Transaction IDpi_key
-
Name of the Transaction Keypi_value
-
Value of the Transaction Keypublic add_transaction_key(pi_application PKG_LEHS_APPENDER.pst_application_name,
pi_transaction BINARY_INTEGER,
pi_key VARCHAR2,
pi_value YMINTERVAL_UNCONSTRAINED)
LEHS_TRANSACTION_KEYS
.
If a NULL-Value is given then the existing Transaction Key would be
removed from Table LEHS_TRANSACTION_KEYS
.
pi_application
-
Name of the Log-Applicationpi_transaction
-
existing Transaction IDpi_key
-
Name of the Transaction Keypi_value
-
Value of the Transaction Keypublic maintain_tables()
LEHS_LOG_TABLE_BASIC
,
LEHS_TRANSACTIONS
and LEHS_TRANSACTION_KEYS
) in
accordance to the registered Appender Parameters for every Log-Application
this Package has been registered to as an Appender
The maintenance follows these Rules:
RETENTION_TIME
is set to 0 then
no Rows will be removed from neither the Table
LEHS_LOG_TABLE_BASIC
nor from the Tables
LEHS_TRANSACTIONS
and LEHS_TRANSACTION_KEYS
LEHS_LOG_TABLE_BASIC
, whose
Log-Time is older than SYSDATE - RETENTION_TIME
will
be removed unless it is in an open Transaction. (if the Parameter
REMOVE_LOGS_IN_OPEN_TRX
is set to FALSE
)
REMOVE_LOGS_IN_OPEN_TRX
is set to
TRUE
then every Entry at the Table
LEHS_LOG_TABLE_BASIC
, whose Log-Time is older than
SYSDATE - RETENTION_TIME
will be removed regardless
if it is in an open Transaction.
LEHS_LOG_TABLE_BASIC
will be removed from
the Tables LEHS_TRANSACTIONS
and
LEHS_TRANSACTION_KEYS
(if the Parameter
REMOVE_UNUSED_TRANSACTIONS
is set to FALSE
)
REMOVE_UNUSED_TRANSACTIONS
is set to
TRUE
then all Transactions, which have no relation to
any Log-Entry at Table LEHS_LOG_TABLE_BASIC
will be
removed from the Tables LEHS_TRANSACTIONS
and
LEHS_TRANSACTION_KEYS
.
| LEHS - Log- and Exception Handling System for ORACLE | |||||
FRAMES NO FRAMES | ||||||
SUMMARY: FIELD | TYPE | METHOD | DETAIL: FIELD | TYPE | METHOD |