Summary of DBMS_AW Subprograms

Needs example for advise_partitioning_level. All procedures and functions that should be documented for 10.2.0.3 were documented for that release.

The following table describes the subprograms provided in DBMS_AW.

Table B-1 DBMS_AW Subprograms

Subprogram	Description
ADD_DIMENSION_SOURCE Procedure	Populates a table type named `DBMS_AW$_DIMENSION_SOURCES_T` with information provided in its parameters about the dimensions of the cube.
ADVISE_CUBE Procedure	Suggests how to preaggregate a cube, based on a specified percentage of the cube's data.
ADVISE_DIMENSIONALITY Function	Returns a recommended composite definition for the cube and a recommended dimension order.
ADVISE_DIMENSIONALITY Procedure	Generates the OLAP DML commands for defining the recommended composite and measures in a cube.
ADVISE_PARTITIONING_DIMENSION Function	Identifies the dimension that the Sparsity Advisor partitioned over.
ADVISE_PARTITIONING_LEVEL Function	Returns the level used by the Sparsity Advisor for partitioning over a dimension.
ADVISE_REL Procedure	Suggests how to preaggregate a dimension, based on a specified percentage of the dimension's members.
ADVISE_SPARSITY Procedure	Analyzes a fact table for sparsity and populates a table with the results of its analysis.
AW_ATTACH Procedure	Attaches an analytic workspace to a session.
AW_COPY Procedure	Creates a new analytic workspace and populates it with the object definitions and data from another analytic workspace.
AW_CREATE Procedure	Creates a new, empty analytic workspace.
AW_DELETE Procedure	Deletes an analytic workspace
AW_DETACH Procedure	Detaches an analytic workspace from a session.
AW_RENAME Procedure	Changes the name of an analytic workspace.
AW_TABLESPACE Function	Returns the name of the tablespace in which a particular analytic workspace is stored.
AW_UPDATE Procedure	Saves changes made to an analytic workspace.
CONVERT Procedure	Converts an analytic workspace from 9i to 10g storage format.
EVAL_NUMBER Function	Returns the result of a numeric expression in an analytic workspace.
EVAL_TEXT Function	Returns the result of a text expression in an analytic workspace.
EXECUTE Procedure	Executes one or more OLAP DML commands. Input and output is limited to 4K. Typically used in an interactive session using an analytic workspace.
GETLOG Function	Returns the session log from the last execution of the `INTERP` or `INTERPCLOB` functions.
INFILE Procedure	Executes the OLAP DML commands specified in a file.
INTERP Function	Executes one or more OLAP DML commands. Input is limited to 4K and output to 4G. Typically used in applications when the 4K limit on output for the `EXECUTE` procedure is too restrictive.
INTERPCLOB Function	Executes one or more OLAP DML commands. Input and output are limited to 4G. Typically used in applications when the 4K input limit of the `INTERP` function is too restrictive.
INTERP_SILENT Procedure	Executes one or more OLAP DML commands and suppresses the output. Input is limited to 4K and output to 4G.
OLAP_ON Function	Returns a boolean indicating whether or not the OLAP option is installed in the database.
OLAP_RUNNING Function	Returns a boolean indicating whether or not the OLAP option has been initialized in the current session.
PRINTLOG Procedure	Prints a session log returned by the `INTERP`, `INTERCLOB`, or `GETLOG` functions.
RUN Procedure	Executes one or more OLAP DML commands.
SHUTDOWN Procedure	Shuts down the current OLAP session.
SPARSITY_ADVICE_TABLE Procedure	Creates a table which the `ADVISE_SPARSITY` procedure will use to store the results of its analysis.
STARTUP Procedure	Starts an OLAP session without attaching a user-defined analytic workspace.