IDSSCatalog Interface Reference

Inherited by IDSSCatalog2.

List of all members.

---

Detailed Description

IDSSDbCatalog interface offers warehouse database catalog information (tables, columns and their types, etc) as a ground for defining other schema level objects.

This is the type specific interface offered by the warehouse catalog object. The warehouse catalog object serves the following purposes:

• Stores output from the Warehouse Catalog Engine, which retrieves table and column information for the warehouse. The DSS project builder uses the WHTables collection to access results from the Engine.
• Allows the designer to persist a selection of warehouse tables (the Tables collection) and columns to be used for schema design and be able to reload them in a future session without having to connect to the warehouse again.

  The warehouse catalog object is a first class object that can be persisted in the metadata. One project is allowed to contain multiple warehouse catalog objects.

Public Member Functions
HRESULT	Columns ([out, retval] IDSSColumns ppColumns)
	All the columns that are contained in tables in Tables collection.
HRESULT	Definition (IDSSCatalogDefn *pDefinition)
	The Catalog Definition object associated with this catalog.
HRESULT	Definition ([out, retval] IDSSCatalogDefn ppDefinition)
	The Catalog Definition object associated with this catalog.
HRESULT	Info ([out, retval] IDSSObjectInfo ppInfo)
	Shortcut to the IDSSObjectInfo interface to this object.
HRESULT	Tables ([out, retval] IDSSDBTables ppTables)
	A persisted collection of tables that are intended for use to build schema objects.
HRESULT	TableSources ([out, retval] IDSSTableSources ppTableSources)
	A collection of table source objects used by tables in this catalog.
HRESULT	Warehouse ([in] IDSSDBRole *pWarehouse)
	This property defines the logical database of the Warehouse.
HRESULT	Warehouse ([out, retval] IDSSDBRole ppWarehouse)
	This property defines the logical database of the Warehouse.
HRESULT	WHTables ([out, retval] IDSSDBTables ppTables)
	A collection of all the available warehouse tables returned from the Warehouse Catalog Engine.

---

Member Function Documentation

HRESULT IDSSCatalog::Columns (  [out, retval] IDSSColumns   ppColumns  )

All the columns that are contained in tables in Tables collection. This is a collection of the columns that belong to the tables in the Tables collection. The caller can freely add to or delete from this collection. Also, adding a table to the Tables collection will cause all the columns in the table to be automatically added to Columns. Returns: Usual COM result code: S_OK

HRESULT IDSSCatalog::Definition (  IDSSCatalogDefn *  pDefinition  )

The Catalog Definition object associated with this catalog. The Catalog Definition object (see IDSSCatalogDefn) associated with this Catalog object. The Catalog Definition object defines where and how the catalog information is retrieved. Returns: Usual COM result code: S_OK

HRESULT IDSSCatalog::Definition (  [out, retval] IDSSCatalogDefn   ppDefinition  )

The Catalog Definition object associated with this catalog. The Catalog Definition object (see IDSSCatalogDefn) associated with this Catalog object. The Catalog Definition object defines where and how the catalog information is retrieved. Returns: Usual COM result code: S_OK

HRESULT IDSSCatalog::Info (  [out, retval] IDSSObjectInfo   ppInfo  )

Shortcut to the IDSSObjectInfo interface to this object. Returns: Usual COM result code: S_OK

HRESULT IDSSCatalog::Tables (  [out, retval] IDSSDBTables   ppTables  )

A persisted collection of tables that are intended for use to build schema objects. Tables is a persisted collection of warehouse tables. The caller uses this collection to store selected tables from the WHTables collection. Note: Updating DbCatalg by calling the Warehouse Catalog Engine do not change the number of tables in this collection. However, it may change the state and definition of some of the objects in the collection. See Update for detailed discussion. Returns: Usual COM result code: S_OK

HRESULT IDSSCatalog::TableSources (  [out, retval] IDSSTableSources   ppTableSources  )

A collection of table source objects used by tables in this catalog. TableSources is a collection of table source objects used by DB tables in the catalog. A table source object defines the prefix and suffix information about a DB table. Returns: Usual COM result code: S_OK

HRESULT IDSSCatalog::Warehouse (  [in] IDSSDBRole *  pWarehouse  )

This property defines the logical database of the Warehouse. Returns: Usual COM result code: S_OK

HRESULT IDSSCatalog::Warehouse (  [out, retval] IDSSDBRole   ppWarehouse  )

This property defines the logical database of the Warehouse. Returns: Usual COM result code: S_OK

HRESULT IDSSCatalog::WHTables (  [out, retval] IDSSDBTables   ppTables  )

A collection of all the available warehouse tables returned from the Warehouse Catalog Engine. WHTables is a collection of IDSSDbTable interface. It contains all the database tables in the warehouse that the Warehouse Catalog Engine returned. This collection is NOT persisted in the metadata. Before reading from this collection, the caller must explicitly call the Warehouse Catalog Engine to populate it. Returns: Usual COM result code: S_OK

---