Retrieve Member Description (QUSRMBRD) API


  Required Parameter Group:


  Optional Parameter Group 1:


  Optional Parameter Group 2:


  Default Public Authority: *USE

  Threadsafe: Conditional; see Usage Notes.

The Retrieve Member Description (QUSRMBRD) API retrieves specific information about a single database file member and returns the information to the calling program in a receiver variable. The length of the receiver variable determines the amount of data returned. You can only use the QUSRMBRD API with database file types *PF, *LF, and *DDMF.

You can use the QUSRMBRD API to:


Authorities and Locks

Library Authority
*USE
File Authority
*OBJOPR
File Lock
*SHRRD

Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The receiver variable that is to receive the information requested. You can specify that the size of the area be smaller than the format requested as long as you specify the length of the receiver variable parameter correctly. As a result, the API returns only the data the area can hold.

Length of receiver variable
INPUT; BINARY(4)

The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.

Format name
INPUT; CHAR(8)

The content and format of the information to be returned for each specified member. The following format names are valid:



Qualified database file name
INPUT; CHAR(20)

The name of the database file containing the specified member whose information is to be retrieved, and the library in which it is located. The first 10 characters contain the database file name, and the second 10 characters contain the library name.

You can use these special values for the library name:



Database member name
INPUT; CHAR(10)

The name of the database member for which information is to be retrieved. Special values follow:



Override processing
INPUT; CHAR(1)

Whether overrides are to be processed. The possible values are:




Optional Parameter Group 1

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.


Optional Parameter Group 2

Find member processing
INPUT; CHAR(1)

The method to use to find the member. There are two ways to find the member for which information is to be retrieved. The possible values are:

If a specific library is used to find the member, or if the member name specified is *FIRST or *LAST, the two ways will always find the same member. If *LIBL is used for the library name and a specific member name is specified (not *FIRST or *LAST), then the two ways can produce different results. See Find Member Example.

The find member directly method is not supported when all of the following conditions exist:

  • *LIBL is specified as the library.
  • The member name is not specified as *FIRST or *LAST.
  • The member name is not found in any of the files in the library list.
  • The first occurrence of the file in the library list is a DDM file.
  • The library name specified for the remote file (RMTFILE parameter on the Create DDM File (CRTDDMF) command) is *LIBL.

When this situation occurs, an error is returned from QUSRMBRD because it cannot determine which file on the remote system on OPEN operation would find. API users can monitor for this error and then reissue the API call specifying the find file first method.

Find Member Example . File F exists in libraries LIB1 and LIB2 in the library list. If *LIBL is specified as the library for file F and member X, option 0 will not find member X because it does not exist in the file LIB1/F. Option 1 will find member X in the file LIB2/F.

Libraries in library list


Format of the Generated Information

The file member description can be provided in one of four formats:

The structure of the information returned is determined by the value specified for the format name. For details about these formats, see the following sections. For detailed descriptions of the fields in the list, see Field Descriptions.

If an offset equals zero in the returned information, there is no corresponding structure associated with it.

MBRD0100 Format, MBRD0200 Format, and MBRD0300 Format show how the information for the first three formats is organized. When more than one entry can appear, the figure indicates this as in (A).

MBRD0100 Format
MBRD0100 Format

MBRD0200 Format
MBRD0200 Format

MBRD0300 Format
MBRD0300 Format

MBRD0100 Format

The MBRD0100 format includes the file member list and source information shown in the following table.



MBRD0200 Format

The MBRD0200 format includes the file member name and the expanded information shown in the following table.



MBRD0300 Format

The MBRD0300 format includes the file member list and the full information shown in the following table. This includes some key fields that are applicable only to the file (not member) one might use, and fields unique to the member.



Record Format and Based-On File List Entry

The second from the last entry in the MBRD0300 format is the record format and based-on file list. There can be several entries with the information presented in the order shown in the following table. Because there can be several, it is not possible to list the exact offsets for the 112 bytes. Physical files always have only one entry. To determine the number of entries for a logical file, refer to the value in the number of based-on physical file members field in the MBRD0200 format.



Constraint Indexes Information

