HP 3000 Manuals

Using TurboIMAGE/XL Intrinsics (Continued) [ TurboIMAGE/XL Database Management System Reference Manual ] MPE/iX 5.5 Documentation


TurboIMAGE/XL Database Management System Reference Manual

Using TurboIMAGE/XL Intrinsics (Continued) 

DBINFO (Continued) 

Mode 113:  BTREEMODE1 and Wildcard Character.   

Mode 113 gives the settings of BTREEMODE1 and wildcard character in the
root file as well as current DBOPEN (DBU).

Qualifier  is ignored.

Buffer     must be at least 32 bytes and returns the following (each
           element is a halfword or 2 bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      1       |                                    |
|              |        0 if BTREEMODE1 is off in   |
|              |        the root file               |
|              |                                    |
|              |        1 if BTREEMODE1 is on in    |
|              |        the root file               |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      2       | The first byte (8 bits) is always  |
|              | 0.  The second byte (8 bits)       |
|              | represents c, where c is the       |
|              | current wildcard character.  For   |
|              | example, if the current wildcard   |
|              | character is @, the element's hex  |
|              | value will be $0040, or decimal    |
|              | 64.  This is from the root file.   |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      3       | Highest B-Tree argument version    |
|              | supported (0 for the first B-Tree  |
|              | release version).                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      4       | Number of sets with B-Trees        |
|              | indices attached.                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      5       |                                    |
|              |        0 if BTREEMODE1 is off for  |
|              |        current DBOPEN              |
|              |                                    |
|              |        1 if BTREEMODE1 is on for   |
|              |        current DBOPEN              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      6       | The first byte (8 bits) is always  |
|              | 0.  The second byte (8 bits)       |
|              | represents c, where c is the       |
|              | current wildcard character.  This  |
|              | is for the current DBOPEN.         |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    7...16    | (reserved)                         |
|              |                                    |
-----------------------------------------------------

[REV END]

Mode 201:  Set Number.   

Mode 201 defines the type of access available for a specific data set.

Qualifier  identifies the data set name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      1       | +/- Data set number                |
|              |                                    |
-----------------------------------------------------

           If the data set number is positive, the user class has only
           read access.  If the number is negative, the user class has
           both read and write access.

Mode 202:  Set Name.   

Mode 202 describes a specific data set.

Qualifier  identifies the data set name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|     1-8      | Data set name                      |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      9       | One of the following set types     |
|              | followed by a blank:               |
|              |                                    |
|              |                                    |
|              |        M, A, D                     |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      10      | Entry length                       |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      11      | Blocking factor                    |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      12      | 0                                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      13      | 0                                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    14-15     | Number of entries in set[REV BEG]  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    16-17     | Capacity of set.  If data set is   |
|              | dynamically expandable, current    |
|              | capacity for detail, and initial   |
|              | capacity (also primary capacity)   |
|              | for master.  Note that for master, |
|              | it is always primary capacity      |
|              | regardless of expansion.[REV END]  |
|              |                                    |
-----------------------------------------------------

           The data set name is left-justified and will be padded with
           blanks if the name is shorter than 16 characters.

Mode 203:  Sets in Database.   

Mode 203 identifies all data sets available in a database and the type of
access allowed.  If you are using third-party indexing, this mode does
not show third-party index files.

Qualifier  is ignored.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      1       | Set count x                        |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      2       | +/- Data set number 1              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      :       | :                                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    n + 1     | +/- Data set number n              |
|              |                                    |
-----------------------------------------------------

           If the data set number is positive, the user class has only
           read access to the data set and possibly is in the write class
           list of specific data item(s).  If the number is negative, the
           user class has both read and write access.  The data sets are
           listed in data set number order.

Mode 204:  Sets with Item.   

Mode 204 identifies all data sets available which contain a specified
data item and indicates the type of access allowed.

Qualifier  identifies the data item name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      1       | Set count x                        |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      2       | +/- Data set number 1              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      :       | :                                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    n + 1     | +/- Data set number n              |
|              |                                    |
-----------------------------------------------------

           If the data set number is positive, the user class has only
           read access to the data set and possibly is in the write class
           list of specific data item(s).  If the number is negative, the
           user class has both read and write access.  The data sets are
           listed in data set number order.

Mode 205:  Set Capacity.   

Mode 205 is an extension of mode 202 with dynamic capacity expansion
information.

Qualifier  identifies the data set name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|     1-8      | Data set name                      |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      9       | One of the following set types     |
|              | followed by a blank:               |
|              |                                    |
|              |                                    |
|              |        M, A, D                     |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      10      | Entry length                       |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      11      | Blocking factor                    |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      12      | 0                                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      13      | 0                                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    14-15     | Number of entries in set           |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    16-17     | Current capacity of set, including |
|              | expansions                         |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    18-19     | High-water mark                    |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    20-21     | Maximum capacity                   |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    22-23     | Initial capacity (primary capacity |
|              | for master)                        |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|    24-25     | Incremental number of entries      |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      26      | Incremental percent                |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      27      | Dynamic capacity expansion flag    |
|              | (0 = off, 1 = on)                  |
|              |                                    |
-----------------------------------------------------

           The data set name is left-justified and will be padded with
           blanks if the name is shorter than 16 characters.

           Mode 205 can be used for any master or detail data set with or
           without dynamic capacity expansion capability.

           Mode 205 allows users to obtain information on dynamic data
           set capacity expansion programmatically.  It is an extension
           of mode 202 to include dynamic capacity expansion information
           such as maximum capacity, initial capacity, incremental number
           of entries, incremental percent, and the dynamic capacity
           expansion flag (0 for off and 1 for on) for the data set.
[REV BEG]

Mode 206:  Number of Data Set Chunks.   

Mode 206 gives the number of chunks in a data set in short format.

Qualifier  identifies the data set name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

          DBINFO Mode 206  

-------------------------------------------------------
|              |                                      |
|   Element    |               Contents               |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      1       | # of chunks in a jumbo data set      |
|              |                                      |
-------------------------------------------------------

           If the data set is not a jumbo data set, zero is returned for
           the number of chunks.
[REV END][REV BEG]

Mode 207:  Size of Data Set Chunks.   

Mode 207 identifies the size of each chunk in terms of IMAGE records in
addition to providing the number of chunks.

Qualifier  identifies the data set name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

-------------------------------------------------------
|              |                                      |
|   Element    |               Contents               |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      1       | # of chunks in a jumbo data set      |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      2       | 0                                    |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|     3-4      | Size of chunk 1 (# entries, not # of |
|              | blocks!)                             |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|     5-6      | Size of chunk 2 (# entries, not # of |
|              | blocks!)                             |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|     7-8      | ...                                  |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|    2n + 3    | Size of chunk n (# entries, not # of |
|              | blocks!)                             |
|              |                                      |
-------------------------------------------------------

           Total size:  (n + 1) * 4 bytes.

           If the data set is not a jumbo data set, then zero is returned
           for the number of chunks.
