Object directory tables

The object directory tables contain information about objects. OAM keeps track of all objects in the storage hierarchy by recording the collection name identifier, the object name, and other pertinent information in the object directory tables. The object directory tables contain entries for locating and describing objects in the storage hierarchy. OSR creates a directory entry for each object when the object is stored. OSMC uses the directory table to determine which objects need to be processed during each management cycle for an Object storage group.

Table 1 shows the fields for an entry in an object directory table.

The object directory table has three indexes:

Index 1—Object Creation Time Stamp
Index 2—Collection Name Identifier, Pending Action Date, and Object Creation Time Stamp
Index 3—Object Name and Collection Name Identifier

Table 1. Object directory table
Column description	Column name	DB2 field type and data size	Indexes where used
Data Format Version	ODVER	CHAR (1)
Object Size	ODSIZE	INTEGER
Object Creation Time Stamp	ODCREATS	TIMESTAMP	Index 1, Index 2
Expiration Date	ODEXPDT	DATE
Last Referenced Date	ODLREFDT	DATE
Pending Action Date	ODPENDDT	DATE	Index 2
Management Class Assignment Date	ODMCASDT	DATE
Storage Class Identifier	ODSCNUM	SMALLINT
Management Class Identifier	ODMCNUM	SMALLINT
Large Object Support Flag	ODLOBFL	CHAR (1)
Object Location Flag	ODLOCFL	CHAR (1)
Object Active Volume Serial Number	ODLSLOC	CHAR (6)
Primary Copy Location Token	ODSECLOC	INTEGER
Object Backup Volume Serial Number	ODBKLOC	CHAR (6)
Backup Copy Location Token	ODBKSEC	INTEGER
Second Backup Copy Volume Serial Number	ODBK2LOC	CHAR (6)
Second Backup Copy Location Token	ODBK2SEC	INTEGER
Collection Name Identifier	ODCLID	INTEGER	Index 2, Index 3
Object Name	ODNAME	VARCHAR (44)	Index 3
Object Status Flags	ODSTATF	SMALLINT
Object Retention Date	ODRETDT	DATE
Instance ID	ODINSTID	INTEGER
Note: All columns are created with the NOT NULL attribute. All indexes are unique by concatenation of identified columns. All indexes are ordered in ascending value sequence. Index 1 is a cluster index. Maximum size of an object directory entry in bytes: 106.

Table 2 explains the column contents of an object directory table entry.

Table 2. Object directory table field contents
Column description	Column contents
Data Format Version	4
Object Size	Object size in bytes
Object Creation Time Stamp	Compressed form (DB2 format) (yyyy.mm.dd-hh:mm:ss.mmmmmm)
Expiration Date	Compressed form (DB2 format) 0001-01-01 Use MC expiration yyyy-mm-dd Explicit expiration date 9999-12-31 Never expire 0002–02–02 Awaiting a future event (event-based-retention)
Last Referenced Date	Compressed form (DB2 format) Set to 0001-01-01 upon creation
Pending Action Date	Compressed form (DB2 format)
Management Class Assignment Date	Compressed form (DB2 format) Set to creation date on creation; otherwise, last date MC changed
Storage Class Identifier	Number identifying this storage class (associated with storage class name by the Storage Class Identifier Table)
Management Class Identifier	Number identifying this management class (associated with management class name by the Management Class Identifier Table)
Large Object Support Flag	Indicates whether this object resides in a LOB tablespace. Valid values are: L—object currently resides in a LOB storage structure. Blank—object does not currently reside in a LOB storage structure.
Object Location Flag	Blank—Optical copy; D—DASD copy; E—File system DSL2: R—Recalled state; T—Tape SUBLEVEL 1 copy; U—Tape SUBLEVEL 2 copy; 2—Recalled to DSL2 :
Object Active Volume Serial Number	Standard MVS volume serial number (or blanks)
Primary Copy Location Token	If optical volume: Token for relative sector location (or zeros) of VTOC entry. If tape volume: Tape blockid
Object Backup Volume Serial Number	Standard MVS volume serial number (or blanks)
Backup Copy Location Token	If optical volume: Token for relative sector location (or zeros) of VTOC entry. If tape volume: Tape blockid.
Second Backup Copy Volume Serial Number	Volume serial number for the optical or tape volume that contains the second backup copy of the object in the corresponding row in the table
Second Backup Copy Location Token	The optical volume sector location or the tape volume block ID on the volume in the ODBK2LOC field where the second backup copy of the object in the corresponding row in the table resides
Collection Name Identifier	Number identifying the collection name (associated with collection name by the Collection Name Identifier Table)
Object Name	Standard MVS data set name
Object Status Flags	ODSTATF contains the object status flags. See Table 3 valid values for ODSTATF and how they map to status flags.
Object Retention Date	ODRETDT contains the latest expiration date derived for a retention-protected object. The retention-protected object cannot be deleted prior to the date specified in this column. For objects that are not retention-protected, ODRETDT is not used and contains 0001–01–01.
Instance ID	Unique object instance ID.

The following table shows valid values for ODSTATF and how they map to status flags.

Table 3. Valid values for ODSTATF
ODSTATF Value	ODSTATF_EBR	ODSTATF_DELHOLD	ODSTATF_RETPROT
0	OFF	OFF	OFF
1	OFF	OFF	ON
2	OFF	ON	OFF
3	OFF	ON	ON
4	ON	OFF	OFF
5	ON	OFF	ON
6	ON	ON	OFF
7	ON	ON	ON