Metadata API Class _GET_METADATA_ 27 )[5] COLUMNS=( ( ID=’A000000E.WHCOLDTL.A0000032’ NAME=’PRODNUM’ DESC=’product number’ )[9] ( ID=’A000000E.WHCOLDTL.A0000034’ NAME=’PRODNAME’ DESC=’product name’ )[11] ( ID=’A000000E.WHCOLDTL.A0000036’ NAME=’PRODID’ DESC=’product id/abbreviation’ )[13] ( ID=’A000000E.WHCOLTIM.A00000FU’ NAME=’_LOADTM’ DESC=’DateTime Stamp of when row was loaded’ )[15] )[7] TABLE NAME=’PRODUCT’ )[3] Example 2: Return Information about One Column l_cols=getniteml(l_meta,’COLUMNS’); l_col=getiteml(l_cols,4); /* * Get all information about column * (note get_all=1 parameter) */ call send(i_api,’_GET_METADATA_’,l_rc,l_col,1); /* returns list: */ L_COL=( ID=’A000000E.WHCOLTIM.A00000FU’ DESC=’DateTime Stamp of when row was loaded’ NOTE=()[4083] INDEXES=()[4085] INPUT OBJECTS=()[4087] OUTPUT OBJECTS=()[4089] EXTENDED ATTRIBUTES=()[4096] TABLE=( ID=’A000000E.WHDETAIL.A000002X’ NAME=’Product detail table’ DESC=’Contains information about all products’ )[4091] FORMAT=’DATETIME.’ INFORMAT=’DATETIME.’ INPUT SOURCES=()[4093] LENGTH=8 OUTPUT TARGETS=()[4095] TYPE=’N’ CVALUE=’’ 28 _GET_METADATA_OBJECTS_ Chapter 2 METADATA CREATED=’ 04MAR1997:15:29:29’ METADATA UPDATED=’ 04MAR1997:15:29:29’ NAME=’_LOADTM’ NVALUE=. )[3719] _GET_METADATA_OBJECTS_ Lists metadata objects when it is passed repository and type Category: Navigation Method Syntax CALL SEND(i_api, ’_GET_METADATA_OBJECTS_’, l_rc, reposid.typeid, l_objs, <search_secondary>, <include_subtypes>); Parameters Parameter Type Description i_api Class specifies the passed instance of METAAPI.CLASS. See “Using the Metadata API Class” on page 14. l_rc N specifies the return codes for the method. A nonzero code indicates failure and means that l_rc is an error list identifier. For the error list format, see “Error Codes” on page 14. reposid.typeid C specifies the passed reposid and typeid of metadata that is to be returned. For the general format of these IDs, see “Identifying Metadata” on page 7. l_objs L spcifies the returned list of metadata objects. List format: id=name. search_ secondary N specifies the passed indicator. Optional. Specifies whether the returned list should include any objects of the specified type from all active secondary repositories. include_subtypes N specifies the passed indicator. Optional. Specifies whether the returned list should include subtypes. Details search_secondary specifies the passed indicator. Optional. Specifies whether the returned list should include any objects of the specified type from all active secondary repositories. 0 — return objects from the passed repository only. Metadata API Class _GET_METADATA_OBJECTS_ 29 1 — (default) if passed repository ID is that of the primary repository, then return all from the secondary repository, too. If passed repository ID is that of a secondary repository, this parameter is ignored. include_subtypes specifies the passed indicator. Optional. Specifies whether the returned list should include subtypes. 0 — return objects of the specified type only. 1 — (default) return objects of the specified type and their subtypes, if any. Examples Example 1: Returning a List of Entries for a Specific Type (Detail Tables) type=dw_repos_id||’.WHDETAIL’; call send(i_api,’_GET_METADATA_OBJECTS_’,l_rc, type,l_objs); /* returns list: */ L_objs( A000000E.WHDETAIL.A000001L=’Customer detail table’ A000000E.WHDETAIL.A000002X=’Product detail table’ A000000E.WHDETAIL.A000003M=’Customer detail table’ A000000E.WHDETAIL.A000004H=’Sales fact table’ A000000E.WHDETAIL.A000005U=’Oracle’ A000000E.WHDETAIL.A000006Q=’Sybase’ A000000E.WHDETAIL.A000007L=’Remote Detail Table’ A000000E.WHDETAIL.A000008I=’Suppliers’ )[3] Example 2: Get All Tables Registered in Primary and Secondary Repositories /* * Get all Tables registered in Primary and * Secondary repositories * Primary Repos ID = A0000001 * Secondary Repos ID = A0000003 */ type=primary_repos_id||’.WHTABLE’; l_objs=makelist(); call send(i_api, ’_GET_METADATA_OBJECTS_’, l_rc, type, 1, 1); num_objs=listlen(l_objs); if l_rc = 0 then do; 30 _GET_SUBTYPES_ Chapter 2 call putlist(l_objs); end; /* if */ else do; msg=getnitemc(l_rc,’MSG’,1,1,’ERROR: _GET_METADATA_OBJECTS_ Failed.’); list_rc=dellist(l_rc); end; /* else */ l_objs=dellist(l_objs); /* returns list */ L_OBJS( A0000003.WHDETAIL.A0000069=’Product detail table’ A0000003.WHDETAIL.A00000QI=’Sales fact table’ A0000003.WHLDETL.A000004R=’Customer detail’ A0000003.WHSUMTBL.A00000TG=’Monthly summary’ A0000001.WHODDTBL.A0000049=’Services’ A0000001.WHODDTBL.A00000FP=’Payment File’ ) _GET_SUBTYPES_ Returns all possible subtypes for a specified metadata type Category: Management Methods Syntax CALL SEND(i_api, ’_GET_SUBTYPES_’, l_rc, type_id, l_types,<expand>); Metadata API Class _GET_SUBTYPES_ 31 Parameters Parameter Type Description i_api Class specifies the passed instance of METAAPI.CLASS. See “Using the Metadata API Class” on page 14. l_rc N specifies the return codes for the method. A nonzero code indicates failure and means that l_rc is an error list identifier. For the error list format, see “Error Codes” on page 14. type_id C specifies the passed type ID of metadata to be returned. For the general format of this ID, see “Identifying Metadata” on page 7. l_types L specifies the returned list of all possible subtypes for the specified type. List format: type_id=type_name. expand N specifies the passed indicator. Optional. Specifies whether returned list will expand all possible subtypes of all subtype branches. Details expand specifies the passed indicator. Optional. Specifies whether returned list will expand all possible subtypes of all subtype branches. 0 — (default) return all subtypes unexpanded. 1 — expand all possible subtypes of all subtype branches. Examples Example 1: Get Subtypes—Unexpanded /* * Get all Immediate Subtypes of Tables */ l_types=makelist(); call send(i_api,’_GET_SUBTYPES_’,l_rc,’WHTABLE’,l_types,0); num_types=listlen(l_types); if l_rc = 0 then do; call putlist(l_types); end; /* if */ else do; msg=getnitemc(l_rc,’MSG’,1,1,’ERROR: _GET_SUBTYPES_ Failed.’); list_rc=dellist(l_rc); end; /* else */ . TARGETS=()[4095] TYPE=’N’ CVALUE=’’ 28 _GET _METADATA_ OBJECTS_ Chapter 2 METADATA CREATED=’ 04MAR1997:15 :29 :29 ’ METADATA UPDATED=’ 04MAR1997:15 :29 :29 ’ NAME=’_LOADTM’ NVALUE=. ) [37 19] _GET _METADATA_ OBJECTS_ Lists metadata. Metadata API Class _GET _METADATA_ 27 )[5] COLUMNS=( ( ID=’A000000E.WHCOLDTL.A00000 32 NAME=’PRODNUM’ DESC=’product number’ )[9] ( ID=’A000000E.WHCOLDTL.A0000 034 ’ NAME=’PRODNAME’ DESC=’product. returns list */ L_OBJS( A00000 03. WHDETAIL.A0000069=’Product detail table’ A00000 03. WHDETAIL.A00000QI=’Sales fact table’ A00000 03. WHLDETL.A000004R=’Customer detail’ A00000 03. WHSUMTBL.A00000TG=’Monthly