Skip Headers
Oracle® OLAP DML Reference
11g Release 2 (11.2)

Part Number E17122-05
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

AW function

The AW function returns information about currently attached workspaces.

Return Value

The return value depends on the keyword you specify, as described in Table 7-2, "Keywords for AW Function".

Syntax

AW(keyword [workspace])

Parameters

keyword

Indicates the specific information you want. The keywords that you can use with the AW function are listed in Table 7-2, "Keywords for AW Function" with the data type of the value they return and the meaning of the information.

Table 7-2 Keywords for AW Function

Keyword Data Type Information Returned

ACQUIRED

TEXT

When an analytic workspace is attached in multiwriter mode, returns the names of any acquired variables, relations, valuesets, dimension names, or partitions, in the analytic workspace

AGGMAP

TEXT

A list of all aggmap objects in the workspace. When there are several, Oracle OLAP returns a multiline text value with each object name on a separate line.

ALIASLIST

TEXT

A list of currently assigned aliases for the workspace. When there are several, Oracle OLAP returns a multiline text value with each alias on a separate line.

ATTACHED

BOOLEAN

Indicates whether the specified workspace is attached. The workspace argument is required.

CHANGED

BOOLEAN

When you have read/write access to the workspace, indicates whether you have made changes since the last time the workspace was updated. When you have read-only access to the workspace, indicates whether another user has updated the workspace and committed the changes since you attached it.

COMPOSITE

TEXT

A list of all named composite objects in the specified workspace.

DATE

DATE

The date of your most recent update in the current session. When you have not updated in the current session, it returns the date of the most recent commit before you attached the workspace. When you have attached a shared workspace as read-only, DATE does not take into account any updates or commits that have occurred since you attached the workspace.

DIMENSION

TEXT

A list of all the dimensions defined in the workspace. When there are several dimensions, Oracle OLAP returns a multiline text value with each dimension name on a separate line.

EXISTS

BOOLEAN

Indicates whether the specified analytic workspace has been defined in the Oracle Database.

FORMULA

TEXT

A list of all the formulas defined in the workspace. When there are several formulas, Oracle OLAP returns a multiline text value with each formula name on a separate line.

FROZEN

Boolean

TRUE if the specified analytic workspace is currently frozen, or FALSE if it is not.

FULLNAME

TEXT

The full name of the specified workspace. The full name includes the schema that contains the workspace.

ISUPDATED

TEXT

When the specified analytic workspace is not attached in multiwriter mode, returns TRUE when the workspace is updated but not committed. When he specified analytic workspace is attached in multiwriter mode, returns TRUE when at least one variable or dimension belonging to the workspace is updated but not committed.

LIST

TEXT

A list of all currently attached workspaces. Each line of the multiline text value contains the name of an analytic workspace.

LISTNAMES

TEXT

A list of all the objects defined in the workspace. Each line of the multiline text value contains the name of an analytic workspace object.

MODEL

TEXT

A list of all the models defined in the workspace. When there are several models, Oracle OLAP returns a multiline text value with each model name on a separate line.

MULTI

TEXT

Indicates if you have multi-writer access to the analytic workspace.

NAME

TEXT

The name of the current workspace.

OPTION

TEXT

A list of all the Oracle OLAP options defined in the EXPRESS workspace. When the workspace is not EXPRESS, AW(OPTION) returns NA, because options are defined only in the EXPRESS workspace. For the EXPRESS workspace, AW(OPTION) returns a multiline text value with each option name on a separate line.

PAGESIZE

INTEGER

The size of the page, in bytes.

PROGRAM

TEXT

A list of all the programs defined in the workspace. When there are several programs, Oracle OLAP returns a multiline text value with each program name on a separate line.

READERS

INTEGER

The total number of current users of the Database who have read-only access.

RELATION

TEXT

A list of all the relations defined in the workspace. When there are several relations, Oracle OLAP returns a multiline text value with each relation name on a separate line

RO

TEXT

Indicates whether you have read-only access to the workspace.

RW

TEXT

Indicates whether you have read/write access to the workspace.

SEGMENTSIZE

DECIMAL

The current maximum segment size for the workspace. It is the most recent value specified using an AW SEGMENTSIZE statement.

SHARED

BOOLEAN

Indicates whether the workspace is being shared by other users.

TIME

ID

The time of your most recent update in the current session. When you have not updated in the current session, it returns the time of the most recent commit before you attached the workspace. When you have attached a shared workspace as read-only, TIME does not take into account any updates or commits that have occurred since you attached the workspace.

VALUSET

TEXT

A list of all the valuesets that are defined in the workspace. When there are several valuesets, Oracle OLAP returns a multiline text value with each valueset name on a separate line.

VARIABLE

TEXT

A list of all the variables defined in the workspace. When there are several variables, Oracle OLAP returns a multiline text value with each variable name on a separate line.

WORKSHEET

TEXT

A list of all the worksheet objects defined in the workspace. When there are several worksheets, Oracle OLAP returns a multiline text value with each worksheet name on a separate line. This keyword is not available in the Oracle10i release and later.

WRITERS

INTEGER

The number of current users of the Database who have write access.


workspace

A text expression that indicates the name of the workspace for which you want information. When you do not specify this argument, the AW function ordinarily returns information about the current workspace. The ATTACHED, LIST, and NAME keywords are exceptions to this rule.

Usage Notes

Analytic Workspace Status Information

You can use the SHARED, CHANGED, RO, and RW keywords to get information about the current status of a shared workspace. You can check if SHARED, RO, and CHANGED are TRUE to find out if another user has updated an analytic workspace since you attached it.

Examples

Example 7-26 Ascertaining the Active Workspace

The following program line checks which workspace is currently active so the program can choose the appropriate data to report. With this method, you can use the same report program in several workspaces, each containing different data.

REPORT IF AW(NAME) EQ 'mysales' THEN mysales ELSE gensales