The last entry in the MBRD0300 format is the constraint indexes information list. There can be several entries with the information presented in the order shown in the following table. Because there can be several entries, it is not possible to list the exact offsets of the 321 bytes in each entry. The CHAR(8) fields (number of constraint logical-access-path read requests and the number of constraint physical-access-path read requests) are actually BINARY(8) fields and require conversion by the high-level language program that is used.



Additional MBRD0200 Format Information

Additional information for the MBRD0200 format is accessed using the offset to additional MBRD0200 format information and length of additional MBRD0200 format information values. The offset places the data at the end of the format requested. There can be only one entry with the information presented in the order shown in the following table. The CHAR(8) fields for the data space activity statistics and for the data space index activity statistics are actually BINARY(8) fields and require redefinition by the high-level language program used.

The counts for the data space activity statistics are intended to be approximate counts that are associated with the object since the last IPL. These counts are intended to monitor performance statistics on the object and are meant only to show trends in the operational use against the object.



MBRD0400 Format

The MBRD0400 format includes information about data space indexes associated with a physical file member as shown in the following table. Data space indexes are part of either file members or constraints. File members or constraints that share another file member's or constraint's data space index are not returned. If the specified member is not a physical file member, an error is returned from QUSRMBRD.



Data Space Index List Entry

The last entry in the MBRD0400 format is the data space index list. There can be several entries in the data space index list with the information presented in the order shown in the following table. Names in the data space index list are long alias names. If the logical file that owns the data space index is a multi-format file, the fields will be for the single format.End of change



MBRD0500 Format

The MBRD0500 format includes information about materialized query tables associated with a physical file member or logical file member as shown in the following table. If the member is a physical file member, all materialized query tables built over the physical file member and all materialized query tables built over all logical file members that are dependent on the physical file member will be returned. If the member is a logical file member, only materialized query tables built directly over the logical file member are returned.



Data Space Materialized Query Table List Entry

The last entry in the MBRD0500 format is the materialized query table list. There can be several entries in the materialized query table list with the information presented in the order shown in the following table. Names in the materialized query table list are long alias names.



Field Descriptions

Access path held. Indicates if rebuild of access path is held. More information can be found in the Edit Rebuild Access Path (EDTRBDAP) command. Possible values are:

Access path journaled. Whether the access path is journaled.

Access path maintenance. Specifies, for files with key fields or join logical files, the type of access path maintenance used for all members of the physical or logical file. The possible values are:

Access path owner file name. The file name that owns the access path. This field only applies to join logical files or keyed files.

Access path owner library name. The library in which the file resides that owns the access path. This field only applies to join logical files or keyed files.

Access path owner member name. The member within the qualified file name that owns the access path. This field only applies to join logical files or keyed files.

Access path recovery. Whether the access path for the constraint, is rebuild immediately when damage to the access path is recognized.

Access path shared. Whether an access path is shared. The possible values are:

Access path size. The access path size in bytes for this file member. If the file member is not keyed, the value 0 is returned. DDM files, which are not from a System/38™ or System i™ platform, return value 0.

Access path size multiplier. The value to multiply the access path size by to get its true size.

Access path valid. Whether the access path is valid. The possible values for all formats other than MBRD0400 are:

The possible values for the MBRD0400 format are:

Allow delete operation. Whether records in this file can be deleted. The possible values are:

Allow read operation. Whether records in the physical file can be read. The possible values are:

Allow update operation. Whether records in this file can be updated. The possible values are:

Allow write operation. Whether records can be written to the file. The possible values are:

Based-on physical file library name. The library in which the based-on physical file resides. This field is blank for a physical file.

Based-on physical file member name. The physical file member this logical file member is based on. The number of elements in this array is defined by the number of based-on physical file members field. This field is blank for a physical file.

Based-on physical file name. The name of the physical file that contains the data associated with the logical file member. This field is blank for a physical file.

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Change date and time. The date and time this member was changed. This field is in the CYYMMDDHHMMSS format as follows:

Code size. The length of the code assigned to each distinct key value of an encoded vector index. If the access path is not an encoded vector, the value 0 is returned.

Constraint library name. The name of the library containing the file to which the referential constraint applies.

Constraint name. The name of the referential constraint that controls the insertion, deletion, and update of fields that refer to like fields in a parent file.

Constraint name length. The length of the referential constraint name. The maximum length is 258 characters for delimited names and 128 characters for non-delimited names.

Creation date and time. The date and time the member was created. This field is in the CYYMMDDHHMMSS format, which is described in the change date and time field description.

