3. Manage an Application¶
An application combines database objects whose status is evaluated together, e.g. to trigger exports when all of them are loaded.
3.1. Add an Application¶
Use API_REDADM.ADD_APPLICATION to create a new application. The application name may only contain upper-case letters, digits, and underscores, and must start with a letter.
Besides an optional description, the parameter p_use_deps is useful if the application corresponds to a complete schema (e.g. an application mart) and p_app_name is identical with the schema name. In this case all objects that the views of this schema depend on are registered as application components implicitly, without an additional discover rule.
Example: Create the Application ‘TEST_APP’
1EXECUTE SCRIPT API_REDADM.ADD_APPLICATION(
2 'TEST_APP' -- p_app_name
3 ,'this is a test application' -- p_description
4 ,false -- p_use_deps
5);
The new application is stored in REDADM.RED_APPLICATIONS.
APP_NAME |
DESCRIPTION |
USE_DEPS |
|---|---|---|
TEST_APP |
this is a test application |
false |
3.2. Modify an Application¶
To modify an application, use API_REDADM.MODIFY_APPLICATION. NULL leaves a parameter unchanged, while a blank (’ ‘) restores its default value.
Example: Change the Description
1EXECUTE SCRIPT API_REDADM.MODIFY_APPLICATION(
2 'TEST_APP' -- p_app_name
3 ,'changing the description' -- p_description
4 ,null -- p_use_deps
5);
The entry in REDADM.RED_APPLICATIONS has changed:
APP_NAME |
DESCRIPTION |
USE_DEPS |
|---|---|---|
TEST_APP |
changing the description |
false |
3.3. Remove an Application¶
To remove an application, use API_REDADM.REMOVE_APPLICATION.
Example: Remove the Application ‘TEST_APP’
1EXECUTE SCRIPT API_REDADM.REMOVE_APPLICATION(
2 'TEST_APP' -- p_app_name
3);
The entry of the application ‘TEST_APP’ is removed from REDADM.RED_APPLICATIONS.