CDB_API_PARAMS Struct Reference
[External access to ConfigurationDB (PL/SQL API)]

Input/Output table for the PL/SQL API. More...

Data Fields

NUMBER I1
 generic integer parameter, usually an index
NUMBER I2
 generic integer parameter
NUMBER I3
 generic integer parameter
NUMBER I4
 generic integer parameter
NUMBER I5
 generic integer parameter
NUMBER I6
 generic integer parameter
NUMBER I7
 generic integer parameter
NUMBER I8
 generic integer parameter
VARCHAR2[512] S1
 string parameter; typically contains a device name
VARCHAR2[512] S2
 string parameter
VARCHAR2[256] S3
 string parameter
VARCHAR2[256] S4
 string parameter
VARCHAR2[256] S5
 string parameter
VARCHAR2[256] S6
 string parameter
VARCHAR2[4000] S7
 long string parameter
VARCHAR2[4000] S8
 long string parameter
VARCHAR2[16] S9
 short string parameter
VARCHAR2[16] S10
 short string parameter
DATE D1
 date/time parameter, typicaly the start time (beginning of IOV)
DATE D2
 date/time parameter, typicaly the end time (end of IOV)
BLOB B1
 blob parameter

Detailed Description

Input/Output table for the PL/SQL API.

CDB_API_PARAMS is a global temporary table used to pass the data from/to the PL/SQL functions contained in the package External access to ConfigurationDB (PL/SQL API) .

The table is used to pass the data which has a form of list of records, such as the list of device names, or a list of settings for a recipe, where device element is specified in one column, and the corresponding setting in another.

The fields in the table have no a`priori associated meaning, that is why their names are generic. Each function expects its input data to be present in certain columns, and delivers the output into certain columns - the actual assignment (or: meaning) for each column is provided in the description of each procedure.

Being a temporary table, CDB_API_PARAMS does not occupy disk space: it is created in the memory of the database server, and the data contained in it persist only within a session. That also means that separate database sessions (connected to the same database schema) will refer to their private instances of CDB_API_PARAMS, and will not see/alter the data in the instances belonging to other sessions.

The CDB_API_PARAMS table preserves it contents when a commit operation is performed. This is to be able to feed the results returned by one PL/SQL procedure as an input to another. A user should remember to truncate this table before calling a PL/SQL procedure, if he wants to assure the consistency of the data passed into the procedure, using the SQL statement:

    DELETE FROM CDB_API_PARAMS;

For safety, some data-integrity checking mechanisms are built into a majority of functions in the package; calling a procedure without cleaning up this I/O table will end up in an error.


Field Documentation

NUMBER I1

generic integer parameter, usually an index

NUMBER I2

generic integer parameter

NUMBER I3

generic integer parameter

NUMBER I4

generic integer parameter

NUMBER I5

generic integer parameter

NUMBER I6

generic integer parameter

NUMBER I7

generic integer parameter

NUMBER I8

generic integer parameter

VARCHAR2 [512] S1

string parameter; typically contains a device name

VARCHAR2 [512] S2

string parameter

VARCHAR2 [256] S3

string parameter

VARCHAR2 [256] S4

string parameter

VARCHAR2 [256] S5

string parameter

VARCHAR2 [256] S6

string parameter

VARCHAR2 [4000] S7

long string parameter

VARCHAR2 [4000] S8

long string parameter

VARCHAR2 [16] S9

short string parameter

VARCHAR2 [16] S10

short string parameter

DATE D1

date/time parameter, typicaly the start time (beginning of IOV)

DATE D2

date/time parameter, typicaly the end time (end of IOV)

BLOB B1

blob parameter


The documentation for this struct was generated from the following file:

Generated on 26 Sep 2014 for Configuration Database component by  doxygen 1.6.1