Current number of increments. The number of increments that have been added to the member size (data space size). This field is 0 for logical files because the number of increments only applies to physical files.

Current number of records. The number of records that currently exist in this member. A keyed logical file member returns the number of index entries. A nonkeyed logical file member returns the number of records in the based-on physical file member. If the requested physical file member is suspended, the value 0 is returned.

Current number of records, if less than 2,147,483,647. The number of records that currently exist in this member. A keyed logical file member returns the number of index entries. A nonkeyed logical file member returns the number of records in the based-on physical file member. If the requested physical file member is suspended, the value -1 is returned. If the number of records is greater than or equal to 2,147,483,647, the value -2 is returned.

Current number of records for all based-on members. The number of records that currently exist in this member. A logical member returns the summarization of index entries. If the requested physical file member is suspended, the value 0 is returned.

Current number of records for all based-on members, if less than 2,147,483,647. The number of records that currently exist in this member. A logical member returns the summarization of index entries. If the requested physical file member is suspended, the value -1 is returned. If the number of records is greater than or equal to 2,147,483,647, the value -2 is returned.

Data space activity statistics. Information on the activity that has occurred on this member since the last IPL. All of these values are reset to binary 0 the first time the object is used after or during an IPL.

Data space index activity statistics. Information on the activity that has occurred on this member access path since the last IPL. All of these values are reset to binary 0 the first time the object is used after or during an IPL.

Data space index attributes. Information on the attributes of the data space index.

Data space index creation date and time. The date and time this data space index was created. This is in the YYYYMMDDHHMMSS format.

Data space index DECFLOAT rounding mode. Indicates what rounding should occur on decimal floating point (DECFLOAT) calculations. The possible values are:

Data space index DECFLOAT warning. Indicates whether warnings should be returned from decimal floating point (DECFLOAT) calculations. The possible values are:

Data space index derived key. Whether the each key field defined for the data space index has the same attributes and is directly mapped from a field in the based on physical file member, or whether some mapping or derivation is performed to produce the key values. The possible values are:

Data space index held. Indicates if rebuild of the data space index is held. More information can be found in the Edit Rebuild of Access Paths (EDTRBDAP) command. Possible values are:

Data space index keep in memory. Indicates if the data space index should be kept in memory. Possible values are:

Data space index key length. The maximum length of the key of the data space index.

Data space index key field names length. The length of the key field names.

Data space index key field names. A list of each key field of the data space index. Each key field name is separated by a comma and a blank. The list of key field names will be truncated if it exceeds 1024 bytes.

Data space index last query statistics use. The date and time the last time this data space index was used for statistics when optimizing a query. This is in the YYYYMMDDHHMMSS format.

Data space index last query use. The date and time the last time this data space index was used in a query full open. This is in the YYYYMMDDHHMMSS format.

Data space index last rebuild date and time. The date and time the last time this data space index was rebuilt. This is in the YYYYMMDDHHMMSS format.

Data space index list. Information about all the data space indexes build on a physical file member.

Data space index maintenance. Specifies the type of maintenance used for the data space index. The possible values are:

Data space index media preference. Indicates the media preference for the data space index. Possible values are:

Data space index owning file member or constraint. Information on the owner of the data space index. A data space index can be owned by a file member or a constraint.

Data space index owner. The owner of the data space index.

Data space index owning file name. The short name of the file that owns the index.

Data space index owning file text. The text of the file that owns the index.

Data space index owning file text CCSID. The CCSID of the text of the file that owns the index.

Data space index owning file text length. The length of the text of the file that owns the index.

Data space index partitioned. Whether the data space index contains key values from a single physical file member or whether the data space index contains key values from more than one data space. The possible values are:

Data space index query use count. The number of times the index has been used in a full open of a query since the start of V5R3 or since the count has been reset by CHGOBJD.

Data space index query statistics use count. The total number of times the index has been used for statistics when optimizing a query since the start of V5R3 or since the count has been reset by CHGOBJD.

Data space index query statistics second use count. The number of times the index has been used for more expensive statistics when optimizing a query since the start of V5R3 or since the count has been reset by CHGOBJD.

Data space index recovery. Whether the data space index is rebuild immediately when damage to the access path is recognized after an abnormal IPL.

