SAS/Warehouse Administrator ® 2.3 Metadata API Reference Second Edition The correct bibliographic citation for this manual is as follows: SAS Institute Inc. 2004. SAS/Warehouse Administrator ® 2.3 Metadata API Reference, Second Edition. Cary, NC: SAS Institute Inc. SAS/Warehouse Administrator ® 2.3 Metadata API Reference, Second Edition Copyright © 2004, SAS Institute Inc., Cary, NC, USA ISBN 1-59047-222-5 All rights reserved. Produced in the United States of America. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, or otherwise, without the prior written permission of the publisher, SAS Institute Inc. U.S. Government Restricted Rights Notice. Use, duplication, or disclosure of this software and related documentation by the U.S. government is subject to the Agreement with SAS Institute and the restrictions set forth in FAR 52.227–19 Commercial Computer Software-Restricted Rights (June 1987). SAS Institute Inc., SAS Campus Drive, Cary, North Carolina 27513. 1st printing, January 2004 SAS Publishing provides a complete selection of books and electronic products to help customers use SAS software to its fullest potential. For more information about our e-books, e-learning products, CDs, and hard-copy books, visit the SAS Publishing Web site at support.sas.com/pubs or call 1-800-727-3228. SAS ® and all other SAS Institute Inc. product or service names are registered trademarks or trademarks of SAS Institute Inc. in the USA and other countries. ® indicates USA registration. Other brand and product names are registered trademarks or trademarks of their respective companies. Contents Chapter 1 Introduction to the Metadata API 1 Changes and Enhancements 1 Prerequisites 4 What is Metadata? 4 What is the SAS/Warehouse Administrator Metadata API? 5 What Can I Do with the SAS/Warehouse Administrator Metadata API? 5 How the Metadata API Works 5 Identifying Metadata 7 Reading Metadata: A Simple Example 8 Metadata Repositories 10 Learning to Use the Metadata API 12 Naming Conventions Used in This Manual 12 Where Metadata API Classes and SLISTS are Stored 12 Chapter 2 Metadata API Class 13 Overview of the Metadata API Class 13 Using the Metadata API Class 14 Introduction to Metadata API Methods 14 Index to Metadata API Methods 16 Chapter 3 SAS/Warehouse Administrator Metadata Types 51 Overview of SAS/Warehouse Administrator Metadata Types 51 Metadata Type Inheritance 52 Using Metadata Types 53 Index to SAS/Warehouse Administrator Metadata Types 70 Using the Metadata Type Dictionary 73 Appendix 1 Sample Metadata API Code 273 Appendix Overview 273 Read Metadata Code Sample 273 Write Metadata Code Sample 277 Appendix 2 Metadata Type Inheritance Tree 281 SAS/Warehouse Administrator Metadata Type Inheritance Tree 281 Appendix 3 Recommended Reading 285 Recommended Reading 285 Glossary 287 Index 295 iv 1 CHAPTER 1 Introduction to the Metadata API Changes and Enhancements 1 Prerequisites 4 What is Metadata? 4 What is the SAS/Warehouse Administrator Metadata API? 5 What Can I Do with the SAS/Warehouse Administrator Metadata API? 5 How the Metadata API Works 5 Identifying Metadata 7 Reading Metadata: A Simple Example 8 Metadata Repositories 10 Setting the Active Metadata Repository 11 Learning to Use the Metadata API 12 Naming Conventions Used in This Manual 12 Where Metadata API Classes and SLISTS are Stored 12 Changes and Enhancements This section describes changes to the SAS/Warehouse Administrator metadata API after Release 2.0. You can add and update the PATH property for the WHEFILE type. You can now use the metadata API to add, update, and delete process objects. For example, you can write a metadata API program that creates a data store and also creates all of the processes that are required to extract, transform, and load information into that data store. The following metadata types have been updated to support this feature: WHCOLUMN WHCOLDTL WHCOLDAT WHCOLODD WHCOLOLP WHCOLTIM WHCTRNFM WHEFILE WHEXTATR WHINDEX WHOLAP WOLPDIM . Types 70 Using the Metadata Type Dictionary 73 Appendix 1 Sample Metadata API Code 27 3 Appendix Overview 27 3 Read Metadata Code Sample 27 3 Write Metadata Code Sample 27 7 Appendix 2 Metadata Type Inheritance. SAS/Warehouse Administrator Metadata Types 51 Overview of SAS/Warehouse Administrator Metadata Types 51 Metadata Type Inheritance 52 Using Metadata Types 53 Index to SAS/Warehouse Administrator Metadata. Stored 12 Chapter 2 Metadata API Class 13 Overview of the Metadata API Class 13 Using the Metadata API Class 14 Introduction to Metadata API Methods 14 Index to Metadata API Methods 16 Chapter 3 SAS/Warehouse