[REV END][REV BEG]

Mode 208:  Primary and Actual Capacity.   

Mode 208 returns the primary and actual capacity.

Qualifier  identifies the data set name or number for which the
           information is requested.

Buffer     must be at least a 64-byte record and returns the following
           (each element is a 32-bit Word):

-------------------------------------------------------
|              |                                      |
|   Element    |               Contents               |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      1       | Primary (hashing) capacity for       |
|              | masters, 0 for details               |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      2       | Current capacity, including          |
|              | expansions                           |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      3       | Maximum capacity                     |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      4       | Expansion threshold:                 |
|              |                                      |
|              |                                      |
|              | -1...100   percentage                |
|              |                                      |
|              | -1         this value means          |
|              |            expansion is not          |
|              |            triggered by percentage,  |
|              |            or it is a non-expandable |
|              |            set                       |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      5       | Delete chain free head (0 for        |
|              | non-expanded masters)                |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      6       | high-water mark (0 for non-expanded  |
|              | masters)                             |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|      7       | Expansion threshold:                 |
|              |                                      |
|              |                                      |
|              | -1...2     billion blocks            |
|              |                                      |
|              | -1         this value means          |
|              |            expansion not triggered   |
|              |            by traversing # blocks    |
|              |            without success, or it is |
|              |            a non-expandable set      |
|              |                                      |
-------------------------------------------------------
|              |                                      |
|    8...16    | Reserved; 0 is returned              |
|              |                                      |
-------------------------------------------------------

           DBINFO mode 208 does not return an expandable flag, while
           DBINFO 205 returns an expandable flag.  The flag can also be
           deduced by comparing the current and maximum capacities in
           DBINFO 208.

           DBINFO mode 208 returns information about internals which will
           be meaningful to only a few customers.