Data space index size. The size, in bytes, of the data space index.

Data space index sort sequence. Indicates whether the keys in the index use a sort sequence. The possible values are:

Data space index sparse. Whether the data space index contains selection criteria that limits the rows which have keys in the data space index. The possible values are:

Data space index statistics. Information on the current statistics of the data space index.

Data space index type. Indicates the type of the data space index. The possible values are:

Data space index unique. Indicates whether the keys in the data space index are unique and if not what order is maintained for duplicate keys. The possible values are:

Data space index valid. Whether the data space index is valid. The possible values are:

Data space index WHERE clause. The SQL WHERE clause of the data space index. The WHERE clause will be truncated if it exceeds 1024 bytes.

Data space index WHERE clause CCSID. The CCSID of the SQL WHERE clause.

Data space index WHERE clause has UDF. The SQL WHERE clause contains a User Defined Function (UDF).

Data space index WHERE clause length. The length of the SQL WHERE clause.

Data space size. The size of the space that contains the data of the file member, in bytes. A logical file returns a 0.

Data space size multiplier. The value to multiply the data space size by to get its true size. Typically this is 1, but for large files, the value may be greater than 1. If the data space size multiplier is greater than 1, then the value in the data space size field is not the actual size of the file.

Database file library name. The name of the library that contains the file.

Database file name. The name of the file from which the member list was retrieved.

Date last used. The century and date this member was last used. The date last used field is in the CYYMMDD format as follows:

Days used count. The number of days the object was used. If the object does not have a last used date, the count is 0.

Estimated rebuild time. The estimated time, in seconds, to completely rebuild the access path. If the access path is being rebuilt currently, the value is -1. If a delayed maintenance index is being caught up currently, the value is -2. For an encoded vector index, the value is 0.

Expiration date. The date that this member expires. This is in the CYYMMDD format, which is the same format described for the date last used field description.

File attribute. The type of file found:

File library name length. Length of the name of the library that contains the file member that owns the materialized query table.

File library name. Name of the library that contains the file member that owns the materialized query table.

File name length. Length of the name of the file that owns the materialized query table.

File name. Name of the file that owns the materialized query table.

File or constraint library name length. Length of the name of the library that contains the file member or constraint that owns the data space index.

File or constraint library name. Name of the library that contains the file member or constraint that owns the data space index.

File or constraint name length. Length of the name of the file or constraint that owns the data space index.

File or constraint name. Name of the file or constraint that owns the data space index.

File member name length. Length of the name of the file member that owns the data space index or materialized query table. This field is zero if the data space index is owned by a constraint.

File member name. Name of the file member that owns the data space index or materialized query table. This field is blank if the data space index is owned by a constraint.

File member or constraint type. Type of the file member or constraint that owns the data space index. A data space index can be owned by a file member or a constraint.

Force keyed access path. Force the access path to be keyed.

Format name. The definition of how data is structured in the records contained in a file. If this is a join logical file or SQL view file, the format name is only valid for the entry in the record format and based-on file member list array.

Increment number of records. The maximum number of records that are automatically added to the member when the number of records in the member is greater than the initial member size. This field applies only to physical files and is 0 for logical files.

Initial number of records. The number of records that can be written to each member of the file before the member size is automatically extended. This field applies only to physical files and is 0 for logical files.

Join member. Whether the member's logical file member combines (in one record format) fields from two or more physical file members.

Journal receiver's ASP device description name. The name of the ASP device description that contained the journal receiver's library.

Journal receiver's library name. The name of the library that contained the journal receiver.

Journal receiver's name for transaction recovery. The earliest journal receiver that will be needed to recover using either the Apply Journaled Changes (APYJRNCHG) or the Remove Journaled Changes (RMVJRNCHG) command.

Last change date. The date the object was last changed. This field is in the YYYYMMDDHHMMSS format. If the object has no last changed date, the field is blank.

Last rebuild date and time. The data and time of the most recent, successful rebuild or delayed maintenance catch up of the access path. This field is in the CYYMMDDHHMMSS format, which is described in the change date and time field description.

Last source change or table refresh date and time. For source files, the date and time that this source member was last changed. For SQL materialized query tables, the date and time that the last SQL Refresh Table statement refreshed this member. If the member has never been refreshed, this field will contain hexadecimal zeroes. This field is in the CYYMMDDHHMMSS format, which is in the same format as the change date and time field.

