Since LILAM is a pure PL/SQL package, deploying and using it requires only a few simple steps.
The framework relies on the following database objects:
All objects are created automatically upon the first API call. Even if you choose custom names for the log tables (which can optionally be passed to the API), LILAM handles their creation on the fly. Please note that the sequence name is mandatory and must be provided.
Additionally, the schema user must have the necessary privileges. In most enterprise environments, these rights are already granted, as LILAM is designed to complement your existing PL/SQL applications.
If you are new to PL/SQL development or are using a fresh database user to test LILAM, you might need to perform a few Oracle-specific preparations first.
Execute the following grants to provide the user with the required privileges (requires SYSDBA or administrative rights):
-- Core Privileges (In-Session Mode)
GRANT CREATE SESSION TO USER_NAME;
GRANT CREATE TABLE TO USER_NAME;
GRANT CREATE SEQUENCE TO USER_NAME;
GRANT EXECUTE ON LILAM TO USER_NAME;
-- Server-based Privileges (Decoupled Mode)
GRANT EXECUTE ON DBMS_ALERT TO USER_NAME; -- Allows LILAM to send alerts
GRANT EXECUTE ON DBMS_PIPE TO USER_NAME;
-- Job Privileges (Background)
GRANT CREATE JOB TO USER_NAME; -- Required to run LILAM servers as background jobs
The package code is located within the source folder of each release. Alternatively, you can access it directly via https://github.com/dirkgermany/LILAM/tree/main/source/package.
lilam.pks (Package Specification) and lilam.pkb (Package Body).Once compiled, the package will appear in your database object tree (you may need to refresh the view).
Alternatively, run the scripts in the source folder with SQL*Plus or SQLcl while connected to the target schema:
@source/install.sql -- compiles the package and runs the life check
@source/uninstall.sql -- stops the LILAM server jobs and drops the package
By default uninstall.sql keeps all tables and data. To remove all LILAM tables, their data and the sequence as well, set define LILAM_DROP_DATA = 'J' at the top of the script. This cannot be undone.
Servers started with START_SERVER in a separate session are not stopped by the script; shut them down with SERVER_SHUTDOWN first.
After completing the setup steps, you can verify that LILAM is working correctly by running a quick health check:
-- Call the LILAM life check
EXECUTE lilam.is_alive;
-- Query the LILAM log data to verify automatic table creation
SELECT * FROM lilam_proc;
SELECT * FROM lilam_log;