[REV END][REV BEG]

Mode 209:  B-Tree Attachment.   

Mode 209 informs whether or not a B-Tree exists for a master.

Qualifier  is a master data set name or number.

Buffer     must be at least a 64-byte record and returns the following
           (each element is a 32-bit Word):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      1       |                                    |
|              |        0 if no B-Tree index exists |
|              |                                    |
|              |                                    |
|              |        1 if B-Tree index exists    |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      2       |                                    |
|              |        0 if attached B-Tree not    |
|              |        damaged or index does not   |
|              |        exist                       |
|              |                                    |
|              |        1 if the attached B-Tree    |
|              |        index is damaged            |
|              |                                    |
|    3...32    | For internal use                   |
|              |                                    |
-----------------------------------------------------

[REV END]

Mode 301:  Paths.   

Mode 301 identifies the paths defined for a specified data set.

Qualifier  identifies the data set name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      1       | Path count x                       |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      2       | Data set number of path 1          |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      3       | Search item number of path 1       |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      4       | Sort item number of path 1         |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      :       | :                                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|     3n-1     | Data set number of path n          |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      3n      | Search item number of path n       |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|     3n+1     | Sort item number of path n         |
|              |                                    |
-----------------------------------------------------

           Elements 2 to 4 are repeated for each path.

           If qualifier specifies a master data set, the set number
           identifies the detail data set.

           If qualifier specifies a detail data set, the set number
           identifies the master data set.

           If qualifier specifies a master data set, the item numbers
           identify items in the detail data sets.  If you do not have
           access to a search item, it is not included in the path count
           and the path information is not returned.  If a sort item does
           not exist or you do not have access to it, the sort item
           number is zero.

           Path designators are presented in the order in which they
           appear in the schema.

Mode 302:  Key or Search Item.   

Mode 302 identifies the key or search item for a specified data set.  For
this mode the two qualifiers are shown separately.

Qualifier  identifies the master data set name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      1       | Key item number                    |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      2       | 0                                  |
|              |                                    |
-----------------------------------------------------

           If qualifier specifies a master data set, the key item number
           is the number in the master set.  The number is 0 if you do
           not have access to the key item.

OR 

Qualifier  identifies the detail data set name or number for which the
           information is requested.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      1       | Search item number                 |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      2       | Master data set number             |
|              |                                    |
-----------------------------------------------------

           If qualifier specifies a detail data set, the primary search
           item and the related master data set number are returned.
           Both numbers are 0 if you do not have access to the search
           item.

Mode 401:  Logging.   

Mode 401 obtains information related to logging.

Qualifier  is ignored.

Buffer     returns the following (each element is a halfword or two
           bytes):

-----------------------------------------------------
|              |                                    |
|   Element    |              Contents              |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|     1-4      | Log identifier name                |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      5       | Database log flag                  |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      6       | User log flag                      |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|      7       | Transaction flag                   |
|              |                                    |
-----------------------------------------------------
|              |                                    |
|     8-9      | User transaction number            |
|              |                                    |
-----------------------------------------------------

           The log identifier name is left-justified and padded with
           blanks if shorter than 8 characters.

           If the database is enabled for logging, the database log flag
           is 1; otherwise it is 0.

           If you are logging, the user log flag is 1; otherwise it is 0.

           If you have a transaction in progress, the transaction flag is
           1; otherwise it is 0.

           The user transaction number is one word.



MPE/iX 5.5 Documentation