Last rebuild degree. The parallel degree used for the last rebuild of the access path. If the information is not available, 0 is returned. The valid values are:

Last rebuild elapsed time. The elapsed time, in seconds, of the last rebuild of the access path. If the information is not available, 0 is returned.

Last rebuild number of keys. The number of keys for the last rebuild of the access path. If the information is not available, 0 is returned.

Last rebuild number of tasks. The parallel number of tasks used for the last rebuild of the access path. If the information is not available, 0 is returned.

Last used date. The date the object was last used. This field is in the YYYYMMDDHHMMSS format. If the object has no last used date, the field is blank.

Logical file or physical file. Whether the file is a logical or physical file. The possible values are:

Logical file record format number. The entry number in the record format and based-on file member list. This number then corresponds to the based-on member listed in this entry. This field only applies to logical files and is 0 for a physical file.

Logical page size. The number of bytes used for the access path's logical page size. If the access path is an encoded vector, the value 0 is returned.

Materialized query table attributes. Information on the attributes of the materialized query table.

Materialized query table creation date and time. The date and time this materialized query table was created. This is in the YYYYMMDDHHMMSS format.

Materialized query table DECFLOAT rounding mode. Indicates what rounding should occur on decimal floating point (DECFLOAT) calculations. The possible values are:

Materialized query table DECFLOAT warning. Indicates whether warnings should be returned from decimal floating point (DECFLOAT) calculations. The possible values are:

Materialized query table enabled. Whether the materialized query table can be used for query optimization. Possible values are:

Materialized query table initial data. Whether data was inserted into the materialized query table when it was created. Possible values are:

Materialized query table last query statistics use. The date and time the last time this materialized query table was used for statistics when optimizing a query. This is in the YYYYMMDDHHMMSS format.

Materialized query table last query use. The date and time the last time this materialized query table was used in a query full open. This is in the YYYYMMDDHHMMSS format.

Materialized query table last refresh date and time. The date and time this materialized query table was last refreshed. This is in the YYYYMMDDHHMMSS format.

Materialized query table list. Information about all the materialized query tables built on a file member.

Materialized query table maintenance mode. Whether the materialized query table is maintained by the user or the system. Materialized query tables are currently only maintained by the user. Possible values are:

Materialized query table name. The short name of the file that owns the index.

Materialized query table owner. The owner of the data space index.

Materialized query table owning file member. Information on the owner of the materialized query table.

Materialized query table query use count. The number of times the materialized query table has been used in a full open of a query since the start of V5R4 or since the count has been reset by CHGOBJD.

Materialized query table query statistics use count. The total number of times the materialized query table has been used for statistics when optimizing a query since the start of V5R4 or since the count has been reset by CHGOBJD.

Materialized query table refresh isolation level. The isolation level the SQL SELECT statement will run under during the REFRESH TABLE SQL statement. Possible values are:

Materialized query table refresh mode. Whether the materialized query table can be refreshed at any time using the REFRESH TABLE SQL statement. Materialized query tables are currently only refreshed using the REFRESH TABLE SQL statement. Possible values are:

Materialized query table restore deferred. Indicates that the restore of a materialized query table is deferred till one of the dependent files is restored.

Materialized query table row count. The number of rows currently in the materialized query table.

Materialized query table SELECT attributes. Information about the SQL SELECT statement of the materialized query table.

Materialized query table SELECT statement. The SQL SELECT statement of the materialized query table. A maximum of 30000 bytes of the SQL SELECT statement will be returned. The QDBRTVFD API can be used if the SQL statement exceeds 30000 bytes in length.

Materialized query table SELECT statement length. The length of the SQL SELECT statement of the materialized query table.

Materialized query table SELECT statement CCSID. The CCSID of the SQL SELECT statement of the materialized query table.

Materialized query table size. The size, in bytes, of the materialized query table.

Materialized query table sort sequence. Indicates whether the keys in the materialized query table uses a sort sequence. The possible values are:

Materialized query table sort sequence table library name. The library in which the sort sequence table resides that was used for comparisons in the materialized query table. The field contains blanks if a sort sequence was not used to create the materialized query table.

