This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


persistent class %Library.PackageDefinition extends %Library.AbstractDefinition

SQL Table Name: %Library.PackageDefinition

This class represents a specific package description contained within the Caché Dictionary.

Property Inventory

Method Inventory


property ClientName as %CacheString;
A string containing the client name of the package.
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
property Description as %CacheString;
A string containing the description of the package.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property GlobalPrefix as %CacheString;
A string containing the global prefix of the package, used for data, id, and index locations.
Property methods: GlobalPrefixGet(), GlobalPrefixIsValid(), GlobalPrefixSet()
property Name as %CacheString;
A string containing the name of the package.
Property methods: NameGet(), NameIsValid(), NameSet()
property OwnerName as %CacheString;
A string containing the Owner's name of the package.
Property methods: OwnerNameGet(), OwnerNameIsValid(), OwnerNameSet()
property RtnPrefix as %CacheString;
A string containing the routine prefix of the package.
Property methods: RtnPrefixGet(), RtnPrefixIsValid(), RtnPrefixSet()
property SQLName as %CacheString;
A string containing the SQL name of the package.
Property methods: SQLNameGet(), SQLNameIsValid(), SQLNameSet()
property list as %ListOfDataTypes [ Transient ];
Property methods: listGet(), listGetObject(), listGetObjectId(), listGetSwizzled(), listIsEmpty(), listIsValid(), listNewObject(), listSet(), listSetObject(), listSetObjectId(), listUnSwizzle()


method GetPackageList() as %ListOfDataTypes
classmethod SubPackageClose(QHandle As %Binary) as %Status
classmethod SubPackageExecute(ByRef QHandle As %Binary, SuperPackage As %String) as %Status
classmethod SubPackageFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
Fetch returns the next row in the query.
classmethod SubPackageFetchRows(ByRef QHandle As %Binary, FetchCount As %Integer = 0, ByRef RowSet As %List, ByRef ReturnCount As %Integer, ByRef AtEnd As %Integer) as %Status
RoutineListFetchRows returns the next FetchCount rows in the query.


query SubPackage()
Selects Name
The SumPackage query provides a list of sub-package names. This query works in a hierarchical way, it returns only one level of sub-package under a specified SuperPackage name.


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (%Library.AbstractDefinition)