SAS/Warehouse Administrator Metadata Types

WHLIBRY

Metadata type for SAS libraries

Category:

SAS Library Types

Parent
Overview
Properties
Using WHLIBRY

Parent

WHROOT

Overview

WHLIBRY is the metadata type for SAS libraries in SAS/Warehouse Administrator. A SAS library definition is a metadata record for a SAS library that contains data, views, source code, or other information that is used in the current Warehouse environment.

Properties

The following table lists all of the properties for WHLIBRY and indicates how you can use each property with metadata API methods.

In the table, you can pass properties with a Yes in the Add column to the _ADD_METADATA_ method. Use this method to add a new object.

You can pass properties with a Yes in the Update column to the _UPDATE_METADATA_ method. Use this method to update properties of an existing object.

* Req indicates that the property is required; you must provide a value for this property when you use a given method. * Default indicates that the system will provide a default value for that property if you do not provide one.

Properties with a Yes in the Read Method Expand Parm column are valid with the expand parameter of the _GET_METADATA_ method. This method enables you to get detailed metadata about a property and its associated objects through a single method call.

Properties	Type	Add Method	Update Method	Read Method Expand Parm.
Cvalue	C	Yes	Yes	No
Database	L	Yes	Yes	No
DBMS Libname	N	Yes	Yes	No
Desc	C	Yes	Yes	No
Engine	C	Yes	Yes	No
Extended Attributes	L	Yes	Yes	Yes
Icon	C	Yes	Yes	No
Id	C	* Req	* Req	No
Libref	C	* Req	Yes	No
Metadata Created	C	No	No	No
Metadata Updated	C	No	No	No
Name	C	* Default	Yes	No
Note	L	Yes	Yes	Yes
NValue	N	Yes	Yes	No
Options	L	Yes	Yes	No
Path	L	Yes	Yes	No
Preassigned	N	Yes	Yes	No
Tables	L	No	No	No

New properties for WHLIBRY are as follows:

DATABASE

specifies an SCL list of general identifying information about the Database Connection profile that is used by this library to access the DBMS.

DBMS LIBNAME

indicates a flag that is set to 0 (No) or 1 (Yes) to specify whether the library is a DBMS connection library.

ENGINE

indicates the SAS libname engine specification for this repository.

ICON

specifies the catalog entry name of the associated icon. For more information about icons, see Using Icon Information.

LIBREF

specifies the libref to assign to the metadata repository.

OPTIONS

specifies an SCL list of libname statement options. For a DBMS connection library, the list includes SQL options, USERID, PASSWORD, and other options that are required for the connection.

This property contains the registered user ID or password only if the API application is a secure application. The only secure applications that are currently supported are those registered as add-in generators. See the SAS/Warehouse Administrator User's Guide for documentation on add-in generators. If the API application is not secure, this property returns a blank value if no password has been registered, and it returns XXXXXXXX if the password has been registered.

PATH

specifies an SCL list of host-specific path designations. If the list contains more than one entry, then it is assumed that the libname is a concatenated libname and that each list entry is a directory in the concatenation.

PREASSIGNED

specifies the numeric indicator that states whether this libname is preassigned. It has a possible value of 0 (needs to be assigned) or 1 (is already assigned).

TABLES

specifies an SCL list of general identifying information about the tables that are registered as residing in this library.

Using WHLIBRY

Add	Update	Delete
Yes	Yes	Yes

WHLIBRY is an independent type. To understand how it relates to other types, see the physical storage models in Relationships Among Metadata Types.

Top of Page