StatementInformation - Call-Level Interface Version 2

Flavor

Parcel Body Length

Parcel Body Fields

169

6 to maximum parcel size

Self-defining extensions: Six or more bytes

Field

Length

Description

PBTILOUT

2-byte unsigned integer

Information Layout identifies the layout of the data following the header as one of the following:

1 Full-layout

2 Limited-layout

3 Statistic-layout

4 End-information

5 Untransformed limited-layout used only in requests, for details refer to Table 76 on page 472.

Note: To allow for future enhancement, other values must be ignored.

PBTIID

2-byte unsigned integer

Information Id identifies the type of extension as one of the following integers:

1 - Parameter (used only when DBCAREA Request‑processing‑option is 'S' (Prepare mode supporting parameterized SQL) (corresponding to the Options parcel (flavor 85) Function 'S' option), which describes each item specified by a parameter (indicated by question mark) in the SQL statement.

2 - Query, which describes each item (field or column) returned by an SQL SELECT statement.

3 - Summary, which describes each summary item returned by a WITH clause of an SQL SELECT statement.

4 - Identity‑column, which describes each item (field or column) returned by an SQL INSERT statement, as requested by DBCAREA Return‑identity‑data (corresponding to Options parcel (flavor 85) IdentityColumnRetrieval)

5 - Stored‑procedure‑Output, which describes each item returned by a stored‑procedure OUT or INOUT parameter.

6 - Stored‑procedure‑resultSet, which describes each row returned by a stored‑procedure.

7 - Estimated‑processing, which provides an estimate of the execution time for the statement.

8 - Data-attributes. Used only in requests. For details see “StatementInformation” on page 511.

Note: To allow for future enhancement, other values must be ignored.

PBTILEN

2-byte unsigned integer

Information Length specifies the length of subsequent data in the extension (does not include the length of the extension header).

Note: To allow for future enhancement, lengths longer than expected, along with the additional data, must be ignored.

Field

Length

Description

PBTIFDB

2 byte unsigned integer plus the number of bytes specified by that integer

Database‑name consisting of the length in bytes of the name, followed by that name in characters from the current session character set. If the name does not apply in the SQL statement's context or is not available, the length is zero and no name is present. The maximum length of a name may be obtained using the DBCHQE SQL‑limits query.

PBTIFTB

2 byte unsigned integer plus the number of bytes specified by that integer

Table, View, or Procedure name consists of the length in bytes of the name, followed by that name in characters from the current session character set. If the name does not apply in the SQL statement's context or is not available, the length is zero and no name is present. The maximum length of a name may be obtained using the DBCHQE SQL‑limits query.

PBTIFCN

2 byte unsigned integer plus the number of bytes specified by that integer

Column, User‑defined Function (UDF), User-defined Method (UDM), Stored-procedure, or parameter name consists of the length in bytes of the name, followed by that name in characters from the current session character set. If the name does not apply in the SQL statement's context or is not available, the length is zero and no name is present. The maximum length of a name may be obtained using the DBCHQE SQL-limits query.

PBTIFCP

2 byte unsigned integer

The relative position of the column within the table, with the first column having a value of '1'. If the value does not apply in the SQL statement's context (for example, the item is an expression) or is not available, a zero is present

PBTIFAN

2 byte unsigned integer plus the number of bytes specified by that integer

AS‑name consists of the length in bytes of the column name as renamed by an SQL AS‑clause, followed by that name in characters from the current session character set. If the name does not apply in the SQL statement's context or is not available, the length is zero and no name is present.

PBTIFT

2 byte unsigned integer plus the number of bytes specified by that integer

Column Title consists of the length in bytes of the title, followed by that title in characters from the current session character set. If the title does not apply in the SQL statement's context (for example, the item is an expression) or is not available, the length is zero and no title is present. The maximum length is not externally provided by the Database so the only limit available is 65535.

PBTIFF

2 byte unsigned integer plus the number of bytes specified by that integer

Column Format consists of the length in bytes of the format, followed by that format in characters from the current session character set. If the format does not apply in the SQL statement's context (for example, the item is an expression) or is not available, the length is zero and no format is present. The maximum length is not externally provided by the Database so the only limit available is 65535.

PBTIFDV

2 byte unsigned integer plus the number of bytes specified by that integer

Default Value consists of the length in bytes of the default, followed by that default in characters from the current session character set. If the default does not apply in the SQL statement's context (for example, the item is an expression) or is not available, the length is zero and no default is present.

PBTIFIC

1 byte character

Set to an EBCDIC 'Y' if the column is an Identity Column; 'N' otherwise. If an Identity column is not involved or the information is not available, an EBCDIC 'U' is set.

PBTIFDW

1 byte character

Set to an EBCDIC 'Y' if the column is definitely writable (that is, the user has permission to update the column); 'N' otherwise (the item is not a column or the user's permission is insufficient).

PBTIFNL

1 byte character

Set to an EBCDIC 'Y' if NULLs can be stored in item (columns not defined NOT NULL); 'N' otherwise (for example, the item is an expression). If this concept does not apply in the SQL statement's context or the information is not available, an EBCDIC 'U' is set.

PBTIFMN

1 byte character

Set to an EBCDIC 'Y' if NULLs can be returned for the item; 'N' otherwise. If this concept does not apply in the SQL statement's context or the information is not available, an EBCDIC 'U' is set.

PBTIFSR

1 byte character

Set to an EBCDIC 'Y' if the item is permitted in a WHERE SQL clause; 'N' otherwise (for example, the result is a Large Object (LOB)). If this concept does not apply in the SQL statement's context or the information is not available, an EBCDIC 'U' is set.

PBTIFWR

1 byte character

Set to an EBCDIC 'Y' if the column is writable (the item is a modifiable column); 'N' otherwise (for example, the item is an expression).

PBTIFDT

2 byte unsigned integer

Specifies the data type of the item returned. If the type is ambiguous (for example, the item is a parameter in an expression) or is not available, a zero is set. In addition to the data types available for the PrepInfo[X] (flavor 86 or 125) and DataInfo[X] (flavor 71 or 146) parcels, see Table 65 on page 428 for the possible data types. See Table 76 on page 472 for additional data types that are also supported.

PBTIFUT

2 byte unsigned integer

For user-defined types, a binary 1 will be set for structured types, 2 for distinct types, or 3 for internal types. If the type is ambiguous (for example, a parameter in an expression) or is not available, a zero is set.

PBTIFTY

2 byte unsigned integer plus the number of bytes specified by that integer

Type Name consists of the length in bytes of the name, followed by that name in characters from the current session character set. If the name does not apply in the SQL statement’s context (for example, the type is not user-defined) or is not available, the length is zero and no name is present. The maximum length of a name may be obtained using the DBCHQE SQL‑limits query.

PBTIFMI

2 byte unsigned integer plus the number of bytes specified by that integer

Data Type Miscellaneous Information consists of the length in bytes of the information, followed by that information in characters from the current session character set. If the information does not apply in the SQL statement’s context (for example, the type has no information) or is not available, the length is zero and no information is present.

PBTIFMDL

8 byte unsigned integer

The total number of bytes of data that might be returned for this item.

PBTIFND

2 byte unsigned integer

The total number of digits if the item has a decimal or numeric data type. For other data types, a zero is returned.

PBTIFNID

2 byte unsigned integer

The number of interval digits if the item is a temporal data type. For other data types, a zero is returned.

PBTIFNFD

2 byte unsigned integer

The number of fractional digits if the item is a decimal data type (or the deprecated temporal types such as time, timestamp, interval...to second, and interval second). For other data types, a zero is returned.

PBTIFCT

1 byte unsigned integer

The character set type of the item, as either 1 if Latin, 2 if Unicode®, 3 if Japanese Shift-JIS, 4 if Graphic, or 5 if Japanese Kanji1. If not character data, a zero is returned.

PBTIFMNC

8 byte unsigned integer

The total number of characters returned for this item. A value of zero is set if not character data.

PBTIFCS

1 byte unsigned character

Set to an EBCDIC 'Y' if a character item is case sensitive (column defined CASESPECIFIC); 'N' if not or not a character item. If this concept does not apply in the SQL statement’s context or the information is not available, an EBCDIC 'U' is set.

PBTIFSN

1 byte unsigned character

Set to an EBCDIC 'Y' if a numeric item is signed; 'N' if unsigned (the BYTE data type) or not a numeric item. If this concept does not apply in the SQL statement's context or the information is not available, an EBCDIC 'U' is set.

PBTIFK

1 byte unsigned character

Set to an EBCDIC 'Y' if the columns uniquely describes the row; 'N' otherwise. If this concept does not apply in the SQL statement's context or the information is not available, an EBCDIC 'U' is set.

PBTIFU

1 byte unsigned character

Set to an EBCDIC 'Y' if the column is the only member of a unique index; 'N' otherwise. If this concept does not apply in the SQL statement's context or the information is not available, an EBCDIC 'U' is set.

PBTIFE

1 byte unsigned character

Set to an EBCDIC 'Y' if the item is an expression; 'N' otherwise. If this concept does not apply in the SQL statement’s context or the information is not available, an EBCDIC 'U' is set.

PBTIFSO

1 byte unsigned character

Set to an EBCDIC 'Y' if the item is permitted in an ORDERBY SQL clause; 'N' otherwise (for example, the result is a Large Object (LOB)). If this concept does not apply in the SQL statement's context or the information is not available, an EBCDIC 'U' is set.

Note: Due to the large number of variable-length fields (fields containing a length followed by that amount of data), great care is required to process a Full-layout extensions. To locate a field requires that the length of all previous variable-length fields be inspected.

Field

Length

Description

PBTIFTP

1-byte character

Set to one of the following EBCDIC characters:

If the item is not a stored‑procedure parameter or the information is not available, an EBCDIC 'U' set.

PBTIFDOS

2 bytes

When Transforms are off for this type of item, the depth of this attribute of the item's structure. A value of zero indicates the item is not a structure or Transforms are not off. Other values indicate the nesting level of the structure

PBTIFTC

1-byte character

Set to one of the following EBCDIC characters:

PBTIFUA

2 byte unsigned integer plus the number of bytes specified by that integer

When Transforms are off for this type of item, Untransformed Attribute Name consists of the length in bytes of the name of this attribute in the item's structure, followed by that name in characters from the current session character set. If the item is not a structure or Transforms are not off, the length is zero and no name is present. The maximum length of a name may be obtained using the DBCHQE SQL-limits query.

PBTIFTDT

2 byte unsigned integer

When Transforms are off for this type of item, specifies the data type of the untransformed item. If the item is not a structure or Transforms are not off, the value is zero. In addition to the data types available for the PrepInfo[X] (flavor 86 or 125) and DataInfo[X] (flavor 71 or 146) parcels, which are defined in "DataType" Table 65 on page 428. Table 65 shows additional types that are supported.