Skip to content

Commit d096ce3

Browse files
ogobrechtogobrecht
committed
Update README in package spec
1 parent 47a25a5 commit d096ce3

File tree

4 files changed

+128
-248
lines changed

4 files changed

+128
-248
lines changed

‎OM_TAPIGEN.pks‎

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ c_generator CONSTANT VARCHAR2(10 CHAR) := 'OM_TAPIGEN';
33
c_generator_version CONSTANT VARCHAR2(10 CHAR) := '0.5.1';
44
/**
55

6-
_This is an Oracle PL/SQL Table API Generator. It can be integrated in the
7-
Oracle SQL-Developer with an additional wrapper package for the
8-
[oddgen](https://www.oddgen.org/) extension._
6+
Oracle PL/SQL Table API Generator
7+
=================================
8+
9+
_This table API generator can be integrated in the Oracle SQL-Developer with an
10+
additional wrapper package for the [SQL Developer extension oddgen](https://www.oddgen.org/)._
911

1012
The effort of generated API's is to reduce your PL/SQL code by calling standard
1113
procedures and functions for usual DML operations on tables. So the generated
@@ -384,26 +386,26 @@ FUNCTION util_get_column_data_default
384386
p_column_name IN VARCHAR2,
385387
p_owner VARCHAR2 DEFAULT USER
386388
) RETURN VARCHAR2;
387-
/**
389+
/*
388390

389391
Helper to read a column data default from the dictionary.
390392
[Working with long columns](http://www.oracle-developer.net/display.php?id=430).
391393

392-
**/
394+
*/
393395

394396

395397
FUNCTION util_get_cons_search_condition
396398
(
397399
p_constraint_name IN VARCHAR2,
398400
p_owner IN VARCHAR2 DEFAULT USER
399401
) RETURN VARCHAR2;
400-
/**
402+
/*
401403

402404
Helper to read a constraint search condition from the dictionary (not needed
403405
in 12cR1 and above, there we have a column search_condition_vc in
404406
user_constraints).
405407

406-
**/
408+
*/
407409

408410

409411
FUNCTION util_split_to_table
@@ -412,28 +414,28 @@ FUNCTION util_split_to_table
412414
p_delimiter IN VARCHAR2 DEFAULT ','
413415
) RETURN t_tab_vc2_4k
414416
PIPELINED;
415-
/**
417+
/*
416418

417419
Helper function to split a string to a selectable table.
418420

419421
```sql
420422
SELECT column_value FROM TABLE (om_tapigen.util_split_to_table('1,2,3,test'));
421423
```
422-
**/
424+
*/
423425

424426

425427
FUNCTION util_get_ora_max_name_len RETURN INTEGER;
426-
/**
428+
/*
427429

428430
Helper function to determine the maximum length for an identifier name (e.g.
429431
column name). Returns the package constant c_ora_max_name_len, which is
430432
determined by a conditional compilation.
431433

432-
**/
434+
*/
433435

434436

435437
PROCEDURE util_set_debug_on;
436-
/**
438+
/*
437439

438440
Enable (and reset) the debugging (previous debug data will be lost)
439441

@@ -442,11 +444,11 @@ BEGIN
442444
om_tapigen.util_set_debug_on;
443445
END;
444446
```
445-
**/
447+
*/
446448

447449

448450
PROCEDURE util_set_debug_off;
449-
/**
451+
/*
450452

451453
Disable the debugging
452454

@@ -455,25 +457,25 @@ BEGIN
455457
om_tapigen.util_set_debug_off;
456458
END;
457459
```
458-
**/
460+
*/
459461

460462

461463
FUNCTION util_view_debug_log RETURN t_tab_debug_data
462464
PIPELINED;
463-
/**
465+
/*
464466

465467
View the debug details. Maximum 999 API creations are captured for memory
466468
reasons. You can reset the debugging by calling `om_tapigen.util_set_debug_on`.
467469

468470
```sql
469471
SELECT * FROM TABLE(om_tapigen.util_view_debug_log);
470472
```
471-
**/
473+
*/
472474

473475