Materialized query table sort sequence table name. The sort sequence table that was used for comparisons in the materialized query table. The field contains blanks if a sort sequence was not used to create the materialized query table.

Materialized query table sort sequence language ID. The language ID that was used to identify the sort sequence table that was used for comparisons in the materialized query table. The field contains blanks if a sort sequence was not used to create the materialized query table.

Materialized query table sort sequence weight. The sort sequence weight that was used for comparisons in the materialized query table. The field contains blanks if a sort sequence was not used to create the materialized query table. Possible values are:

Materialized query table statistics. Information on the current statistics of the materialized query table.

Materialized query table text. The text of the file that owns the index.

Materialized query table text CCSID. The CCSID of the text of the file that owns the index.

Materialized query table text length. The length of the text of the file that owns the index.

Maximum number of increments. The maximum number of increments automatically added to the member size. This field only applies to physical files and is 0 for a logical file.

Maximum percentage of deleted records allowed. The maximum allowed percentage of deleted records for each member in the physical file. The percentage check is made when the member is closed. If the percentage of deleted records is greater than the value shown, a message is sent to the history log. This field only applies to physical files and is 0 when either no deleted records are allowed or the file is a logical file.

Media Preference. The preferred auxiliary storage for the member. Possible values are:

Member name. The name of the member whose description is being retrieved.

Member text description. The member's text description.

Member text description CCSID. The CCSID for the member text description. The job default CCSID of the current process will be used to translate the text. For more information about CCSID, see the i5/OS globalization topic collection.

Number of access path build and rebuild operations. The number of access paths, both permanent and temporary, that have been built over this member since the last IPL.

Number of access path entries. The number of access path entries the physical file has for constraints.

Number of activate operations. The number of times that an open operation has been performed over this member since the last IPL.

Number of based-on physical file members. The number of database file members for the logical file member. If the member is a physical file member, the value is 0.

Number of constraint logical-access-path read requests. The number of logical read requests that have been made on keys in this constraint access path since the last IPL. This count reflects read requests issued regardless of whether a physical read request was actually performed. Rollback operations will affect this count.

Number of constraint physical-access-path read requests. Reserved.

Number of copy operations. The number of times that this member has been the target of a single-entry copy instruction since the last IPL.

Number of data space indexes returned. The number of data space indexes built over the physical file member. If the number of bytes provided is less than the number of bytes available, this number is the number of data space indexes returned.

Number of data space index keys. The number of key values in the data space index.

Number of data space index key fields. The maximum number of key fields defined in for any key in the data space index.

Number of days used. The number of days the member has been used. If the member does not have a last-used date, the value 0 is returned.

Number of deactivate operations. The number of times that a close operation has been performed over this member since the last IPL. Note that the difference between the number of activate operations and the number of deactivate operations will indicate the number of currently active open operations over this member.

Number of delayed maintenance keys. The number of access path entries that will be processed during delayed maintenance catch up time. If the access path is an encoded vector, the value 0 is returned.

Number of delete operations. The number of records deleted from this member since the last IPL. Delete operations performed on this member as a result of the cascade referential constraint rule will affect this count. Applying journal entries that result in delete operations will affect this count. Delete operations that occur during rollback will also affect this count.

Number of deleted records. The number of deleted records returned in the file member. Keyed logical files return a 0. DDM files that are not from a System/38 or System i platform return a 0. If the requested physical file member is suspended, the value 0 is returned.

Number of deleted records, if less than 2,147,483,647. The number of deleted records returned in the file member. Keyed logical files return a 0. DDM files that are not from a System/38 or System i platform return a 0. If the requested physical file member is suspended, the value -1 is returned. If the number of records is greater than or equal to 2,147,483,647, the value -2 is returned.

Number of distinct invalid indexes. The number of distinct invalid indexes built over this member. This includes the index created if the file is keyed, any indexes created for dependent keyed logical files, any indexes created for dependent join logical files, any indexes created for dependent SQL indexes, and any indexes created for unique or referential constraints on the file. Access paths that share an index are not included.

Number of distinct valid indexes. The number of distinct valid indexes built over this member. This includes the index created if the file is keyed, any indexes created for dependent keyed logical files, any indexes created for dependent join logical files, any indexes created for dependent SQL indexes, and any indexes created for unique or referential constraints on the file. Access paths that share an index are not included.

