tapiGen2

PL/SQL Table API Generator for Oracle

tapiGen2 aims to automate the creation of PLSQL TABLE APIs. You can use the online version

A table API is a data access layer that provides the basic CRUD operations for a single table. The key principle is to avoid repetition of SQL statements and consequently make it easier to optimize, maintain, and enhance those statements. For this reason, a data access layer is critical. Some of us build apps that perform DML on individual tables, and so we find TAPIs useful.

• Let's start
  
• What's New
  
• Getting started
  
  • Install
    
  • Usage
    
• Functions and procedures included
  
• Procedure description
  
• Special Thanks
  
• Contributing
  
• License

Let's start

Let's start by taking a look at a single row fetch, using its id - a very common operation.

This would be typically done in 4 lines of code:

SELECT *
INTO l_table_rec
FROM table_name
WHERE id = l_var_with_id;

Although it's easy enough to write, there are few problems with this approach.

1. This implicit cursor introduces a possible NO_DATA_FOUND exception that should be handled - that means more code. Explicit cursors would also require more code.
2. Each statement written like this, must be maintained, hence, if the table name is changed then all the statements must be updated.
3. If any of the statements written for this purpose are not written exactly in the same way, Oracle may take a little longer to execute them.

The RT function in tapiGen was created for this very purpose and is used as follows:

l_table_rec := table_name_te.rt(l_var_with_id);

That's it, one line! Granted there are many more lines behind the scenes, but you did not have to write them nor must you maintain them. Errors are handled, maintenance is easier, and if everyone uses this function, performance is better. If you're using Oracle 11g, the function cache will be used for subsequent calls.

What's New in tapiGen2

tapiGen2 uses the template engine tePLSQL that simplifies the creation of code and allows it to be easily customizable.

It also adds new features to the generated API, and some of them are modified. Now, as an option, the framework logger is used for exception handling

Also, it includes:

• Single column primary key restriction has been deleted. Now the primary key can contain from 0 to N columns. If the table has no primary key, parameter unique_key must be not null.
• The tt PIPELINED function has been implemented. This returns an array of records and standardizes access to the tables, without losing the ability to make queries directly.
• DML operations, based on the rowid, have been created to facilitate their use by API clients. upd_rowid, web_upd_rowid, del_rowid and web_del_rowid
• Audit columns will be injected as parameters and won't be mandatory.
• Tables won't require a sequence restriction. In case that the used table has one, the code will have to be modified to add the nextval() statement. Under construction.
• SHA1 is used instead of MD5 hash, in Oracle 12c we will use SHA256.
• The put_apex_form_code procedure has been removed.

Getting started

Install

Clone the repo and install:

git clone https://github.com/osalvador/tapiGen2.git
cd tapiGen2/source/install
sqlplus "user/userpass"@SID @tapigen2_install

Execute on DBMS_CRYPTO grant is necessary.

Uninstall

Clone the repo and uninstall:

git clone https://github.com/osalvador/tapiGen2.git
cd tapiGen2/source/install
sqlplus "user/userpass"@SID @tapigen2_uninstall

Logger

If you use logger for exception handling you may also:

• Download logger https://github.com/oraopensource/logger
• And follow the installation instruction https://github.com/OraOpenSource/Logger/blob/master/docs/Installation.md

Logger needs the following grants

grant connect,create view, create job, create table, create sequence,
create trigger, create procedure, create any context to existing_user;

Usage

Basic Example

Create Table API for DEPT table, without audit columns

exec tapi_gen2.create_tapi_package (p_table_name => 'DEPT', p_compile_table_api => TRUE);

Result:

Creation of Table API package for DEPT table completed successfully!

With audit columns

Create Table API for EMP table assign custom audit columns.

exec tapi_gen2.create_tapi_package (p_table_name => 'EMP'
                                  , p_compile_table_api => FALSE
                                  , p_created_by_col_name => 'created_by'
                                  , p_created_date_col_name => 'created_date'
                                  , p_modified_by_col_name => 'modified_by'
                                  , p_modified_date_col_name => 'modified_date'
                                  , p_raise_exceptions => FALSE);

Because p_compile_table_api is set to FALSE tapiGen2 show source via DBMS_OUTPUT:

