Register Parameter Spaces (QmyRegisterParameterSpaces) API
Required Parameter Group:
| 1 | Request Space | Input | PTR(SPP) |
| 2 | Reply Space | Input | PTR(SPP) |
Default Public Authority: *USE
Service Program: QMYSE
Threadsafe: Yes
The Register Parameter Spaces (QmyRegisterParameterSpaces) API is used to register the request and reply spaces used for storage engine communications. Only the last spaces registered are retained within a thread if called multiple times.
Within the request and reply structures there are two handle types.
Object Handles
Object handles represent tables, indexes and queries in DB2. Object handles are made up of two subtypes: shares and instances.
A share represents shared information about a table (and corresponding indexes) across all application connections.
An instance represents a specific instance of a table, index or query. Object instances allow input/output or locks operations. Instances may move across application connections at commit boundaries.
Space Handles
Space handles represent spaces used in replies and requests against the storage
engine. These spaces can contain input/output buffers, statements or
other information. These spaces are registered and unregistered via the QmyRegisterSpace and QmyUnregisterSpace APIs.
Authorities and Locks
- QMYSE authority
- *USE
- API Public Authority
- *USE
Required Parameter Group
- Request Space
- INPUT; PTR(SPP)
The structure which contains the request.
Relationship between Input Format Name and Input Format
- Reply Space
- INPUT; PTR(SPP)
The structure which contains the reply. For the format of the structure, see Request Parameter.
- Return Code
- OUTPUT; BINARY(4)
The return code from processing the request.Possible values are:
Code Reason 0 Successful. 2017 Space handle memory object could not be created. 2018 Table handle memory object could not be created. 2019 Space handle sync token could not be created. 2020 Table handle sync token could not be created. 2098 Unexpected error during registering of parameter spaces.
Format Structures
In the following structures, the CCSID of the character field is the job CCSID unless a specific CCSID field is included in the format for the field.
Format QMY_ALLOCATE_INSTANCE (Allocate Instance Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Share handle |
| 16 | 10 | BINARY(8) | In-use indicator handle |
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
In-use indicator handle. A space that contains the connection actively using this instance. This will prevent events from closing and reopening the table in that connection.
Share handle. The table or index share to be used for allocating the table or index instance.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
| 48 | 30 | BINARY(8) | Instance handle |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Instance handle. The table or index instance handle allocated.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_ALLOCATE_SHARE (Allocate Share Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | CHAR(8) | Reserved |
| 16 | 10 | BINARY(8) | Share definitions handle |
| 24 | 18 | BINARY(8) | Returned share handles handle |
| 32 | 20 | BINARY(8) | Returned format handle |
| 40 | 24 | BINARY(4) | Format space length |
| 44 | 2C | BINARY(2) | Count of share definitions |
| 46 | 2E | CHAR(2) | Reserved |
| 48 | 30 | BINARY(4) | Schema name length |
| 52 | 34 | CHAR(258) | Schema name |
Request Field Descriptions
Connection. The application connection making the request.
Count of share definitions. The count of shares definitions.
Format name. The input format.
Format space length. The length of the space to return the table (and indexes) formats.
Returned share handles handle. The space to return the share handles.
Returned format handle. The space to return the table (and indexes) formats. Refer to Object Definition Format for a description of this field.
Schema name. The schema name containing the table (and indexes).
Schema name length. The length of the schema name containing the table (and indexes).
Share definition handle. The space containing share definitions. The first definition is a table definition. Subsequent definitions must be index definitions associated with the table definition. Refer to Share Definition Format for a description of this field.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_CLEANUP (Cleanup Storage Engine Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
Request Field Descriptions
Format Name. The input format.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_CLOSE_CONNECTION (Close Connection Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
Request Field Descriptions
Connection. The application connection to be closed.
Format name. The input format.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_DEALLOCATE_OBJECT (Deallocate Object Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(6) | Reserved |
| 8 | 8 | BINARY(8) | Object handle |
| 16 | 10 | CHAR(1) | Dropped object |
Request Field Descriptions
Dropped object. An indicator of whether the table or index was dropped prior to deallocate. Ignored with the object handle is a query instance. Values passed follow:
| 0 | Table or index was not dropped prior to deallocate. |
| 1 | Table or index was dropped prior to deallocate. |
Format name. The input format.
Object handle. The table share, index share, table instance, index instance or query instance to be deallocated.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_DELETE_ROW (Delete Row Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
| 16 | 10 | BINARY(4) | Relative row number |
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table or index instance to be used. Query instances are not supported.
Relative row number. The relative row number to be deleted. If not currently positioned on this row, the cursor will be repositioned.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_DESCRIBE_CONSTRAINTS (Describe Constraints Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Object handle |
| 16 | 10 | BINARY(8) | Returned constraint handle |
| 24 | 18 | BINARY(4) | Initial constraint space length |
Request Field Descriptions
Connection. The application connection making the request.
Constraint space length. The length of the space to generate the constraint information.
Format name. The input format.
Object handle. The table share, index share, table instance or index instance to be used.
Returned constraint handle. The space to return the generated constraint information. Refer to Constraint Header Format for a description of this field.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
| 48 | 30 | BINARY(4) | Required constraint space length |
| 52 | 34 | BINARY(4) | Constraint count |
Reply Field Descriptions
Constraint count. Count of constraints described.
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Required constraint space length. The required space length to return all constraint information if the provided space length was too small.
Format QMY_DESCRIBE_OBJECT (Describe Object Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Object handle |
| 16 | 10 | BINARY(8) | Returned rows per key handle |
| 24 | 18 | CHAR(1) | Return object length |
| 25 | 19 | CHAR(1) | Return row count |
| 26 | 1A | CHAR(1) | Return deleted row count |
| 27 | 1B | CHAR(1) | Return rows per key |
| 28 | 1C | CHAR(1) | Return mean row length |
| 29 | 1D | CHAR(1) | Return time of last modification |
| 30 | 1E | CHAR(1) | Return create time |
| 31 | 1F | CHAR(1) | Return page count |
| 32 | 20 | CHAR(1) | Return estimated number of I/Os |
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
Object handle. The table share, index share, table instance or index instance to be used.
Return create time. An indicator of whether to return the create time of the object. Values passed follow:
| 0 | Do not return create time. |
| 1 | Return create time. |
Return deleted row count. An indicator of whether to return the deleted row count. Values passed follow:
| 0 | Do not return deleted row count. |
| 1 | Return deleted row count. |
Return estimated number of I/Os. An indicator of whether to return the number of I/Os. Values passed follow:
| 0 | Do not return estimated number of I/Os. |
| 1 | Return estimated number of I/Os. |
Return object length. An indicator of whether to return the object length. Values passed follow:
| 0 | Do not return object length. |
| 1 | Return object length. |
Return mean row length. An indicator of whether to return the mean row length. Values passed follow:
| 0 | Do not return mean row length. |
| 1 | Return mean row length. |
Return page count. An indicator of whether to return the page count. Values passed follow:
| 0 | Do not return page count. |
| 1 | Return page count. |
Return row count. An indicator of whether to return the row count. Values passed follow:
| 0 | Do not return row count. |
| 1 | Return row count. |
Return rows per key. An indicator of whether to return the rows per key. Values passed follow:
| 0 | Do not return rows per key. |
| 1 | Return rows per key. |
Return time of last modification. An indicator of whether to return the time of the last modification of the object. Values passed follow:
| 0 | Do not return time of last modification. |
| 1 | Return time of last modification. |
Returned rows per key handle. The space to return the generated rows per key information.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
| 48 | 30 | BINARY(8) | Object length |
| 56 | 38 | BINARY(8) | Row count |
| 64 | 40 | BINARY(8) | Deleted row count |
| 72 | 48 | BINARY(8) | Page count |
| 80 | 50 | BINARY(8) | Estimated number of I/Os |
| 84 | 54 | BINARY(4) | Mean row length |
| 96 | 60 | CHAR(12) | Reserved |
| 108 | 6C | BINARY(12) | Time of last modification |
| 120 | 78 | CHAR(3) | Reserved |
| 123 | 7B | BINARY(12) | Create time |
Reply Field Descriptions
Create time. The create time of the object. Refer to Time Format for a description of this field.
Deleted row count. The deleted row count in the object.
Error message ID. If an error occurs this is the message ID associated with the error.
Estimated number of I/Os. The estimated number of I/Os.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Mean row length. The mean row length of the object.
Object length. The length of the object.
Page count. The page count of the object.
Row count. The row count in the object.
Time of last modification. The time of last modification of the object. Refer to Time Format for a description of this field.
Format QMY_DESCRIBE_RANGE (Describe Range Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Object handle |
| 16 | 10 | BINARY(8) | Range handle |
| 24 | 18 | BINARY(4) | Key count |
| 28 | 1C | BINARY(4) | Literal count |
| 32 | 20 | BINARY(4) | Bounds offset |
| 36 | 24 | BINARY(4) | Literal definitions offset |
| 40 | 28 | BINARY(4) | Literal offset |
| 44 | 2C | BINARY(4) | Cutoff value |
| 48 | 30 | BINARY(2) | End byte |
| 50 | 32 | CHAR(10) | Reserved |
| 60 | 3C | BINARY(4) | Range space length |
| CHAR(*) | Bounds | ||
| CHAR(*) | Literal definitions | ||
| CHAR(*) | Literals | ||
Request Field Descriptions
Bounds. The range bounds. Refer to Key Bounds Format for a description of this field.
Bounds offset. The offset to the range bounds.
Connection. The application connection making the request.
Cutoff value. The early exit cutoff. Values passed follow:
| 0 | System decides cutoff. |
| n | Percentage of rows processed to cutoff. |
End byte. The last byte of the partial key.
Format name. The input format.
Key count. The number of keys in the range.
Literal count. The number of literal definitions.
Literal definitions. The literal definitions. Refer to Literal Definition Format for a description of this field.
Literal definitions offset. The offset to the literal definitions.
Literals. The literal values.
Literals offset. The offset to the literal values.
Object handle. The table share, index share, table instance or index instance to be used.
Range handle. The space containing the range information.
Range space length. The length of the space containing the range information.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
| 48 | 30 | BINARY(8) | Number of rows |
| 56 | 38 | BINARY(2) | Return code |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Number of rows. The estimated number of rows.
Return code. The return code.
Format QMY_EXECUTE_IMMEDIATE (Execute Immediate Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Reserved |
| 16 | 10 | BINARY(8) | SQL statements handle |
| 24 | 18 | BINARY(4) | Number of statements |
| 28 | 1C | CHAR(2) | SQL statements CCSID |
| 30 | 1E | CHAR(1) | Auto create schema |
| 31 | 1F | CHAR(1) | Commit level |
| 32 | 20 | CHAR(1) | Pre-Commit |
| 33 | 21 | CHAR(1) | Post-Commit/Post-Rollback |
| 34 | 22 | CHAR(1) | Drop schema statement |
Request Field Descriptions
Auto create schema. An indicator of whether a schema should be automatically created if not present. Values passed follow:
| 0 | Do not auto create schema. |
| 1 | Auto create schema. |
Commit level. An indicator of the commitment control level under which to execute the SQL statements. Values passed follow:
| N | No commitment control. |
| C | Read uncommitted. |
| S | Read committed. |
| A | Repeatable read. |
| L | Serializable. |
Connection. The application connection making the request.
Drop schema statement. An indicator of whether a drop schema statement is being executed. Values passed follow:
| 0 | Do not ignore schema not found errors. |
| 1 | Ignore schema not found errors. |
Format name. The input format.
Number of statements. The count of SQL statements in the space.
Post-Commit/Post-Rollback. An indicator of whether a commit or rollback should be executed after running the SQL statements. A commit will be executed if no failures occur. A rollback will be executed if failures occur. Values passed follow:
| 0 | Do not post-commit/post-rollback. |
| 1 | Post-commit/post-rollback. |
Pre-Commit. An indicator of whether a commit should be executed prior running the SQL statements. Values passed follow:
| 0 | Do not pre-commit. |
| 1 | Pre-commit. |
SQL statements CCSID. The CCSID of the statements in the space.
SQL statements handle. The space containing SQL statements to be executed. Refer to SQL Statement Format for a description of this field.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_INITIALIZATION (Initialize Storage Engine Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(14) | Reserved |
| 16 | 10 | BINARY(2) | RDB name length |
| 17 | 11 | CHAR(14) | Reserved |
| 32 | 20 | CHAR(256) | RDB name |
Request Field Descriptions
The field descriptions are always in alphabetical order.
Format name. The input format.
RDB name. The RDB name to be associated with the storage engine.
RDB name length. The length of the RDB name to be associated with the storage engine.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_INTERRUPT (Interrupt Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table, index or query instance to be interrupted.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_LOCK_OBJECT (Lock Object Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
| 16 | 10 | BINARY(8) | Lock timeout |
| 24 | 18 | CHAR(1) | Action |
| 25 | 19 | CHAR(1) | Lock type |
| 26 | 1A | CHAR(1) | Lock timeout specified |
Request Field Descriptions
Action. The action to perform. Values passed follow:
| 1 | Lock object. |
| 2 | Unlock object. |
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table or index instance to be locked or unlocked. Query instances are not supported.
Lock timeout. The timeout value for the lock action. Ignored for unlock action. Values passed follow:
| 0 | No lock timeout specified. |
| 1 | Lock timeout specified. |
Lock timeout specified. An indicator of whether a lock action should timeout of wait indefinitely. Ignored for unlock action.
Lock type. The lock type. Values passed follow:
| 0x81 | Lock shared, for read. |
| 0x41 | Lock shared, read-only. |
| 0x21 | Lock shared, for update. |
| 0x11 | Lock exclusive, allow read. |
| 0x09 | Lock exclusive, no read. |
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting Error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_OBJECT_INITIALIZATION (Object Initialization Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
| 16 | 10 | CHAR(1) | Object access intent |
| 17 | 11 | CHAR(1) | Commit level |
Request Field Descriptions
Commit level. An indicator of the commitment control level under which to execute the SQL statements. Values passed follow:
| N | No commitment control. |
| C | Read uncommitted. |
| S | Read committed. |
| A | Repeatable read. |
| L | Serializable. |
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table or index instance to be locked. Query instances are not supported.
Object Access intent. An indicator of whether the instance will be accessed as read-only or updatable. Values passed follow:
| 0x80 | Read-only. |
| 0xF0 | Updatable. |
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
| 48 | 30 | BINARY(2) | Input buffer null byte map offset |
| 50 | 32 | BINARY(2) | Input buffer row offset |
| 52 | 34 | BINARY(2) | Output buffer null byte map offset |
| 54 | 36 | BINARY(2) | Output buffer row offset |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Input buffer null byte map offset. The offset from the beginning of a row to the null byte map.
Input buffer row offset. The offset from the beginning of a row to the beginning of the next row.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Output buffer null byte map offset. The offset from the beginning of a row to the null byte map.
Output buffer row offset. The offset from the beginning of a row to the beginning of the next row.
Format QMY_OBJECT_OVERRIDE (Object Override Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
| 16 | 10 | BINARY(8) | Buffer handle |
| 24 | 18 | CHAR(8) | Reserved |
| 32 | 20 | BINARY(2) | Buffer row offset |
Request Field Descriptions
Buffer handle. The output buffer in which to read rows. Refer to Buffer Format for a description of this field.
Buffer row offset. The offset from the beginning of a row to the beginning of the next row.
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table, index or query instance to be locked.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_PROCESS_COMMITMENT_CONTROL (Process Commitment Control Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Reserved |
| 16 | 10 | CHAR(1) | Function |
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
Function. The function to perform. Values passed follow:
| 1 | Commit. |
| 2 | Rollback. |
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_PROCESS_SAVEPOINT (Process Savepoint Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Reserved |
| 16 | 10 | BINARY(4) | Savepoint name offset |
| 20 | 14 | BINARY(4) | Savepoint name length |
| 24 | 18 | CHAR(1) | Function |
| CHAR(*) | Savepoint name | ||
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
Function. The function to perform. Values passed follow:
| 1 | Set savepoint. |
| 2 | Release savepoint. |
| 3 | Rollback savepoint. |
Savepoint name. The savepoint name.
Savepoint name length. The length of the savepoint name.
Savepoint name offset. The offset to the savepoint name.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_PROCESS_XA (Process XA Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Reserved |
| 16 | 10 | BINARY(4) | XID offset |
| 20 | 14 | BINARY(4) | XID length |
| 24 | 18 | CHAR(1) | Function |
| CHAR(*) | XID | ||
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
Function. The function to perform. Values passed follow:
| 1 | Start transaction. |
| 2 | End transaction. |
| 3 | Prepare transaction. |
| 4 | Rollback transaction. |
| 5 | Commit transaction. |
| 6 | Recover transaction. |
XID. The XID.
XID offset. The offset to the XID.
XID length. The length of the XID.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_PREPARE_OPEN_CURSOR (Prepare Open Cursor Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Reserved |
| 16 | 10 | BINARY(8) | SQL statement handle |
| 24 | 18 | CHAR(2) | SQL statement CCSID |
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
SQL statement CCSID. The CCSID of the statement in the space.
SQL statement handle. The space containing SQL statement to be executed. Refer to SQL Statement Format for a description of this field.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
| 48 | 30 | BINARY(8) | Instance handle |
| 56 | 38 | CHAR(8) | Reserved |
| 64 | 40 | BINARY(2) | Input buffer null byte map offset |
| 66 | 42 | BINARY(2) | Input buffer row offset |
| 68 | 44 | BINARY(2) | Output buffer null byte map offset |
| 70 | 46 | BINARY(2) | Output buffer row offset |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Input buffer null byte map offset. The offset from the beginning of a row to the null byte map.
Input buffer row offset. The offset from the beginning of a row to the beginning of the next row.
Instance handle. The query instance handle allocated.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Output buffer null byte map offset. The offset from the beginning of a row to the null byte map.
Output buffer row offset. The offset from the beginning of a row to the beginning of the next row.
Format QMY_QUIESCE_OBJECT (Quiesce Object Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(6) | Reserved |
| 8 | 8 | BINARY(8) | Object handle |
Request Field Descriptions
Format name. The input format.
Object handle. The table share, index share, table instance or index instance to be used.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_READ_ROWS (Read Rows Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
| 16 | 10 | CHAR(8) | Reserved |
| 24 | 18 | BINARY(8) | Buffer handle |
| 32 | 20 | BINARY(8) | Returned relative row numbers handle |
| 40 | 28 | BINARY(8) | Key handle |
| 48 | 30 | CHAR(4) | Reserved |
| 52 | 34 | BINARY(4) | Relative row number |
| 56 | 38 | BINARY(4) | Length of key columns |
| 60 | 3C | BINARY(4) | Number of key columns |
| 64 | 40 | CHAR(1) | Object access intent |
| 65 | 41 | CHAR(1) | Commit level |
| 66 | 42 | CHAR(1) | Return data |
| 67 | 43 | CHAR(1) | Asynchronous |
| 68 | 44 | CHAR(1) | Orientation |
| 69 | 45 | CHAR(7) | Reserved |
| 76 | 4C | BINARY(4) | Pipe descriptor |
Request Field Descriptions
Asynchronous. An indicator of whether the read should be performed asynchronously. Values passed follow:
| 0 | Do not use asynchronous processing. |
| 1 | Use asynchronous processing. |
Buffer handle. The output buffer in which to read rows. Refer to Buffer Format for a description of this field.
Commit level. An indicator of the commitment control level under which to execute the SQL statements. Values passed follow:
| N | No commitment control. |
| C | Read uncommitted. |
| S | Read committed. |
| A | Repeatable read. |
| L | Serializable. |
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table, index or query instance to be used.
Key handle. The space containing the key.
Length of key columns. The key value for keyed operations.
Number of key columns. The number of key columns for keyed operations.
Object access intent. An indicator of whether the instance will be accessed as read-only or updatable. Values passed follow:
| 0x80 | Read-only. |
| 0xF0 | Updatable. |
Orientation. The orientation of the read. Values passed follow:
| 0x0B | Equal. |
| 0x09 | Before equal. |
| 0x0A | Before or equal. |
| 0x0D | After equal. |
| 0x0C | After or equal. |
| 0x10 | Last equal. |
| 0x11 | Previous to last equal. |
| 0x0E | Next equal. |
| 0x0F | Previous equal. |
| 0x01 | First. |
| 0x02 | Last. |
| 0x03 | Next. |
| 0x04 | Previous. |
| 0x21 | Same. |
Pipe descriptor. The write pipe descriptor for asynchronous. Refer to Reply Format for a description of the reply data written to the pipe. Values passed follow:
| -1 | Reuse previously passed descriptor for this instance. |
| n | Valid pipe descriptor where n>= 0. |
Relative row number. The relative row number to be read.
Return data. An indicator of whether data should be returned. Values passed follow:
| 0 | Do not return data. Positioning only. |
| 1 | Return data. |
Returned relative row numbers handle. The space in which to return relative row numbers for rows read.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_REORGANIZE_TABLE (Reorganize Table Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Object handle |
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
Object handle. The table share, index share, table instance or index instance to be used.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_RELEASE_ROW (Release Row Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
| 16 | 10 | CHAR(1) | Object access intent |
Request Field Descriptions
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table, index or query instance to be used.
Object access intent. An indicator of whether the instance will be accessed as read-only or updatable. Values passed follow:
| 0x80 | Read-only. |
| 0xF0 | Updatable. |
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
Reply Field Descriptions
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_UPDATE_ROW (Update Row Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
| 16 | 10 | BINARY(8) | Buffer handle |
| 24 | 18 | BINARY(4) | Relative row number |
Request Field Descriptions
Buffer handle. The input buffer containing updated rows. Refer to Buffer Format for a description of this field.
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table or index instance to be used. Query instances are not supported.
Relative row number. The relative row number to be updated. If not currently positioned on this row, the cursor will be repositioned.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
| 48 | 30 | BINARY(4) | Duplicate relative row number |
| 52 | 34 | BINARY(4) | Duplicate object offset |
| 56 | 38 | BINARY(4) | Duplicate object length |
| CHAR(*) | Duplicate object name | ||
Reply Field Descriptions
Duplicate object length. The length of the object name that caused the duplicate key error.
Duplicate object name. The object name that caused the duplicate key error.
Duplicate object offset. The offset from the beginning of the reply field to the object name that caused the duplicate key error.
Duplicate relative row number. The relative row number that encountered a duplicate key.
Error message ID. If an error occurs this is the message ID associated with the error.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
Format QMY_WRITE_ROWS (Write Rows Format)
The following information is specified in the request parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Format name |
| 2 | 2 | CHAR(2) | Reserved |
| 4 | 4 | BINARY(4) | Connection |
| 8 | 8 | BINARY(8) | Instance handle |
| 16 | 10 | BINARY(8) | Buffer handle |
| 24 | 18 | CHAR(8) | Reserved |
| 32 | 20 | CHAR(1) | Commit level |
Request Field Descriptions
Buffer handle. The input buffer containing rows to be written. Refer to Buffer Format for a description of this field.
Commit level. An indicator of the commitment control level under which to execute the SQL statements. Values passed follow:
| N | No commitment control. |
| C | Read uncommitted. |
| S | Read committed. |
| A | Repeatable read. |
| L | Serializable. |
Connection. The application connection making the request.
Format name. The input format.
Instance handle. The table or index instance to be used. Query instances are not supported.
The following information is returned in the reply parameter section.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name detecting error |
| 10 | A | CHAR(10) | Job user detecting error |
| 20 | 14 | CHAR(6) | Job number detecting error |
| 26 | 1A | CHAR(7) | Error message ID |
| 33 | 21 | CHAR(15) | Reserved |
| 48 | 30 | BINARY(8) | New identity value |
| 56 | 38 | BINARY(4) | Duplicate relative row number |
| 60 | 3C | BINARY(4) | Duplicate object offset |
| 64 | 40 | BINARY(4) | Duplicate object length |
| 68 | 44 | CHAR(1) | New identity value |
| 69 | 45 | CHAR(1) | Identity cycles |
| 70 | 46 | CHAR(6) | Reserved |
| 76 | 4C | BINARY(4) | Identity increment |
| CHAR(*) | Duplicate object name | ||
Reply Field Descriptions
Duplicate object length. The length of the object name that caused the duplicate key error.
Duplicate object name. The object name that caused the duplicate key error.
Duplicate object offset. The offset from the beginning of the reply field to the object name that caused the duplicate key error.
Duplicate relative row number. The relative row number that encountered a duplicate key.
Error message ID. If an error occurs this is the message ID associated with the error.
Identity cycles. An indicator of whether the identity column cycles. Values passed follow:
| 0 | Identity does not cycle. |
| 1 | Identity does cycle. |
Identity increment. The increment value for the identity column.
Job name detecting error. If an error occurs this is the name of the job detecting the error.
Job number detecting error. If an error occurs this is the number of the job detecting the error.
Job user detecting error. If an error occurs this is the user of the job detecting the error.
New identity value. An indicator of whether a new identity value was generated. Values passed follow:
| 0 | New identity value was not generated. |
| 1 | New identity value was generated. |
New identity value. The new identity value used if the table has an identity column.
Parameter Structures
In the following structures, the CCSID of the character field is the job CCSID unless a specific CCSID field is included in the format for the field.
Share Definition Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Reserved |
| 10 | A | CHAR(1) | Arrival sequence |
| 11 | B | CHAR(5) | Reserved |
| 16 | 10 | BINARY(4) | Object name length |
| 20 | 14 | CHAR(258) | Object name |
Parameter Descriptions
Arrival sequence. An indicator of whether arrival sequence should be used when accessing this object. Values passed follow:
| 0 | Arrival sequence is not to be used. |
| 1 | Arrival sequence is to be used. |
Object name. The object name.
Object name length. The length of the object name.
Object Definition Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(8) | Identity starting value |
| 8 | 8 | BINARY(4) | Column definitions offset |
| 12 | C | BINARY(2) | Column count |
| 14 | E | CHAR(13) | Level ID |
Parameter Descriptions
Column count. The number of columns.
Column definitions offset. The offset to the column definitions. Refer to Share Definition Format for a description of this field.
Identity starting value. The starting value in the object contains an identity column.
Level ID. The level identifier of the object. This is modified when the object is altered.
Column Definition Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(2) | Data type |
| 2 | 2 | BINARY(2) | Byte count |
| 4 | 4 | BINARY(2) | Column offset |
| 6 | 6 | CHAR(2) | CCSID |
Parameter Descriptions
Byte count. The byte count of the column.
CCSID. The CCSID of the column.
Column offset. The offset from the beginning of the row to the column.
Data type. The data type of the column.
Name Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Name length |
| 2 | 2 | CHAR(128) | Name |
Parameter Descriptions
Name. The name.
Name length. The length of the name.
Constraint Header Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Constraint offset |
| 4 | 4 | BINARY(4) | Constraint length |
| 8 | 8 | CHAR(1) | Constraint type |
| CHAR(*) | Constraint | ||
Parameter Descriptions
Constraint. The constraint. Refer to Constraint Format for a description of this field.
Constraint length. The length of the constraint.
Constraint offset. The offset of the constraint.
Constraint type. An indicator of the constraint type. Values passed follow:
| 0 | Foreign key. |
Constraint Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(144) | Constraint name |
| 144 | 90 | CHAR(144) | Referenced table schema name |
| 288 | 120 | CHAR(144) | Referenced table name |
| 432 | 1B0 | BINARY(4) | Key count |
| 436 | 1B4 | BINARY(4) | Referenced key count |
| 440 | 1B8 | BINARY(4) | Foreign key columns offset |
| 444 | 1BC | BINARY(4) | Referenced key columns offset |
| 448 | 1C0 | BINARY(2) | Update method |
| 450 | 1C2 | BINARY(2) | Delete method |
Parameter Descriptions
Constraint name. The constraint name. Refer to Name Format for a description of this field.
Delete method. An indicator of the delete method. Values passed follow:
| 0 | No action. |
| 1 | Cascade. |
| 2 | Set default. |
| 3 | Set null. |
| 4 | Restrict. |
Key columns offset. The offset to the key columns.
Key count. The key count.
Referenced key columns offset. The offset to the referenced key columns.
Referenced key count. The referenced key count.
Referenced table name. The referenced table name. Refer to Name Format for a description of this field.
Referenced table schema name. The referenced table schema name. Refer to Name Format for a description of this field.
Update method. An indicator of the update method. Values passed follow:
| 0 | No action. |
| 4 | Restrict. |
Time Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Year |
| 2 | 2 | BINARY(2) | Month |
| 4 | 4 | BINARY(2) | Day |
| 6 | 6 | BINARY(2) | Hour |
| 8 | 8 | BINARY(2) | Minute |
| 10 | A | BINARY(2) | Second |
Parameter Descriptions
Day. The day.
Hour. The hour.
Minute. The minute.
Month. The month.
Second. The second.
Year. The year.
Key Bound Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(2) | Reserved |
| 2 | 2 | BINARY(2) | Value position |
| 4 | 4 | CHAR(1) | Null value |
| 5 | 5 | CHAR(1) | Infinity value |
| 6 | 6 | CHAR(1) | Inclusion/Exclusion |
Parameter Descriptions
Inclusion/Exclusion. An indicator of inclusion or exclusion of the value. Values passed follow:
| 0 | Inclusion. |
| 1 | Exclusion. |
Infinity value. .An indicator of whether the value is infinity. Values passed follow:
| 0 | No infinity. |
| 1 | Positive infinity. |
| 2 | Negative infinity. |
Null value. An indicator of whether the value is null. Values passed follow:
| 0 | Value is not null. |
| 1 | Value is null. |
Value position. The value position.
Key Bounds Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(16) | Low bound |
| 16 | 10 | CHAR(16) | High bound |
Parameter Descriptions
High bound. The high bound. Refer to Key Bound Format for a description of this field.
Low bound. The low bound. Refer to Key Bound Format for a description of this field.
Literal Definition Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Literal value offset |
| 4 | 4 | BINARY(2) | Literal value length |
| 6 | 6 | BINARY(2) | Literal column number |
| 8 | 8 | BINARY(2) | Literal data type |
Parameter Descriptions
Literal column number. The column associated with this literal.
Literal data type. The data type of the literal value.
Literal value length. The length of the literal value.
Literal value offset. The offset to the literal value.
Buffer Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Max row count |
| 4 | 4 | BINARY(4) | Used row count |
Parameter Descriptions
Max row count. The maximum number of rows that can fit in the buffer.
Used row count. The number of rows currently used in the buffer.
Reply Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Return code |
| 4 | 4 | BINARY(4) | Cumulative row count |
Parameter Descriptions
Cumulative row count. The cumulative number of rows that have been asynchronously read.
Return code. The return code from a single asynchronous read.
SQL Statement Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Sort sequence name |
| 10 | A | CHAR(10) | Sort sequence schema |
| 20 | 14 | CHAR(12) | Reserved |
| 32 | 20 | BINARY(4) | SQL statement length |
| CHAR(*) | SQL statement | ||
Parameter Descriptions
Sort sequence name. The sort sequence name to be used.
Sort sequence schema. The sort sequence schema to be used.
SQL statement. The SQL statement text.
SQL statement length. The length of the SQL statement.
Error Messages
The following messages may be sent from this function:
| Message ID | Error Message Text |
|---|---|
| CPF3CF2 E | Possible APAR condition or hardware failure. |
| CPFB751 E | Invalid parameter. |
API introduced: V6R1 with PTF
[ Back to top | Database APIs | APIs by category ]