Number of insert operations. The number of records inserted into this member since the last IPL. This count does not reflect records added to a member on behalf of a single entry copy instruction. Applying journal entries that result in inserts will affect this count.

Number of logical-member access-path read requests. The number of logical read requests that have been made on keys in this member access path since the last IPL. This count reflects read requests issued regardless of whether a physical read request was actually performed. Rollback operations will affect this count.

Number of logical read requests. The number of logical read requests that have been made on entries in this member since the last IPL. This count reflects read requests issued requests regardless of whether a physical read request was actually performed. Rollback operations will affect this count.

Number of materialized query tables returned. The number of materialized query tables built over the file member. If the member is a physical file member, all materialized query tables built over the physical file member and all materialized query tables built over all logical file members that are dependent on the physical file member will be returned. If the member is a logical file member, only materialized query tables built directly over the logical file member are returned. If the number of bytes provided is less than the number of bytes available, this number is the number of materialized query tables returned.

Number of member level constraint information array entries. The number of entries in the member level constraint information array. The maximum number of entries is 300.

Number of overflow values. The number of unique key values that do not collate in sequential order in an encoded vector. If the access path is not an encoded vector, the value 0 is returned.

Number of physical-member access-path read requests. Reserved.

Number of physical read requests. The number of read requests that resulted in actual physical I/O requests on entries in this member since the last IPL. Logical read requests do not necessarily result in a physical read request. Rollback operations will affect this count.

Number of random access-path read requests. The estimated number of random read requests through this access path since the last IPL.

Number of random read requests. The estimated number of random read requests to the physical file member data since the last IPL.

Number of records rejected by group-by selection. The number of records that were rejected by the selection that is associated with group-by processing on the member.

Number of records rejected by key selection. The number of records that were rejected by key record selection in open operations that are associated with the member.

Number of records rejected by nonkey selection. The number of records that were rejected by the nonkey record selection in open operations that are associated with the member.

Number of rejected entries. The number of member entries rejected by retrieve operations since the last IPL.

Number of reorganize operations. The number of times that this member has been reorganized since the last IPL.

Number of reset operations. The number of times that this member has been cleared since the last IPL. Applying journal entries that result in clear operations will affect this count.

Number of sequential read requests. The estimated number of sequential read requests to the physical file member data since the last IPL.

Number of unique partial keys for key field 1. The number of unique key values considering only the first key field for keyed access paths. If the access path is an encoded vector, this number represents the number of full key distinct values. If this value is zero, then the unique key statistics are not available for this access paths. The number of unique key values are not available for access paths restored from previous releases, have keys which contain varying length character fields, or have multiple based on files.

Number of unique partial keys for key field 1 through 2. The number of unique key values from the first two key fields for keyed access paths. If this value is zero, then the unique key statistics are not available for this partial key. This number is not available for access paths restored from previous releases, containing only 1 key field, are encoded vector, have keys which contain varying length character fields, or have multiple based on files.

Number of unique partial keys for key field 1 through 3. The number of unique key values from the first three key fields for keyed access paths. If this value is zero, then the unique key statistics are not available for this partial key. This number is not available for access paths restored from previous releases, containing less than 3 key fields, are encoded vector, have keys which contain varying length character fields, or access paths with multiple based on files.

Number of unique partial keys for key field 1 through 4. The number of unique key values from the first four key fields for keyed access paths. If this value is zero, then the unique key statistics are not available for this partial key. This number is not available for access paths restored from previous releases, containing less than 4 key fields, are encoded vector, have keys which contain varying length character fields, or access paths with multiple based on files.

Number of update operations. The number of records updated in this member since the last IPL. Updates performed on the member as a result of the set null and set default referential constraint rules will affect this count. Applying journal entries that result in updates will affect this count. Update operations that occur during rollback will also affect this count.

Number of variable-length overflow rows. The estimated number of rows that contain data in the the variable length data storage of the data space.

ODP sharing. Whether the open data path (ODP) allows sharing with other programs in the same job. Possible values are:

Offset to additional MBRD0200 format information. The number of bytes from the start of the MBRD0200 format to the beginning of the additional MBRD0200 format information.

Offset to the data space index list. The number of bytes from the start of the MBRD0400 format to the beginning of the data space index list.

Offset to the materialized query table list. The number of bytes from the start of the MBRD0500 format to the beginning of the materialized query table list.