CREATE OR REPLACE PACKAGE tapi_emp
IS
   /**
   -- # TAPI_EMP
   -- Generated by: tapiGen2 - DO NOT MODIFY!
   -- Website: github.com/osalvador/tapiGen2
   -- Created On: 16-SEP-2015 12:45
   -- Created By: TEST
   */

   --Scalar/Column types
   SUBTYPE hash_t IS varchar2 (40);
   SUBTYPE empno IS emp.empno%TYPE;
   SUBTYPE ename IS emp.ename%TYPE;
   SUBTYPE job IS emp.job%TYPE;
   SUBTYPE mgr IS emp.mgr%TYPE;
   SUBTYPE hiredate IS emp.hiredate%TYPE;
   SUBTYPE sal IS emp.sal%TYPE;
   SUBTYPE comm IS emp.comm%TYPE;
   SUBTYPE deptno IS emp.deptno%TYPE;

   --Record type
   TYPE emp_rt
   IS
      RECORD (
            empno emp.empno%TYPE,
            ename emp.ename%TYPE,
            job emp.job%TYPE,
            mgr emp.mgr%TYPE,
            hiredate emp.hiredate%TYPE,
            sal emp.sal%TYPE,
            comm emp.comm%TYPE,
            deptno emp.deptno%TYPE,
            hash               hash_t,
            row_id            VARCHAR2(64)
      );
.....

Functions and procedures that exist within each package that tapiGen2 creates

Here is a brief list of the various functions and procedures that exist within each package that tapiGen creates: *(f) = function and (p) = procedure

1. rt (f) - Returns a record from the table. Uses function result cache in 11g.
2. rt_for_update (f) - Returns a record from the table and places a row level lock on it.
3. tt (f) - Returns record Table as PIPELINED Function. Pipe-lining negates the need to build huge collections by piping rows out of the function as they are created, saving memory and allowing subsequent processing to start before all the rows are generated -- Oracle Base Blog
4. ins (p) - Inserts a row into the table. Automatically updates the audit columns: created_by, created_date, modified_by, and modified_date.
5. upd (p) - Updates a row in the table. Automatically updates the audit columns: modified_by, and modified_date.
6. web_upd (p) - Updates a row in the table. Performs an optimistic locking check prior to performing the update. Automatically updates the audit columns: modified_by, and modified_date.
7. del (p) - Deletes a row from the table.
8. web_del (p) - Deletes a row from the table. Performs an optimistic locking check prior to performing the update.
9. hash (f) - Returns an SHA1 hash of a row in the table.
10. upd_rowid (p) - Same as upd but access directly to the row by rowid.
11. web_upd_rowid (p) - Same as web_upd but access directly to the row by rowid.
12. del_rowid (p) - Same as del but access directly to the row by rowid.
13. web_del_rowid (p) - Same as web_del but access directly to the row by rowid.
14. hash_rowid (f) - Same as hash but access directly to the row by rowid.

tapiGen2 procedure description

CREATE_TAPI_PACKAGE

PROCEDURE create_tapi_package (p_table_name               IN VARCHAR2
                               , p_compile_table_api        IN BOOLEAN DEFAULT TRUE
                               , p_unique_key               IN VARCHAR2 DEFAULT NULL
                               , p_created_by_col_name      IN VARCHAR2 DEFAULT NULL
                               , p_created_date_col_name    IN VARCHAR2 DEFAULT NULL
                               , p_modified_by_col_name     IN VARCHAR2 DEFAULT NULL
                               , p_modified_date_col_name   IN VARCHAR2 DEFAULT NULL
                               , p_raise_exceptions         IN BOOLEAN DEFAULT FALSE);

Description:

Create PL/SQL Table API

IN Parameters

Name	Type	Description
p_table_name	VARCHAR2	must be NOT NULL
p_compile_table_api	BOOLEAN	TRUE for compile generated package, FALSE to DBMS_OUTPUT the source
p_unique_key	VARCHAR2	If the table has no primary key, it indicates the column that will be used as a unique key
p_created_by_col_name	VARCHAR2	Custom audit column
p_created_date_col_name	VARCHAR2	Custom audit column
p_modified_by_col_name	VARCHAR2	Custom audit column
p_modified_date_col_name	VARCHAR2	Custom audit column
p_raise_exceptions	BOOLEAN	TRUE to use logger for exception handling

Amendments

When	Who	What
16-JUL-2015	osalvador	Created
20-JUL-2015	osalvador	Added logger exception handling
16-SEP-2015	osalvador	The new version of tePLSQL is used. And the template is moved to the tapi_gen2 package spec.

Special thanks

tapiGen2 is the continuation of the Open Source project created by Daniel McGhan in 2008, tapiGen.

Contributing

If you have any ideas, get in touch directly.

Please insert at the bottom of your commit message the following line, having in it your name and e-mail address .

Signed-off-by: Your Name <[email protected]>

This can be automatically added to pull requests by committing with:

git commit --signoff

License

Copyright 2015 Oscar Salvador Magallanes

tapiGen2 is under MIT license.