474476
FUNCTION util_view_columns_array RETURN t_tab_debug_columns
475477
PIPELINED;
476-
/**
478+
/*
477479

478480
View the internal columns array from the last API generation. This view is
479481
independend from the debug mode, because this array is resetted for each API
@@ -482,19 +484,19 @@ generation.
482484
```sql
483485
SELECT * FROM TABLE(om_tapigen.util_view_columns_array);
484486
```
485-
**/
487+
*/
486488

487489
FUNCTION util_get_ddl
488490
(
489491
p_object_type VARCHAR2,
490492
p_object_name VARCHAR2,
491493
p_owner VARCHAR2 DEFAULT USER
492494
) RETURN CLOB;
493-
/**
495+
/*
494496

495497
Helper for testing to get the DDL of generated objects.
496498

497-
**/
499+
*/
498500

499501
END om_tapigen;
500502
/

‎README.md‎

Lines changed: 10 additions & 178 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,22 @@
11
<!-- DO NOT EDIT THIS FILE DIRECTLY - it is generated from source file OM_TAPIGEN.pks -->
22

3+
Oracle PL/SQL Table API Generator
4+
=================================
5+
36
- [Package om_tapigen](#om_tapigen)
47
- [Procedure compile_api](#compile_api)
58
- [Function compile_api_and_get_code](#compile_api_and_get_code)
69
- [Function get_code](#get_code)
710
- [Procedure recreate_existing_apis](#recreate_existing_apis)
811
- [Function view_existing_apis](#view_existing_apis)
912
- [Function view_naming_conflicts](#view_naming_conflicts)
10-
- [Function util_get_column_data_default](#util_get_column_data_default)
11-
- [Function util_get_cons_search_condition](#util_get_cons_search_condition)
12-
- [Function util_split_to_table](#util_split_to_table)
13-
- [Function util_get_ora_max_name_len](#util_get_ora_max_name_len)
14-
- [Procedure util_set_debug_on](#util_set_debug_on)
15-
- [Procedure util_set_debug_off](#util_set_debug_off)
16-
- [Function util_view_debug_log](#util_view_debug_log)
17-
- [Function util_view_columns_array](#util_view_columns_array)
18-
- [Function util_get_ddl](#util_get_ddl)
19-
20-
21-
<h1><a id="om_tapigen"></a>Package om_tapigen</h1>
22-
<!--===========================================-->
23-
24-
_This is an Oracle PL/SQL Table API Generator. It can be integrated in the
25-
Oracle SQL-Developer with an additional wrapper package for the
26-
[oddgen](https://www.oddgen.org/) extension._
13+
14+
15+
<h2><a id="om_tapigen"></a>Package om_tapigen</h2>
16+
<!----------------------------------------------->
17+
18+
_This table API generator can be integrated in the Oracle SQL-Developer with an
19+
additional wrapper package for the [SQL Developer extension oddgen](https://www.oddgen.org/)._
2720

2821
The effort of generated API's is to reduce your PL/SQL code by calling standard
2922
procedures and functions for usual DML operations on tables. So the generated
@@ -284,164 +277,3 @@ FUNCTION view_naming_conflicts(p_owner all_users.username%TYPE DEFAULT USER)
284277
```
285278

286279

287-
<h2><a id="util_get_column_data_default"></a>Function util_get_column_data_default</h2>
288-
<!------------------------------------------------------------------------------------>
289-
290-
Helper to read a column data default from the dictionary.
291-
[Working with long columns](http://www.oracle-developer.net/display.php?id=430).
292-
293-
SIGNATURE
294-
295-
```sql
296-
FUNCTION util_get_column_data_default
297-
(
298-
p_table_name IN VARCHAR2,
299-
p_column_name IN VARCHAR2,
300-
p_owner VARCHAR2 DEFAULT USER
301-
) RETURN VARCHAR2;
302-
```
303-
304-
305-
<h2><a id="util_get_cons_search_condition"></a>Function util_get_cons_search_condition</h2>
306-
<!---------------------------------------------------------------------------------------->
307-
308-
Helper to read a constraint search condition from the dictionary (not needed
309-
in 12cR1 and above, there we have a column search_condition_vc in
310-
user_constraints).
311-
312-
SIGNATURE
313-
314-
```sql
315-
FUNCTION util_get_cons_search_condition
316-
(
317-
p_constraint_name IN VARCHAR2,
318-
p_owner IN VARCHAR2 DEFAULT USER
319-
) RETURN VARCHAR2;
320-
```
321-
322-
323-
<h2><a id="util_split_to_table"></a>Function util_split_to_table</h2>
324-
<!------------------------------------------------------------------>
325-
326-
Helper function to split a string to a selectable table.
327-
328-
```sql
329-
SELECT column_value FROM TABLE (om_tapigen.util_split_to_table('1,2,3,test'));
330-
```
331-
332-
SIGNATURE
333-
334-
```sql
335-
FUNCTION util_split_to_table
336-
(
337-
p_string IN VARCHAR2,
338-
p_delimiter IN VARCHAR2 DEFAULT ','
339-
) RETURN t_tab_vc2_4k
340-
PIPELINED;
341-
```
342-
343-
344-
<h2><a id="util_get_ora_max_name_len"></a>Function util_get_ora_max_name_len</h2>
345-
<!------------------------------------------------------------------------------>
346-
347-
Helper function to determine the maximum length for an identifier name (e.g.
348-
column name). Returns the package constant c_ora_max_name_len, which is
349-
determined by a conditional compilation.
350-
351-
SIGNATURE
352-
353-
```sql
354-
FUNCTION util_get_ora_max_name_len RETURN INTEGER;
355-
```
356-
357-
358-
<h2><a id="util_set_debug_on"></a>Procedure util_set_debug_on</h2>
359-
<!--------------------------------------------------------------->
360-
361-
Enable (and reset) the debugging (previous debug data will be lost)
362-
363-
```sql
364-
BEGIN
365-
om_tapigen.util_set_debug_on;
366-
END;
367-
```
368-
369-
SIGNATURE
370-
371-
```sql
372-
PROCEDURE util_set_debug_on;
373-
```
374-
375-
376-
<h2><a id="util_set_debug_off"></a>Procedure util_set_debug_off</h2>
377-
<!----------------------------------------------------------------->
378-
379-
Disable the debugging
380-
381-
```sql
382-
BEGIN
383-
om_tapigen.util_set_debug_off;
384-
END;
385-
```
386-
387-
SIGNATURE
388-
389-
```sql
390-
PROCEDURE util_set_debug_off;
391-
```
392-
393-
394-
<h2><a id="util_view_debug_log"></a>Function util_view_debug_log</h2>
395-
<!------------------------------------------------------------------>
396-
397-
View the debug details. Maximum 999 API creations are captured for memory
398-
reasons. You can reset the debugging by calling `om_tapigen.util_set_debug_on`.
399-
400-
```sql
401-
SELECT * FROM TABLE(om_tapigen.util_view_debug_log);
402-
```
403-
404-
SIGNATURE
405-
406-
```sql
407-
FUNCTION util_view_debug_log RETURN t_tab_debug_data
408-
PIPELINED;
409-
```
410-
411-
412-
<h2><a id="util_view_columns_array"></a>Function util_view_columns_array</h2>
413-
<!-------------------------------------------------------------------------->
414-
415-
View the internal columns array from the last API generation. This view is
416-
independend from the debug mode, because this array is resetted for each API
417-
generation.
418-
419-
```sql
420-
SELECT * FROM TABLE(om_tapigen.util_view_columns_array);
421-
```
422-
423-
SIGNATURE
424-
425-
```sql
426-
FUNCTION util_view_columns_array RETURN t_tab_debug_columns
427-
PIPELINED;
428-
```
429-
430-
431-
<h2><a id="util_get_ddl"></a>Function util_get_ddl</h2>
432-
<!---------------------------------------------------->
433-
434-
Helper for testing to get the DDL of generated objects.
435-
436-
SIGNATURE
437-
438-
```sql
439-
FUNCTION util_get_ddl
440-
(
441-
p_object_type VARCHAR2,
442-
p_object_name VARCHAR2,
443-
p_owner VARCHAR2 DEFAULT USER
444-
) RETURN CLOB;
445-
```
446-
447-

0 commit comments

Comments
 (0)