Offset to member level constraint information. The number of bytes from the start of the MBRD0200 format to the beginning of the first member level constraint information array.

Record capacity. The actual number of records this member can contain. The value is calculated by multiplying the increment number of records by the maximum number of increments, and adding the initial number of records. This field only applies to a physical file and is 0 for a logical file.

Record format and based-on file list. The number of physical file members this logical file member is based on. There is a maximum of 256 entries. A physical file only has one entry. See Record Format and Based-On File List Entry for a list of the fields contained in this list.

Record format selector library name. The library in which the record format selector program resides. This field is blank for physical files.

Record format selector program name. The name of a record format selector program that is called when the logical file member contains more than one logical record format.

The user-written selector program is called when a record is written to the database file and a record format name is not included in the high-level language (HLL) program. The selector program receives the record as input, determines the record format used, and returns it to the database. This field is blank for physical files.

Records to force a write. The number of inserted, updated, or deleted records that are processed before the records are forced into auxiliary storage. A 0 indicates that records are not forced into auxiliary storage.

Remote file. Whether the file is a remote file. Possible values are:

Reserved. An ignored field.

Reset date. The date the days-used count was last reset to 0. The reset date field is in the YYYYMMDD format. If the object has no reset date, the field is blank.

Restore date and time. The date and time that the member was last restored. The restore date and time field is in the CYYMMDDHHMMSS format, which is the same as for the change date and time field. The field contains blanks if the member was never restored. DDM files that are not from a System/38 or System i platform return blanks.

Restored with partial transaction state. The data for this physical-member is currently not usable, because it was restored from media that was created using save-while-active without waiting for transaction boundaries. Physical-member data that contains partial transactions cannot be used until either the Apply Journaled Changes (APYJRNCHG) or the Remove Journaled Changes (RMVJRNCHG) command is used to apply or remove the journal changes to the member to recover the partial transactions, or the Change Journaled Object (CHGJRNOBJ) command is used to allow the member containing partial transactions to be used. See the field, Journal receiver's name for transaction recovery, to get the name of the earliest journal receiver that will be needed to recover using the Apply Journaled Changes or Remove Journaled Changes command. The Change Journaled Object command should only be used as a last resort, since the changes in the journal receiver will not have been applied or removed completely and therefore the member will not be at a commit boundary.

Rollback ended state. The data for this physical-member is currently not usable, because a rollback that was being performed against the data for the member was ended. Physical-member data that is in a rollback ended state cannot be used until either the member is restored, or the Change Journaled Object (CHGJRNOBJ) command is used to allow the member containing partial transactions to be used. The Change Journaled Object command should only be used as a last resort, since the changes in the journal receiver will not have been rolled back completely and therefore the member will not be at a commit boundary.

Save date and time. The date and time that this member was last saved. The save date and time field is in the CYYMMDDHHMMSS format, which is the same as the change date and time field. This field contains blanks if it was never saved. DDM files that are not from a System/38 or System i platform return blanks.

Sort sequence table library name. The library in which the sort sequence table resides that was used to order the data space index keys. The field contains blanks if a sort sequence was not used to create the data space index.

Sort sequence table name. The sort sequence table that was used to order the data space index keys. The field contains blanks if a sort sequence was not used to create the data space index.

Sort sequence language ID. The language ID that was used to identify the sort sequence table that was used to order the data space index keys. The field contains blanks if a sort sequence was not used to create the data space index or if an alternate collating sequence was used to create the data space index.

Sort sequence weight. The sort sequence weight that was used to order the data space index keys. The field contains blanks if a sort sequence was not used to create the data space index or if an alternate collating sequence was used to create the data space index. Possible values are:

Source file. Whether the file is a source file. The possible values are:

Source type. The type of source member if this is a source file.

SQL file type. The kind of SQL file type the file is. The possible values are:

Use reset date. The century and date when the days-used count was last set to 0. This field is in the CYYMMDD format, which is the same as for the date last used field. If the date is not available, this field is blank.

Variable length data size. The number of pages (4096 bytes each) of variable length data in the data space.


Usage Notes

In multithreaded jobs, this API is not threadsafe and fails for DDM files of type *SNA.


Error Messages



API introduced: V1R3

[ Back to top | Database and File APIs | APIs by category ]