Oracle® Database PL/SQL Packages and Types Reference 10g Release 2 (10.2) Part Number B14258-01 |
|
|
View PDF |
DBMS_ADVISOR
is part of the Server Manageability suite of Advisors, a set of expert systems that identifies and helps resolve performance problems relating to the various database server components.
See Also:
Oracle Database Administrator's Guide for information regarding the Segment Advisor
Oracle Database Performance Tuning Guide for information regarding the SQL Tuning Advisor and SQL Access Advisor
Oracle Database 2 Day DBA and Oracle Database Administrator's Guide for information regarding the Undo Advisor
This chapter contains the following topics:
Security Model
This section contains topics which relate to using the DBMS_ADVISOR
package.
Security on this package can be controlled by granting EXECUTE
on this package to selected users or roles. You might want to write a cover package on top of this one that restricts the alert names used. EXECUTE
privilege on this cover package can then be granted rather than on this package. In addition, there is an ADVISOR
privilege, which is required by DBMS_ADVISOR
procedures.
Table 12-1 DBMS_ADVISOR Package Subprograms
Subprogram | Description | Used in |
---|---|---|
ADD_SQLWKLD_REF Procedure |
Adds a workload reference to an Advisor task | SQL Access Advisor only |
ADD_SQLWKLD_STATEMENT Procedure |
Adds a single statement to a workload | SQL Access Advisor only |
CANCEL_TASK Procedure |
Cancels a currently executing task operation | All Advisors |
CREATE_FILE Procedure |
Creates an external file from a PL/SQL CLOB variable, which is useful for creating scripts and reports | All Advisors |
CREATE_OBJECT Procedure |
Creates a new task object | All Advisors |
CREATE_SQLWKLD Procedure |
Creates a new workload object | SQL Access Advisor only |
CREATE_TASK Procedures |
Creates a new Advisor task in the repository | All Advisors |
DELETE_SQLWKLD Procedure |
Deletes an entire workload object | SQL Access Advisor only |
DELETE_SQLWKLD_REF Procedure |
Deletes an entire workload object | SQL Access Advisor only |
DELETE_SQLWKLD_STATEMENT Procedure |
Deletes one or more statements from a workload | SQL Access Advisor only |
DELETE_TASK Procedure |
Deletes the specified task from the repository | All Advisors |
EXECUTE_TASK Procedure |
Executes the specified task | All Advisors |
GET_REC_ATTRIBUTES Procedure |
Retrieves specific recommendation attributes from a task | All Advisors |
GET_TASK_REPORT Function |
Creates and returns a report for the specified task | All Advisors |
GET_TASK_SCRIPT Function |
Creates and returns an executable SQL script of the Advisor task's recommendations in a buffer | All Advisors |
IMPLEMENT_TASK Procedure |
Implements the tuning recommendations for a task | All Advisors |
IMPORT_SQLWKLD_SCHEMA Procedure |
Imports data into a workload from the current SQL cache | SQL Access Advisor only |
IMPORT_SQLWKLD_SQLCACHE Procedure |
Imports data into a workload from the current SQL cache | SQL Access Advisor only |
IMPORT_SQLWKLD_STS Procedure |
Imports data into a workload from a SQL Tuning Set into a SQL workload data object | SQL Access Advisor only |
IMPORT_SQLWKLD_SUMADV Procedure |
Imports data into a workload from the current SQL cache | SQL Access Advisor only |
IMPORT_SQLWKLD_USER Procedure |
Imports data into a workload from the current SQL cache | SQL Access Advisor only |
INTERRUPT_TASK Procedure |
Stops a currently executing task, ending its operations as it would at a normal exit, so that the recommendations are visible | All Advisors |
MARK_RECOMMENDATION Procedure |
Sets the annotation_status for a particular recommendation |
All Advisors |
QUICK_TUNE Procedure |
Performs an analysis on a single SQL statement | All Advisors |
RESET_TASK Procedure |
Resets a task to its initial state | All Advisors |
SET_DEFAULT_SQLWKLD_PARAMETER Procedure |
Imports data into a workload from schema evidence | SQL Access Advisor only |
SET_DEFAULT_TASK_PARAMETER Procedures |
Modifies a default task parameter | All Advisors |
SET_SQLWKLD_PARAMETER Procedure |
Sets the value of a workload parameter | SQL Access Advisor only |
SET_TASK_PARAMETER Procedure |
Sets the specified task parameter value | All Advisors |
TUNE_MVIEW Procedure |
Shows how to decompose a materialized view into two or more materialized views or to restate the materialized view in a way that is more advantageous for fast refresh and query rewrite | SQL Access Advisor only |
UPDATE_OBJECT Procedure |
Updates a task object | All Advisors |
UPDATE_REC_ATTRIBUTES Procedure |
Updates an existing recommendation for the specified task | All Advisors |
UPDATE_SQLWKLD_ATTRIBUTES Procedure |
Updates a workload object | SQL Access Advisor only |
UPDATE_SQLWKLD_STATEMENT Procedure |
Updates one or more SQL statements in a workload | SQL Access Advisor only |
UPDATE_TASK_ATTRIBUTES Procedure |
Updates a task's attributes | All Advisors |
This procedure establishes a link between the current SQL Access Advisor task and a SQL Workload object. The link allows an advisor task to access interesting data for doing an analysis. The link also provides a stable view of the data. Once a connection between a SQL Access Advisor task and a SQL Workload object is made, the workload is protected from removal or modification.
Syntax
DBMS_ADVISOR.ADD_SQLWKLD_REF ( task_name IN VARCHAR2, workload_name IN VARCHAR2);
Parameters
Table 12-2 ADD_SQLWKLD_REF Procedure Parameters
Parameter | Description |
---|---|
task_name |
The SQL Access task name that uniquely identifies an existing task. |
workload_name |
The name of the workload object to be linked. Once a object has been linked to a task, it becomes read-only and cannot be deleted. There is no limit to the number of links to workload objects. To remove the link to the workload object, use the procedure DELETE_REFERENCE . |
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); END; /
This procedure adds a single statement to the specified workload.
Syntax
DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT ( workload_name IN VARCHAR2, module IN VARCHAR2, action IN VARCHAR2, cpu_time IN NUMBER := 0, elapsed_time IN NUMBER := 0, disk_reads IN NUMBER := 0, buffer_gets IN NUMBER := 0, rows_processed IN NUMBER := 0, optimizer_cost IN NUMBER := 0, executions IN NUMBER := 1, priority IN NUMBER := 2, last_execution_date IN DATE := 'SYSDATE', stat_period IN NUMBER := 0, username IN VARCHAR2, sql_text IN CLOB);
Parameters
Table 12-3 ADD_SQLWKLD_STATEMENT Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload name that uniquely identifies an existing workload. |
module |
An optional business application module that will be associated with the SQL statement. |
action |
An optional application action that will be associated with the SQL statement. |
cpu_time |
The total CPU time in seconds that is consumed by the SQL statement. |
elapsed_time |
The total elapsed time in seconds that is consumed by the SQL statement. |
disk_reads |
The total disk-read operations that are consumed by the SQL statement. |
buffer_gets |
The total buffer-get operations that are consumed by the SQL statement. |
rows_processed |
The average number of rows processed by the SQL statement. |
optimizer_cost |
The optimizer's calculated cost value. |
executions |
The total execution count by the SQL statement. This value should be greater than zero. |
priority |
The relative priority of the SQL statement. The value must be one of the following: 1-HIGH , 2-MEDIUM , or 3-LOW . |
last_execution_date |
The date and time at which the SQL statement last executed. If the value is NULL , then the current date and time will be used. |
stat_period |
Time interval in seconds from which statement statistics were calculated. |
username |
The Oracle user name that executed the SQL statement. Because a username is an Oracle identifier, the username value must be entered exactly as it is stored in the server. For example, if the user SCOTT is the executing user, then you must provide the user identifier SCOTT in all uppercase letters. It will not recognize the user scott as a match for SCOTT . |
sql_text |
The complete SQL statement. To increase the quality of a recommendation, the SQL statement should not contain bind variables. |
Usage Notes
A workload cannot be modified or deleted if it is currently referenced by an active task. A task is considered active if it is not in its initial state. See "RESET_TASK Procedure" for directions on setting a task to its initial state.
The ADD_SQLWKLD_STATEMENT
procedure accepts several parameters that may be ignored by the caller. cpu_time
, elapsed_time
, disk_reads
, buffer_gets
, and optimizer_cost
are only used to sort workload data when actual analysis occurs, so actual values are only necessary when the order_list
task parameter references a particular statistic.To determine what statistics to provide when adding a new SQL statement to a workload, examine or set the task parameter order_list
. The order_list
parameter accepts any combination of the keys: buffer_gets
, optimizer_cost
, cpu_time
, disk_reads
, elapsed_time
, executions
, and priority
. A typical setting of priority
, optimizer_cost
would indicate the SQL Access Advisor will sort the workload data by priority
and optimizer_cost
and process the highest cost statements first. Any statements added to the workload would need to include appropriate priority
and optimizer_cost
values. All other statistics can be defaulted or set to zero.For the statistical keys referenced by the order_list
task parameter, the actual parameter values should be reasonably accurate since they will be compared to other statements in the workload. If the caller is unable to estimate values, choose values that would determine its importance relative to other statements in the workload. For example, if the current statement is considered the most critical query in your business, then an appropriate value would be anything greater than all other values for the same statistic found in the workload.
Examples
DECLARE workload_name VARCHAR2(30); BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales'); END; /
This procedure causes a currently executing operation to terminate. This call does a soft interrupt. It will not break into a low-level database access call like a hard interrupt such as Ctrl-C
. The SQL Access Advisor periodically checks for soft interrupts and acts appropriately. As a result, this operation may take a few seconds to respond to a call.
Syntax
DBMS_ADVISOR.CANCEL_TASK ( task_name IN VARCHAR2);
Parameters
Table 12-4 CANCEL_TASK Procedure Parameter
Parameter | Description |
---|---|
task_name |
A valid Advisor task name that uniquely identifies an existing task. |
Usage Notes
A cancel command effective restores the task to its condition prior to the start of the cancelled operation. Therefore, a cancelled task or data object cannot be resumed.
Because all Advisor task procedures are synchronous, to cancel an operation, you must use a separate database session.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CANCEL_TASK('My Task'); END; /
This procedure creates an external file from a PL/SQL CLOB
variable, which is used for creating scripts and reports. CREATE_FILE
accepts a CLOB
input parameter and writes the character string contents to the specified file.
Syntax
DBMS_ADVISOR.CREATE_FILE ( buffer IN CLOB, location IN VARCHAR2, filename IN VARCHAR2);
Parameters
Table 12-5 CREATE_FILE Procedure Parameters
Parameter | Description |
---|---|
buffer |
A CLOB buffer containing report or script information. |
location |
Specifies the directory that will contain the new file. You must use the directory alias as defined by the CREATE DIRECTORY statement. The Advisor will translate the alias into the actual directory location. |
filename |
Specifies the output file to receive the script commands. The filename can only contain the name and an optional file type of the form filename.filetype . |
Usage Notes
All formatting must be embedded within the CLOB
.
The Oracle server restricts file access within Oracle Stored Procedures. This means that file locations and names must adhere to the known file permissions in the server.
Examples
CREATE DIRECTORY MY_DIR as '/homedir/user4/gssmith'; GRANT READ,WRITE ON DIRECTORY MY_DIR TO PUBLIC; DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales'); DBMS_ADVISOR.EXECUTE_TASK(task_name); DBMS_ADVISOR.CREATE_FILE(DBMS_ADVISOR.GET_TASK_SCRIPT(task_name), 'MY_DIR','script.sql'); END; /
This procedure creates a new task object.
Syntax
DBMS_ADVISOR.CREATE_OBJECT ( task_name IN VARCHAR2, object_type IN VARCHAR2, attr1 IN VARCHAR2 := NULL, attr2 IN VARCHAR2 := NULL, attr3 IN VARCHAR2 := NULL, attr4 IN CLOB := NULL, object_id OUT NUMBER); DBMS_ADVISOR.CREATE_OBJECT ( task_name IN VARCHAR2, object_type IN VARCHAR2, attr1 IN VARCHAR2 := NULL, attr2 IN VARCHAR2 := NULL, attr3 IN VARCHAR2 := NULL, attr4 IN CLOB := NULL, attr5 IN VARCHAR2 := NULL, object_id OUT NUMBER);
Parameters
Table 12-6 CREATE_OBJECT Procedure Parameters
Parameter | Description |
---|---|
task_name |
A valid Advisor task name that uniquely identifies an existing task. |
object_type |
Specifies the external object type. |
attr1 |
Advisor-specific data. |
attr2 |
Advisor-specific data. |
attr3 |
Advisor-specific data. |
attr4 |
Advisor-specific data. |
attr5 |
Advisor-specific data. |
object_id |
The advisor-assigned object identifier. |
The attribute parameters have different values depending upon the object type. See Oracle Database Administrator's Guide for details regarding these parameters and object types.
Return Values
Returns the new object identifier.
Usage Notes
Task objects are typically used as input data for a particular advisor. Segment advice can be generated at the object, segment, or tablespace level. If for the object level, advice is generated on all partitions of the object (if the object is partitioned). The advice is not cascaded to any dependent objects. If for the segment level, advice can be obtained on a single segment, such as the partition or subpartition of a table, index, or LOB
column. If for a tablespace level, target advice for every segment in the tablespace will be generated.
See Oracle Database Administrator's Guide for further information regarding the Segment Advisor.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); obj_id NUMBER; BEGIN task_name := 'My Task'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_OBJECT (task_name,'SQL',NULL,NULL,NULL, 'SELECT * FROM SH.SALES',obj_id); END; /
This procedure creates a new private SQL Workload object for the user. A SQL Workload object manages a SQL workload on behalf of the SQL Access Advisor. A SQL Workload object must exist prior to performing any other SQL Workload operations, such as importing or updating SQL statements.
Syntax
DBMS_ADVISOR.CREATE_SQLWKLD ( workload_name IN OUT VARCHAR2, description IN VARCHAR2 := NULL, template IN VARCHAR2 := NULL, is_template IN VARCHAR2 := 'FALSE');
Parameters
Table 12-7 CREATE_SQLWKLD Procedure Parameters
Parameter | Description |
---|---|
workload_name |
A name that uniquely identifies the created workload. If not specified, the system will generate a unique name. Names can be up to 30 characters long. |
description |
Specifies an optional workload description. Descriptions can be up to 256 characters. |
template |
An optional SQL Workload name of an existing workload data object or data object template. |
is_template |
An optional value that enables you to set the newly created workload as a template. Valid values are TRUE and FALSE . |
Return Values
The SQL Access Advisor returns a unique workload object identifier number that must be used for subsequent activities within the new SQL Workload object.
Usage Notes
By default, workload objects are created using built-in default settings. To create a workload using the parameter settings of an existing workload or workload template, the user may specify an existing workload name.
Once a SQL Workload object is present, it can then be referenced by one or more SQL Access Advisor tasks using the ADD_SQLWKLD_REF
procedure.
Examples
DECLARE workload_name VARCHAR2(30); BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); END; /
This procedure creates a new Advisor task in the repository.
Syntax
DBMS_ADVISOR.CREATE_TASK ( advisor_name IN VARCHAR2, task_id OUT NUMBER, task_name IN OUT VARCHAR2, task_desc IN VARCHAR2 := NULL, template IN VARCHAR2 := NULL, is_template IN VARCHAR2 := 'FALSE', how_created IN VARCHAR2 := NULL); DBMS_ADVISOR.CREATE_TASK ( advisor_name IN VARCHAR2, task_name IN VARCHAR2, task_desc IN VARCHAR2 := NULL, template IN VARCHAR2 := NULL, is_template IN VARCHAR2 := 'FALSE', how_created IN VARCHAR2 := NULL);
Parameters
Table 12-8 CREATE_TASK Procedure Parameters
Parameter | Description |
---|---|
advisor_name |
Specifies the unique advisor name as defined in the view DBA_ADVISOR_DEFINITIONS . |
task_id |
A number that uniquely identifies the created task. The number is generated by the procedure and returned to the user. |
task_name |
Specifies a new task name. Names must be unique among all tasks for the user.
When using the second form of the |
task_desc |
Specifies an optional task description. Descriptions can be up to 256 characters in length. |
template |
An optional task name of an existing task or task template. To specify built-in SQL Access Advisor templates, use the template name as described earlier. |
is_template |
An optional value that allows the user to set the newly created task as template. Valid values are: TRUE and FALSE . |
how_created |
An optional value that identifies how the source was created. |
Return Values
Returns a unique task ID number and a unique task name if one is not specified.
Usage Notes
A task must be associated with an advisor, and once the task has been created, it is permanently associated with the original advisor. By default, tasks are created using built-in default settings. To create a task using the parameter settings of an existing task or task template, the user may specify an existing task name.
For the SQL Access Advisor, use the identifier DBMS_ADVISOR.SQLACCESS_ADVISOR
as the advisor_name
.
The SQL Access Advisor provides three built-in task templates, using the following constants:
DBMS_ADVISOR.SQLACCESS_OLTP
Parameters are preset to favor an OLTP application environment.
DBMS_ADVISOR.SQLACCESS_WAREHOUSE
Parameters are preset to favor a data warehouse application environment.
DBMS_ADVISOR.SQLACCESS_GENERAL
Parameters are preset to favor a hybrid application environment where both OLTP and data warehouse operations may occur. For the SQL Access Advisor, this is the default template.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); BEGIN task_name := 'My Task'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); END; /
This procedure deletes an existing SQL Workload object from the repository.
Syntax
DBMS_ADVISOR.DELETE_SQLWKLD ( workload_name IN VARCHAR2);
Parameters
Table 12-9 DELETE_SQLWKLD Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload object name that uniquely identifies an existing workload. The wildcard % is supported as a WORKLOAD_NAME . The rules of use are identical to the LIKE operator. For example, to delete all tasks for the current user, use the wildcard % as the WORKLOAD_NAME . If a wildcard is provided, the DELETE_SQLWKLD operation will not delete any workloads marked as READ_ONLY or TEMPLATE . |
Usage Notes
A workload cannot be modified or deleted if it is currently referenced by an active task. A task is considered active if it is not in its initial state. See the "RESET_TASK Procedure" to set a task to its initial state.
Examples
DECLARE workload_name VARCHAR2(30); BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.DELETE_SQLWKLD(workload_name); END; /
This procedure removes a link between the current SQL Access task and a SQL Workload data object.
Syntax
DBMS_ADVISOR.DELETE_SQLWKLD_REF ( task_name IN VARCHAR2, workload_name IN NUMBER);
Parameters
Table 12-10 DELETE_SQLWKLD_REF Procedure Parameters
Parameter | Description |
---|---|
task_name |
The SQL Access task name that uniquely identifies an existing task. |
workload_name |
The name of the workload object to be unlinked. The wildcard % is supported as a workload_name . The rules of use are identical to the LIKE operator. For example, to remove all links to workload objects, use the wildcard % as the workload_name . |
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales'); DBMS_ADVISOR.DELETE_SQLWKLD_REF(task_name, workload_name); END; /
This procedure deletes one or more statements from a workload.
Syntax
DBMS_ADVISOR.DELETE_SQLWKLD_STATEMENT ( workload_name IN VARCHAR2, sql_id IN NUMBER); DBMS_ADVISOR.DELETE_SQLWKLD_STATEMENT ( workload_name IN VARCHAR2, search IN VARCHAR2, deleted OUT NUMBER);
Parameters
Table 12-11 DELETE_SQLWKLD_STATEMENT Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload object name that uniquely identifies an existing workload. |
sql_id |
The Advisor-generated identifier number that is assigned to the statement. To specify all workload statements, use the constant ADVISOR_ALL . |
search |
Disabled. |
deleted |
Returns the number of statements deleted by the searched deleted operation. |
Usage Notes
A workload cannot be modified or deleted if it is currently referenced by an active task. A task is considered active if it is not in its initial state. See the "RESET_TASK Procedure" to set a task to its initial state.
Examples
DECLARE workload_name VARCHAR2(30); deleted NUMBER; id NUMBER; BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'YEARLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales'); SELECT sql_id INTO id FROM USER_ADVISOR_SQLW_STMTS WHERE workload_name = 'My Workload'; DBMS_ADVISOR.DELETE_SQLWKLD_STATEMENT(workload_name, id); END; /
This procedure deletes an existing task from the repository.
Syntax
DBMS_ADVISOR.DELETE_TASK ( task_name IN VARCHAR2);
Parameters
Table 12-12 DELETE_TASK Procedure Parameters
Parameter | Description |
---|---|
task_name |
A single Advisor task name that will be deleted from the repository.
The wildcard If a wildcard is provided, the |
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); BEGIN task_name := 'My Task'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.DELETE_TASK(task_name); END; /
This procedure performs the Advisor analysis or evaluation for the specified task.
Syntax
DBMS_ADVISOR.EXECUTE_TASK ( task_name IN VARCHAR2);
Parameters
Table 12-13 EXECUTE_TASK Procedure Parameters
Parameter | Description |
---|---|
task_name |
The task name that uniquely identifies an existing task. |
Usage Notes
Task execution is a synchronous operation. Control will not be returned to the caller until the operation has completed, or a user-interrupt was detected.
Upon return, you can check the DBA_ADVISOR_LOG
table for the execution status.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales'); DBMS_ADVISOR.EXECUTE_TASK(task_name); END; /
This procedure retrieves a specified attribute of a new object as recommended by Advisor analysis.
Syntax
DBMS_ADVISOR.GET_REC_ATTRIBUTES ( workload_name IN VARCHAR2, rec_id IN NUMBER, action_id IN NUMBER, attribute_name IN VARCHAR2, value OUT VARCHAR2, owner_name IN VARCHAR2 := NULL);
Parameters
Table 12-14 GET_REC_ATTRIBUTES Procedure Parameters
Parameter | Description |
---|---|
task_name |
The task name that uniquely identifies an existing task. |
rec_id |
The Advisor-generated identifier number that is assigned to the recommendation. |
action_id |
The Advisor-generated action identifier that is assigned to the particular command. |
attribute_name |
Specifies the attribute to change. |
value |
The buffer to receive the requested attribute value. |
owner_name |
Optional owner name of the target task. This permits access to task data not owned by the current user. |
Return Values
The requested attribute value is returned in the VALUE
argument.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); attribute VARCHAR2(100); BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales WHERE promo_id = 10'); DBMS_ADVISOR.EXECUTE_TASK(task_name); DBMS_ADVISOR.GET_REC_ATTRIBUTES(task_name, 1, 1, 'NAME', attribute); END; /
This function creates and returns a report for the specified task.
Syntax
DBMS_ADVISOR.GET_TASK_REPORT ( task_name IN VARCHAR2, type IN VARCHAR2 := 'TEXT', level IN VARCHAR2 := 'TYPICAL', section IN VARCHAR2 := 'ALL', owner_name IN VARCHAR2 := NULL) RETURN CLOB;
Parameters
Table 12-15 GET_TASK_REPORT Function Parameters
Parameter | Description |
---|---|
task_name |
The name of the task from which the script will be created. |
type |
The only valid value is TEXT . |
level |
The possible values are BASIC , TYPICAL , and ALL . |
section |
Advisor-specific report sections. |
owner_name |
Owner of the task. If specified, the system will check to see if the current user has read privileges to the task data. |
Return Values
Returns the buffer receiving the script.
This function creates a SQL*Plus-compatible SQL script and sends the output to file. The script will contain all of the accepted recommendations from the specified task.
Syntax
DBMS_ADVISOR.GET_TASK_SCRIPT ( task_name IN VARCHAR2 type IN VARCHAR2 := 'IMPLEMENTATION', rec_id IN NUMBER := NULL, act_id IN NUMBER := NULL, owner_name IN VARCHAR2 := NULL) RETURN CLOB;
Parameters
Table 12-16 GET_TASK_SCRIPT Function Parameters
Parameter | Description |
---|---|
task_name |
The task name that uniquely identifies an existing task. |
type |
Specifies the type of script to generate. The possible values are IMPLEMENTATION and UNDO . |
rec_id |
An optional recommendation identifier number that can be used to extract a subset of the implementation script.
A zero or the value |
act_id |
Optional action identifier number that can be used to extract a single action as a DDL command.
A zero or the value |
owner_name |
Optional task owner name. |
Return Values
Returns the script as a CLOB
buffer.
Usage Notes
Though the script is ready to execute, Oracle recommends that the user review the script for acceptable locations for new materialized views and indexes.
For a recommendation to appear in a generated script, it must be marked as accepted.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); buf CLOB; BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales'); DBMS_ADVISOR.EXECUTE_TASK(task_name); buf := DBMS_ADVISOR.GET_TASK_SCRIPT(task_name); END; /
Implements the recommendations of the specified task.
Syntax
DBMS_ADVISOR.IMPLEMENT_TASK ( task_name IN VARCHAR2, rec_id IN NUMBER := NULL, exit_on_error IN BOOLEAN := NULL);
Parameters
Table 12-17 IMPLEMENT_TASK Procedure Parameters
Parameter | Description |
---|---|
task_name |
The name of the task. |
rec_id |
An optional recommendation ID. |
exit_on_error |
An optional boolean to exit on the first error. |
This procedure constructs and loads a SQL workload based on schema evidence. The workload is also referred to as a hypothetical workload.
Syntax
DBMS_ADVISOR.IMPORT_SQLWKLD_SCHEMA ( workload_name IN VARCHAR2, import_mode IN VARCHAR2 := 'NEW', priority IN NUMBER := 2, saved_rows OUT NUMBER, failed_rows OUT NUMBER);
Parameters
Table 12-18 IMPORT_SQLWKLD_SCHEMA Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload object name that uniquely identifies an existing workload. |
import_mode |
Specifies the action to be taken when storing the workload. Possible values are:
The default value is |
priority |
Specifies the application priority for each statement that is saved in the workload object. The value must be one of the following: 1-HIGH , 2-MEDIUM , or 3-LOW . |
failed_rows |
Returns the number or rows that were not saved due to syntax or validation errors |
saved_rows |
Returns the number of rows actually saved in the repository. |
Return Values
This call returns the number of rows saved and failed as output parameters.
Usage Notes
To successfully import a hypothetical workload, the target schemas must contain dimensions.
If the VALID_TABLE_LIST
parameter is not set, the search space may become very large and require a significant amount of time to complete. Oracle Corporation recommends that you limit your search space to specific set of tables.
If a task contains valid recommendations from a prior run, adding or modifying task will mark the task as invalid, preventing the viewing and reporting of potentially valuable recommendation data.
Examples
DECLARE workload_name VARCHAR2(30); saved NUMBER; failed NUMBER; BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.SET_SQLWKLD_PARAMETER(workload_name,'VALID_TABLE_LIST','SH.%'); DBMS_ADVISOR.IMPORT_SQLWKLD_SCHEMA(workload_name, 'REPLACE', 1, saved, failed); END; /
This procedure creates a SQL workload from the current contents of the server's SQL cache.
Syntax
DBMS_ADVISOR.IMPORT_SQLWKLD_SQLCACHE ( workload_name IN VARCHAR2, import_mode IN VARCHAR2 := 'NEW', priority IN NUMBER := 2, saved_rows OUT NUMBER, failed_rows OUT NUMBER);
Parameters
Table 12-19 IMPORT_SQLWKLD_SQLCACHE Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload object name that uniquely identifies an existing workload. |
import_mode |
Specifies the action to be taken when storing the workload. Possible values are:
The default value is |
priority |
Specifies the application priority for each statement that is saved in the workload object. The value must be one of the following 1-HIGH , 2-MEDIUM , or 3-LOW . |
saved_rows |
Returns the number of rows saved as output parameters. |
failed_rows |
Returns the number of rows that were not saved due to syntax or validation errors. |
Return Values
This call returns the number of rows saved and failed as output parameters.
Usage Notes
A workload cannot be modified or deleted if it is currently referenced by an active task. A task is considered active if it is not in its initial state. See "RESET_TASK Procedure" to set a task to its initial state.
Examples
DECLARE workload_name VARCHAR2(30); saved NUMBER; failed NUMBER; BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.SET_SQLWKLD_PARAMETER(workload_name,'VALID_TABLE_LIST','SH.%'); DBMS_ADVISOR.IMPORT_SQLWKLD_SQLCACHE(workload_name, 'REPLACE', 1, saved, failed); END; /
This procedure loads a SQL workload from an existing SQL Tuning Set. A SQL Tuning Set is typically created from the server workload repository using various time and data filters.
Syntax
DBMS_ADVISOR.IMPORT_SQLWKLD_STS ( workload_name IN VARCHAR2, sts_name IN VARCHAR2, import_mode IN VARCHAR2 := 'NEW', priority IN NUMBER := 2, saved_rows OUT NUMBER, failed_rows OUT NUMBER);
DBMS_ADVISOR.IMPORT_SQLWKLD_STS ( workload_name IN VARCHAR2, sts_owner IN VARCHAR2, sts_name IN VARCHAR2, import_mode IN VARCHAR2 := 'NEW', priority IN NUMBER := 2, saved_rows OUT NUMBER, failed_rows OUT NUMBER);
Parameters
Table 12-20 IMPORT_SQLWKLD_STS Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload object name that uniquely identifies an existing workload. |
sts_owner |
The optional owner of the SQL Tuning Set. |
sts_name |
The name of an existing SQL Tuning Set workload from which the data will be imported. If the sts_owner value is not provided, the owner will default to the current user. |
import_mode |
Specifies the action to be taken when storing the workload. Possible values are:
The default value is |
priority |
Specifies the application priority for each statement that is saved in the workload object. The value must be one of the following: 1-HIGH , 2-MEDIUM , or 3-LOW . The default value is 2. |
saved_rows |
Returns the number of rows actually saved in the repository. |
failed_rows |
Returns the number of rows that were not saved due to syntax or validation errors. |
Return Values
This call returns the number of rows saved and failed as output parameters.
Usage Notes
A workload cannot be modified or deleted if it is currently referenced by an active task. A task is considered active if it is not in its initial state. See "RESET_TASK Procedure" to set a task to its initial state.
Examples
DECLARE workload_name VARCHAR2(30); saved NUMBER; failed NUMBER; BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.SET_SQLWKLD_PARAMETER(workload_name,'VALID_TABLE_LIST','SH.%'); DBMS_ADVISOR.IMPORT_SQLWKLD_STS(workload_name, 'MY_SQLSET', 'REPLACE', 1, saved, failed); END; /
This procedure collects a SQL workload from a Summary Advisor workload. This procedure is intended to assist Oracle9i Database Summary Advisor users in the migration to SQL Access Advisor.
Syntax
DBMS_ADVISOR.IMPORT_SQLWKLD_SUMADV ( workload_name IN VARCHAR2, import_mode IN VARCHAR2 := 'NEW', priority IN NUMBER := 2, sumadv_id IN NUMBER, saved_rows OUT NUMBER, failed_rows OUT NUMBER);
Parameters
Table 12-21 IMPORT_SQLWKLD_SUMADV Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload object name that uniquely identifies an existing workload. |
import_mode |
Specifies the action to be taken when storing the workload. Possible values are:
The default value is |
priority |
Specifies the default application priority for each statement that is saved in the workload object. If a Summary Advisor workload statement contains a priority of zero, the default priority will be applied. If the workload statement contains a valid priority, then the Summary Advisor priority will be converted to a comparable SQL Access Advisor priority. The value must be one of the following:
1- |
sumadv_id |
Specifies the Summary Advisor workload identifier number. |
saved_rows |
Returns the number of rows actually saved in the repository. |
failed_rows |
Returns the number of rows that were not saved due to syntax or validation errors. |
Return Values
This call returns the number of rows saved and failed as output parameters.
Usage Notes
A workload cannot be modified or deleted if it is currently referenced by an active task. A task is considered active if it is not in its initial state. See "RESET_TASK Procedure" to set a task to its initial state.
Examples
DECLARE workload_name VARCHAR2(30); saved NUMBER; failed NUMBER; sumadv_id NUMBER; BEGIN workload_name := 'My Workload'; sumadv_id := 394; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.SET_SQLWKLD_PARAMETER(workload_name,'VALID_TABLE_LIST','SH.%'); DBMS_ADVISOR.IMPORT_SQLWKLD_SUMADV(workload_name, 'REPLACE', 1, sumadv_id, saved, failed); END; /
This procedure collects a SQL workload from a specified user table.
Syntax
DBMS_ADVISOR.IMPORT_SQLWKLD_USER ( workload_name IN VARCHAR2, import_mode IN VARCHAR2 := 'NEW', owner_name IN VARCHAR2, table_name IN VARCHAR2, saved_rows OUT NUMBER, failed_rows OUT NUMBER);
Parameters
Table 12-22 IMPORT_SQLWKLD_USER Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload object name that uniquely identifies an existing workload. |
import_mode |
Specifies the action to be taken when storing the workload. Possible values are:
The default value is |
owner_name |
Specifies the owner name of the table or view from which workload data will be collected. |
table_name |
Specifies the name of the table or view from which workload data will be collected. |
saved_rows |
Returns the number of rows actually saved in the workload object. |
failed_rows |
Returns the number of rows that were not saved due to syntax or validation errors. |
Return Values
This call returns the number of rows saved and failed as output parameters.
Usage Notes
A workload cannot be modified or deleted if it is currently referenced by an active task. A task is considered active if it is not in its initial state. See "RESET_TASK Procedure" to set a task to its initial state.
Examples
DECLARE workload_name VARCHAR2(30); saved NUMBER; failed NUMBER; BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.SET_SQLWKLD_PARAMETER(workload_name,'VALID_TABLE_LIST','SH.%'); DBMS_ADVISOR.IMPORT_SQLWKLD_USER(workload_name, 'REPLACE', 'SH', 'USER_WORKLOAD', saved, failed); END; /
This procedure stops a currently executing task. The task will end its operations as it would at a normal exit. The user will be able to access any recommendations that exist to this point.
Syntax
DBMS_ADVISOR.INTERRUPT_TASK ( task_name IN VARCHAR2);
Parameters
Table 12-23 INTERRUPT_TASK Procedure Parameters
Parameter | Description |
---|---|
task_name |
A single Advisor task name that will be interrupted. |
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); BEGIN task_name := 'My Task'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.EXECUTE_TASK(task_name); END; /
While this session is executing its task, you can interrupt the task from a second session using the following statement:
BEGIN DBMS_ADVISOR.INTERRUPT_TASK('My Task'); END; /
This procedure marks a recommendation for import or implementation.
Syntax
DBMS_ADVISOR.MARK_RECOMMENDATION ( task_name IN VARCHAR2 id IN NUMBER, action IN VARCHAR2);
Parameters
Table 12-24 MARK_RECOMMENDATION Procedure Parameters
Parameter | Description |
---|---|
task_name |
Name of the task. |
id |
The recommendation identifier number assigned by the Advisor. |
action |
The recommendation action setting. The possible actions are:
|
Usage Notes
For a recommendation to be implemented, it must be marked as accepted. By default, all recommendations are considered accepted and will appear in any generated scripts.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); attribute VARCHAR2(100); rec_id NUMBER; BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales WHERE promo_id = 10'); DBMS_ADVISOR.EXECUTE_TASK(task_name); rec_id := 1; DBMS_ADVISOR.MARK_RECOMMENDATION(task_name, rec_id, 'REJECT'); END; /
This procedure performs an analysis and generates recommendations for a single SQL statement.
This provides a shortcut method of all necessary operations to analyze the specified SQL statement. The operation creates a task using the specified task name. The task will be created using a specified Advisor task template. Finally, the task will be executed and the results will be saved in the repository.
Syntax
DBMS_ADVISOR.QUICK_TUNE ( advisor_name IN VARCHAR2, task_name IN VARCHAR2, attr1 IN CLOB, attr2 IN VARCHAR2 := NULL, attr3 IN NUMBER := NULL, task_or_template IN VARCHAR2 := NULL);
Parameters
Table 12-25 QUICK_TUNE Procedure Parameters
Parameter | Description |
---|---|
advisor_name |
Name of the Advisor that will perform the analysis. |
task_name |
Name of the task. |
attr1 |
Advisor-specific attribute in the form of a CLOB variable. |
attr2 |
Advisor-specific attribute in the form of a VARCHAR2 variable. |
attr3 |
Advisor-specific attribute in the form of a NUMBER . |
task_or_template |
An optional task name of an existing task or task template. |
Usage Notes
If indicated by the user, the final recommendations can be implemented by the procedure.
The task will be created using either a specified SQL Access task template or the built-in default template of SQLACCESS_GENERAL
. The workload will only contain the specified statement, and all task parameters will be defaulted.
attr1
must be the single SQL statement to tune. For the SQL Access Advisor, attr2
is the user who would execute the single statement. If omitted, the current user will be used.
Examples
DECLARE task_name VARCHAR2(30); BEGIN task_name := 'My Task'; DBMS_ADVISOR.QUICK_TUNE(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_name, 'SELECT AVG(amount_sold) FROM sh.sales WHERE promo_id=10'); END; /
This procedure resets a workload to its initial starting point. This has the effect of removing all journal messages, log messages, and recalculating necessary volatility and usage statistics.
Syntax
DBMS_ADVISOR.RESET_SQLWKLD ( workload_name IN VARCHAR2);
Parameters
Table 12-26 RESET_SQLWKLD Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The SQL Workload object name that uniquely identifies an existing workload. |
Usage Notes
RESET_SQLWKLD
should be executed after any workload adjustments such as adding or removing SQL statements.
Examples
DECLARE workload_name VARCHAR2(30); BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales WHERE promo_id = 10'); DBMS_ADVISOR.RESET_SQLWKLD(workload_name); END; /
This procedure resets a task to its initial state. All intermediate and recommendation data will be removed from the task. The task status will be set to INITIAL
.
Syntax
DBMS_ADVISOR.RESET_TASK ( task_name IN VARCHAR2);
Parameters
Table 12-27 RESET_TASK Procedure Parameters
Parameter | Description |
---|---|
task_name |
The task name that uniquely identifies an existing task. |
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales WHERE promo_id = 10'); DBMS_ADVISOR.EXECUTE_TASK(task_name); DBMS_ADVISOR.RESET_TASK(task_name); END; /
This procedure modifies the default value for a user parameter within a SQL Workload object or SQL Workload object template. A user parameter is a simple variable that stores various attributes that affect workload collection, tuning decisions and reporting. When a default value is changed for a parameter, workload objects will inherit the new value when they are created.
Syntax
DBMS_ADVISOR.SET_DEFAULT_SQLWKLD_PARAMETER ( parameter IN VARCHAR2, value IN VARCHAR2); DBMS_ADVISOR.SET_DEFAULT_SQLWKLD_PARAMETER ( parameter IN VARCHAR2, value IN NUMBER);
Parameters
Table 12-28 SET_DEFAULT_SQLWKLD_PARAMETER Procedure Parameters
Parameter | Description |
---|---|
parameter |
The name of the data parameter to be modified. Parameter names are not case sensitive. Parameter names are unique to the workload object type, but not necessarily unique to all workload object types. Various object types may use the same parameter name for different purposes. |
value |
The value of the specified parameter. The value can be specified as a string or a number. If the value is DBMS_ADVISOR.DEFAULT , the value will be reset to the default value. |
Usage Notes
A parameter will only affect operations that modify the workload collection. Therefore, parameters should be set prior to importing or adding new SQL statements to a workload. If a parameter is set after data has been placed in a workload object, it will have no effect on the existing data.
Examples
BEGIN DBMS_ADVISOR.SET_DEFAULT_SQLWKLD_PARAMETER('VALID_TABLE_LIST','SH.%'); END; /
This procedure modifies the default value for a user parameter within a task or a template. A user parameter is a simple variable that stores various attributes that affect various Advisor operations. When a default value is changed for a parameter, tasks will inherit the new value when they are created.
A default task is different from a regular task. The default value is the initial value that will be inserted into a newly created task, while setting a task parameter with SET_TASK_PARAMETER
sets the local value only. Thus, SET_DEFAULT_TASK_PARAMETER
has no effect on an existing task.
Syntax
DBMS_ADVISOR.SET_DEFAULT_TASK_PARAMETER ( advisor_name IN VARCHAR2 parameter IN VARCHAR2, value IN VARCHAR2); DBMS_ADVISOR.SET_DEFAULT_TASK_PARAMETER ( advisor_name IN VARCHAR2 parameter IN VARCHAR2, value IN NUMBER);
Parameters
Table 12-29 SET_DEFAULT_TASK_PARAMETER Procedure Parameters
Parameter | Description |
---|---|
advisor_name |
Specifies the unique advisor name as defined in the view DBA_ADVISOR_DEFINITIONS . |
parameter |
The name of the task parameter to be modified. Parameter names are not case sensitive. Parameter names are unique to the task type, but not necessarily unique to all task types. Various task types may use the same parameter name for different purposes. |
value |
The value of the specified task parameter. The value can be specified as a string or a number. |
Examples
BEGIN DBMS_ADVISOR.SET_DEFAULT_TASK_PARAMETER(DBMS_ADVISOR.SQLACCESS_ADVISOR, 'VALID_TABLE_LIST', 'SH.%'); END; /
This procedure modifies a user parameter within a SQL Workload object or SQL Workload object template. A user parameter is a simple variable that stores various attributes that affect workload collection, tuning decisions and reporting.
Syntax
DBMS_ADVISOR.SET_SQLWKLD_PARAMETER ( workload_name IN VARCHAR2, parameter IN VARCHAR2, value IN VARCHAR2); DBMS_ADVISOR.SET_SQLWKLD_PARAMETER ( workload_name IN VARCHAR2, parameter IN VARCHAR2, value IN NUMBER);
Parameters
Table 12-30 SET_SQLWKLD_PARAMETER Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The SQL Workload object name that uniquely identifies an existing workload. |
parameter |
The name of the data parameter to be modified. Parameter names are not case sensitive. |
value |
The value of the specified parameter. The value can be specified as a string or a number. If the value is DBMS_ADVISOR.DEFAULT , the value will be reset to the default value. |
Usage Notes
A parameter will only affect operations that modify the workload collection. Therefore, parameters should be set prior to importing or adding new SQL statements to a workload. If a parameter is set after data has been placed in a workload object, it will have no effect on the existing data.
SQL Workload Object Parameters
Table 12-31 lists SQL Access Advisor object parameters.
Table 12-31 SQL Workload Object Parameters
Name | Datatype | Description |
---|---|---|
ACTION_LIST |
STRINGLIST |
Use VALID_ACTION_LIST instead.
Contains a fully qualified list of actions that are eligible for saving in a workload. An action can be any string. If an action is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. An action string is not scanned for correctness. During a workload import operation, if a SQL statements action does not match a name in the action list, it will not be stored in the workload object. An action name is case sensitive. The possible values are:
The default value is |
COMMENTED_FILTER_LIST |
NUMBER |
Use INVALID_SQLSTRING_LIST instead.
Comma-delimited list of strings. When set, SQL Access Advisor will filter out any SQL statement that contain any of the specified strings in the first 20 characters of its text. |
DAYS_TO_EXPIRE |
NUMBER |
Specifies the expiration time in days for the current SQL Workload object. The value is relative to the last modification date.
Once the data expires, it will become a candidate for removal by an automatic purge operation. The possible values are:
The default value is 30. |
END_TIME |
STRING |
Specifies an end time for selecting SQL statements. If the statement did not execute on or before the specified time, it will not be processed.
Each date must be in the standard Oracle form of MM-DD-YYY HH24:MI:SS, where:
|
INVALID_ACTION_LIST |
STRINGLIST |
Contains a fully qualified list of actions that are not eligible for saving in a workload.
An action can be any string. If an action is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. An action string is not scanned for correctness. During workload collection, if a SQL statement's action matches a name in the action list, it will not be processed by the operation. An action name is case sensitive. Possible values are:
The default value is |
INVALID_MODULE_LIST |
STRINGLIST |
Contains a fully qualified list of application modules that are not eligible when populating a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
A module can be any string. If a module is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A module string is not scanned for correctness. During workload collection, if a SQL statement's module matches a name in the list, it will not be processed by the operation. A module name is case sensitive. The possible values are:
The default value is |
INVALID_SQLSTRING_LIST |
Contains a fully qualified list of text strings that are not eligible when populating a SQL workload object. The list of elements is comma-delimited, and quoted values are supported.
A SQL string can be any string. If a string is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A SQL string is not scanned for correctness. During workload collection, if a SQL statement contains a string in the SQL string list, it will not be processed by the operation. The possible values are:
The default value is |
|
INVALID_TABLE_LIST |
TABLELIST |
Contains a fully qualified list of tables that are not eligible for tuning. The list elements are comma-delimited, and quoted identifiers are supported. Wildcard specifications are supported for both schemas and tables. The default value is all tables within the users scope are eligible for tuning. The supported wildcard character is % . A % wildcard matches any set of consecutive characters.
When a SQL statement is processed, it will not be accepted if any referenced table matches an entry in the invalid table list. The valid syntax for a table reference is:
The possible values are:
The default value is Note that SQL Access Advisor maintains an internal list of non-tunable tables regardless of the contents of the |
INVALID_USERNAME_LIST |
STRINGLIST |
Contains a fully qualified list of usernames that are not eligible when populating a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
During workload collection, if a SQL statements' username matches a name in the username list, it will not be processed by the operation. A username is not case sensitive unless it is quoted. The possible values are:
The default value is |
JOURNALING |
NUMBER |
Controls the logging of messages to the journal (USER_ADVISOR_JOURNAL view). The higher the setting, the more information is logged to the journal.
The valid settings are:
|
MODULE_LIST |
STRINGLIST |
Use VALID_MODULE_LIST instead.
Contains a fully qualified list of application modules that are eligible for saving in a SQL Workload object. The list elements are comma-delimited, and quoted names are supported. A module can be any string. If a module is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A module string is not scanned for correctness. During a workload import operation, if a SQL statements application module does not match a name in the module list, it will not be stored in the workload object. The possible values are:
The default value is |
ORDER_LIST |
STRING |
Contains the primary natural order in which the SQL Access Advisor processes workload elements during the import operation.
Possible values are: |
REPORT_DATE_FORMAT |
This parameter is not used. | |
SQL_LIMIT |
NUMBER |
Specifies the maximum number of SQL statements to be saved during a workload import operation. The SQL_LIMIT filter is applied after all other filters have been applied. For example, if only statements referencing the table foo.bar are to be accepted, the SQL_LIMIT value will be only apply to those statements.
When used in conjunction with the parameter The possible values are:
The default value is |
START_TIME |
STRING |
Specifies a start time for selecting SQL statements. If the statement did not execute on or before the specified time, it will not be processed.
Each date must be in the standard Oracle form of MM-DD-YYY HH24:MI:SS, where:
|
USERNAME_LIST |
STRINGLIST |
Use VALID_USERNAME_LIST instead.
Contains a fully qualified list of usernames that are eligible for processing in a SQL Workload object. The list elements are comma-delimited, and quoted names are supported. During a workload import operation, if a SQL statements username does not match a name in the username list, it will not be stored in the workload object. A Username is not case sensitive unless it is quoted. The possible values are:
The default value is |
VALID_ACTION_LIST |
STRINGLIST |
Contains a fully qualified list of actions that are eligible when populating a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
An action can be any string. If an action is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. An action string is not scanned for correctness. During workload collection, if a SQL statement's action does not match a name in the action list, it will not be processed by the operation. An action name is case sensitive. The possible values are:
The default value is |
VALID_MODULE_LIST |
STRINGLIST |
Contains a fully qualified list of application modules that are eligible when populating a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
A module can be any string. If a module is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A module string is not scanned for correctness. During workload collection, if a SQL statement's module does not match a name in the module list, it will not be processed by the operation. A module name is case sensitive. The possible values are:
The default value is |
VALID_SQLSTRING_LIST |
STRINGLIST |
Contains a fully qualified list of text strings that are eligible when populating a SQL workload object. The list elements are comma-delimited, and quoted values are supported.
A SQL string can be any string. If a string is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A SQL string is not scanned for correctness. During workload collection, if a SQL statement does not contain a string in the SQL string list, it will not be processed by the operation. The possible values are:
The default value is |
VALID_TABLE_LIST |
TABLELIST |
Contains a fully qualified list of tables that are eligible for tuning. The list elements are comma-delimited, and quoted identifiers are supported. Wildcard specifications are supported for tables. The default value is all tables within the user's scope are eligible for tuning. The supported wildcard character is % . A % wildcard matches any set of consecutive characters.
When a SQL statement is processed, it will not be accepted unless at least one referenced table is specified in the valid table list. If the list is unused, then all table references within a SQL statement are considered valid. When using the The valid syntax for a table reference is:
The possible values are:
The default value is |
VALID_USERNAME_LIST |
STRINGLIST |
Contains a fully qualified list of usernames that are eligible when populating a SQL workload object. The list of elements is comma-delimited, and quoted names are supported.
During workload collection, if a SQL statement's username does not match a name in the username list, it will not be processed by the operation. A username is not case sensitive unless it is quoted. The possible values are:
The default value is |
Examples
DECLARE workload_name VARCHAR2(30); BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.SET_SQLWKLD_PARAMETER(workload_name, 'VALID_TABLE_LIST','SH.%'); END; /
This procedure modifies a user parameter within an Advisor task or a template. A user parameter is a simple variable that stores various attributes that affect workload collection, tuning decisions and reporting.
Syntax
DBMS_ADVISOR.SET_TASK_PARAMETER ( task_name IN VARCHAR2 parameter IN VARCHAR2, value IN VARCHAR2); DBMS_ADVISOR.SET_TASK_PARAMETER ( task_name IN VARCHAR2 parameter IN VARCHAR2, value IN NUMBER);
Parameters
Table 12-32 SET_TASK_PARAMETER Procedure Parameters
Parameter | Description |
---|---|
task_name |
The Advisor task name that uniquely identifies an existing task. |
parameter |
The name of the task parameter to be modified. Parameter names are not case sensitive. Parameter names are unique to the task type, but not necessarily unique to all task types. Various task types may use the same parameter name for different purposes. |
value |
The value of the specified task parameter. The value can be specified as a string or a number. If the value is DEFAULT , the value will be reset to the default value. |
Usage Notes
A task cannot be modified unless it is in its initial state. See "RESET_TASK Procedure" to set a task to its initial state. See your Advisor-specific documentation for further information on using this procedure.
SQL Access Advisor Task Parameters
Table 12-33 lists SQL Access Advisor task parameters.
Table 12-33 SQL Access Advisor Task Parameters
Parameter | Datatype | Description |
---|---|---|
ACTION_LIST |
STRINGLIST |
Use VALID_ACTION_LIST instead.
Contains a fully qualified list of actions that are eligible for processing in a SQL Workload object. The list elements are comma-delimited, and quoted names are supported. An action can be any string. If an action is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. An action string is not scanned for correctness. During a task execution, if a SQL statement's action does not match a name in the action list, it will not be processed by the task. An action name is case sensitive. The possible values are:
The default value is |
COMMENTED_FILTER_LIST |
NUMBER |
Use INVALID_SQLSTRING_LIST instead.
Comma-delimited list of strings. When set, the SQL Access Advisor will filter out any SQL statement that contain any of the specified strings in the first 20 characters of its text. |
CREATION_COST |
STRING |
When set to true (default), the SQL Access Advisor will weigh the cost of creation of the access structure (index or materialized view) against the frequency of the query and potential improvement in the query execution time. When set to false , the cost of creation is ignored. |
DAYS_TO_EXPIRE |
NUMBER |
Specifies the expiration time in days for the current SQL Access Advisor task. The value is relative to the last modification date. Once the task expires, it will become a candidate for removal by an automatic purge operation.
Specifies the expiration time in days for the current Access Advisor task. The value is relative to the last modification date. Once the task expires, it becomes a candidate for removal by an automatic purge operation. The possible values are:
The default value is 30. |
DEF_INDEX_OWNER |
STRING |
Specifies the default owner for new index recommendations. When a script is created, this value will be used to qualify the index name.
Possible values are:
The default value is |
DEF_INDEX_TABLESPACE |
STRING |
Specifies the default tablespace for new index recommendations. When a script is created, this value will be used to specify a tablespace clause.
Possible values are:
The default value is |
DEF_MVIEW_OWNER |
STRING |
Specifies the default owner for new materialized view recommendations. When a script is created, this value will be used to qualify the materialized view name.
Possible values are:
The default value is |
DEF_MVIEW_TABLESPACE |
STRING |
Specifies the default tablespace for new materialized view recommendations. When a script is created, this value will be used to specify a tablespace clause.
Possible values are
The default value is |
DEF_MVLOG_TABLSPACE |
STRING |
Specifies the default tablespace for new materialized view log recommendations. When a script is created, this value will be used to specify a tablespace clause.
Possible values are:
The default value is |
DML_VOLATILITY |
STRING |
When set to TRUE , the SQL Access Advisor will consider the impact of index maintenance and materialized view refresh in determining the recommendations. It will limit the access structure recommendations involving columns or tables that are frequently updated. For example, if there are too many DMLs on a column, it may favor a Btree index over a bitmap index on that column. For this process to be effective, the workload must include DML (insert/update/delete/merge/direct path inserts) statements that represent the update behavior of the application.
See the related parameter |
END_TIME |
STRING |
Specifies an end time for selecting SQL statements. If the statement did not execute on or before the specified time, it will not be processed.
Each date must be in the standard Oracle form of MM-DD-YYY HH24:MI:SS, where:
|
EVALUATION_ONLY |
STRING |
If set to TRUE , causes SQL Access Advisor to analyze the workload, but only comment on how well the current configuration is supporting it. No tuning recommendations will be generated.
Possible values are:
The default value is |
EXECUTION_TYPE |
STRINGLIST |
The type of recommendations that is desired. Possible values:
The default value is |
IMPLEMENT_EXIT_ON_ERROR |
STRING |
When performing an IMPLEMENT_TASK operation, this parameter will control behavior when an action fails to implement. If set to TRUE , IMPLEMENT_TASK will stop on the first unexpected error.
The possible values are:
The default value is |
INDEX_NAME_TEMPLATE |
STRING |
Specifies the method by which new index names are formed.
If the TASK_ID is omitted from the template, names generated by two concurrently executing SQL Access Advisor tasks may conflict and cause undesirable effects. So it is recommended that you include the TASK_ID in the template. Once formatted, the maximum size of a name is 30 characters. Valid keywords are:
The default template is < |
INVALID_ACTION_LIST |
STRINGLIST |
Contains a fully qualified list of actions that are not eligible for processing in a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
An action can be any string. If an action is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. An action string is not scanned for correctness. During a task execution, if a SQL statement's action matches a name in the action list, it will not be processed by the task. An action name is case sensitive. The possible values are:
The default value is |
INVALID_MODULE_LIST |
STRINGLIST |
Contains a fully qualified list of modules that are not eligible for processing in a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
A module can be any string. If a module is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A module string is not scanned for correctness. During a task execution, if a SQL statement's module matches a name in the list, it will not be processed by the task. A module name is case sensitive. The possible values are:
The default value is |
INVALID_SQLSTRING_LIST |
STRINGLIST |
Contains a fully qualified list of text strings that are not eligible for processing in a SQL workload object. The list elements are comma-delimited, and quoted values are supported.
A SQL string can be any string. If a string is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A SQL string is not scanned for correctness. During a task execution, if a SQL statement contains a string in the SQL string list, it will not be processed by the task. The possible values are:
The default value is |
INVALID_USERNAME_LIST |
STRINGLIST |
Contains a fully qualified list of usernames that are not eligible for processing in a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
During a task execution, if a SQL statement's username matches a name in the username list, it will not be processed by the task. A username is not case sensitive unless it is quoted. The possible values are:
The default value is |
JOURNALING |
NUMBER |
Controls the logging of messages to the journal (USER_ADVISOR_JOURNAL view). The higher the setting, the more information is logged to the journal.
Valid settings are:
|
MODE |
STRING |
Specifies the mode by which Access Advisor will operate during an analysis.
Valid values are:
The default value is |
MODULE_LIST |
STRINGLIST |
Use VALID_MODULE_LIST instead.
Contains a fully qualified list of application modules that are eligible for processing in a SQL Workload object. The list elements are comma-delimited, and quoted names are supported. A module can be any string. If a module is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A module string is not scanned for correctness. During a workload import operation, if a SQL statement's application module does not match a name in the module list, it will not be stored in the workload object. Possible values are:
The default value is |
MVIEW_NAME_TEMPLATE |
STRING |
Specifies the method by which new materialized view names are formed.
If the TASK_ID is omitted from the template, names generated by two concurrently executing SQL Access Advisor tasks may conflict and cause undesirable effects. So it is recommended that you include the TASK_ID in the template. The format is any combination of keyword tokens and literals. However, once formatted, the maximum size of a name is 30 characters. Valid tokens are:
The default template is: |
ORDER_LIST |
STRINGLIST |
Contains the primary natural order in which the Access Advisor processes workload elements during the analysis operation. To determine absolute natural order, Access Advisor sorts the workload using ORDER_LIST values. A comma must separate multiple order keys.
Possible values are:
All values are accessed in descending order, where a high value is considered more interesting than a low value. The default value is |
RECOMMEND_MV_EXACT_TEXT_MATCH |
STRING |
When considering candidate materialized views, exact text match solutions will only be included if this parameter contains TRUE .
The possible values are:
The default value is |
REFRESH_MODE |
STRING |
Specifies whether materialized views are refreshed ON_DEMAND or ON_COMMIT . This will be used to weigh the impact of materialized view refresh when the parameter dml_volatility is set to TRUE .
Possible values are:
The default value is |
REPORT_DATE_FORMAT |
STRING |
This is the default date and time formatting template. The default format is DD/MM/YYYYHH24:MI . |
SHOW_RETAINS |
STRING |
Controls the display of RETAIN actions within an implementation script and the SQL Access Advisor wizard.
The possible values are:
The default value is |
SQL_LIMIT |
NUMBER |
Specifies the number of SQL statements to be analyzed. The SQL_LIMIT filter is applied after all other filters have been applied. For example, if only statements referencing the table foo.bar are to be accepted, the SQL_LIMIT value will be only apply to those statements.
When used in conjunction with the parameter The possible values are:
The default value is |
START_TIME |
STRING |
Specifies a start time for selecting SQL statements. If the statement did not execute on or before the specified time, it will not be processed.
Each date must be in the standard Oracle form of MM-DD-YYY HH24:MI:SS, where:
|
STORAGE_CHANGE |
NUMBER |
Contains the amount of space adjustment that can be consumed by SQL Access Advisor recommendations. Zero or negative values are only permitted if the workload scope is marked as FULL .
When the SQL Access Advisor produces a set of recommendations, the resultant physical structures must be able to fit into the budgeted space. A space budget is computed by adding the Possible values:
The default value is |
USERNAME_LIST |
STRINGLIST |
Use VALID_USERNAME_LIST instead.
Contains a fully qualified list of usernames that are eligible for processing in a workload object. The list elements are comma-delimited, and quoted names are supported. During a task execution, if a SQL statement's username does not match a name in the username list, it will not be processed by the task. A username is not case sensitive unless it is quoted. Possible values:
The default value is |
VALID_ACTION_LIST |
STRINGLIST |
Contains a fully qualified list of actions that are eligible for processing in a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
An action can be any string. If an action is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. An action string is not scanned for correctness. During a task execution, if a SQL statement's action does not match a name in the action list, it will not be processed by the task. An action name is case sensitive. The possible values are:
The default value is |
VALID_MODULE_LIST |
STRINGLIST |
Contains a fully qualified list of application modules that are eligible for processing in a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
A module can be any string. If a module is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A module string is not scanned for correctness. During a task execution, if a SQL statement's module does not match a name in the module list, it will not be processed by the task. A module name is case sensitive. The possible values are:
The default value is |
VALID_SQLSTRING_LIST |
STRINGLIST |
Contains a fully qualified list of text strings that are eligible for processing in a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
A SQL string can be any string. If a string is not quoted, it will be changed to uppercase lettering and stripped of leading and trailing spaces. A SQL string is not scanned for correctness. During a task execution, if a SQL statement does not contain string in the SQL string list, it will not be processed by the task. The possible values are:
The default value is |
VALID_TABLE_LIST |
TABLELIST |
Contains a fully qualified list of tables that are eligible for tuning. The list elements are comma-delimited, and quoted identifiers are supported. Wildcard specifications are supported for tables. The default value is all tables within the user's scope are eligible for tuning. Supported wildcard character is % . A % wildcard matches any set of consecutive characters.
When a SQL statement is processed, it will not be accepted unless at least one referenced table is specified in the valid table list. If the list is unused, then all table references within a SQL statement are considered valid. The valid syntax for a table reference is:
The possible values are:
The default value is |
VALID_USERNAME_LIST |
STRINGLIST |
Contains a fully qualified list of usernames that are eligible for processing in a SQL workload object. The list elements are comma-delimited, and quoted names are supported.
During a task execution, if a SQL statement's username does not match a name in the username list, it will not be processed by the task. A username is not case sensitive unless it is quoted. The possible values are:
The default value is |
WORKLOAD_SCOPE |
STRING |
Describes the level of application coverage the workload represents. Possible values are FULL and PARTIAL .
|
Segment Advisor Parameters
Table 12-35 lists the input task parameters that can be set in the Segment Advisor using the SET_TASK_PARAMETER
procedure.
Table 12-34 Segment Advisor Task Parameters
Parameter | Default Value | Possible Values | Description |
---|---|---|---|
MODE |
COMPREHENSIVE |
LIMITED : Analysis restricted to statistics available in Automatic Workload Repository.
|
The data to use for analysis. |
TIME_LIST |
UNLIMITED |
UNLIMITED |
The time limit for which the Advisor should run. Specified in seconds. |
RECOMMEND_ALL |
TRUE |
If set to TRUE , generate recommendations on all segments specified by the user.
If set to |
Whether to generate recommendations for all segments. |
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); BEGIN task_name := 'My Task'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.SET_TASK_PARAMETER(task_name, 'VALID_TABLELIST', 'SH.%,SCOTT.EMP'); END; /
Undo Advisor Task Parameters
Table 12-35 lists the input task parameters that can be set in the Undo Advisor using the SET_TASK_PARAMETER
procedure.
Table 12-35 Undo Advisor Task Parameters
Parameter | Default Value | Possible Values | Description |
---|---|---|---|
TARGET_OBJECTS |
none | UNDO_TBS |
The target object is the undo tablespace of the system. |
START_SNAPSHOT |
none | The valid snapshot numbers in the AWR repository. | The starting time for the system to perform analysis using the snapshot numbers in the AWR repository. |
END_SNAPSHOT |
none | The valid snapshot numbers in the AWR repository. | The ending time for the system to perform analysis using the snapshot numbers in the AWR repository. |
BEGIN_TIME_SEC |
none | Any positive integer. | The number of seconds between the beginning time of the period and now. Describes a period of time for the system to perform analysis. BEGIN_TIME_SEC should be greater than END_TIME_SEC . |
END_TIME_SEC |
none | Any positive integer. | The number of seconds between the ending time of the period and now. END_TIME_SEC should be less than BEGIN_TIME_SEC . |
Examples
DECLARE tname VARCHAR2(30); oid NUMBER; BEGIN DBMS_ADVISOR.CREATE_TASK('Undo Advisor', tid, tname, 'Undo Advisor Task'); DBMS_ADVISOR.CREATE_OBJECT(tname, 'UNDO_TBS', null, null, null, 'null', oid); DBMS_ADVISOR.SET_TASK_PARAMETER(tname, 'TARGET_OBJECTS', oid); DBMS_ADVISOR.SET_TASK_PARAMETER(tname, 'START_SNAPSHOT', 1); DBMS_ADVISOR.SET_TASK_PARAMETER(tname, 'END_SNAPSHOT', 2); DBMS_ADVISOR.EXECUTE_TASK(tname); END; /
Automatic Database Diagnostic Monitor (ADDM) Task Parameters
Table 12-36 lists the input task parameters that can be set in ADDM using the SET_TASK_PARAMETER
procedure.
Table 12-36 ADDM Task Parameters
Parameter | Default | Possible Values | Description |
---|---|---|---|
START_SNAPSHOT |
none | The valid snapshot numbers in the AWR repository. | The starting time for the system to perform analysis using the snapshot numbers in the AWR repository. |
END_SNAPSHOT |
none | The valid snapshot numbers in the AWR repository. | The ending time for the system to perform analysis using the snapshot numbers in the AWR repository. |
DB_ID |
The current database ID. | Not applicable. | The database for START_SNAPSHOT and END_SNAPSHOT . |
INSTANCE |
The current instance ID. | Not applicable. | The instance for START_SNAPSHOT and END_SNAPSHOT . |
DBIO_EXPECTED |
10 milliseconds | System dependent. | The average time to read the database block in microseconds. |
Examples
DECLARE tid NUMBER; BEGIN DBMS_ADVISOR.CREATE_TASK('ADDM', tid, 'ADDM_TEST', 'my test'); DBMS_ADVISOR.SET_TASK_PARAMETER('ADDM_TEST', 'START_SNAPSHOT', '19', - 'END_SNAPSHOT', '26', - 'DB_ID', '155789304', - 'INSTANCE', '1'); DBMS_ADVISOR.EXECUTE_TASK('ADDM_TEST'); END; /
SQL Tuning Advisor Task Parameters
See the DBMS_SQLTUNE package and Oracle Database Performance Tuning Guide for more information.
This procedure shows how to decompose a materialized view into two or more materialized views and to restate the materialized view in a way that is more advantageous for fast refresh and query rewrite. It also shows how to fix materialized view logs and to enable query rewrite.
Syntax
DBMS_ADVISOR.TUNE_MVIEW ( task_name IN OUT VARCHAR2, mv_create_stmt IN [CLOB | VARCHAR2]);
Parameters
Table 12-37 TUNE_MVIEW Procedure Parameters
Parameter | Description |
---|---|
task_name |
The task name for looking up the results in a catalog view. If not specified, the system will generate a name and return. |
mv_create_stmt |
The original materialized view creation statement. |
See Also:
Oracle Database Performance Tuning Guide for more information about using theTUNE_MVIEW
procedureUsage Notes
Executing TUNE_MVIEW
generates two sets of output results: one is for CREATE
implementation and the other is for undoing the CREATE
MATERIALIZED
VIEW
implementation. The output results are accessible through USER_TUNE_MVIEW
and DBA_TUNE_MVIEW
views. You can also use DBMS_ADVISOR.GET_TASK_SCRIPT
and DBMS_ADVISOR.CREATE_FILE
to output the TUNE_MVIEW
results into a script file for later execution.
USER_TUNE_MVIEW and DBA_TUNE_MVIEW Views
These views are to get the result after executing the TUNE_MVIEW
procedure.
Table 12-38 USER_TUNE_MVIEW and DBA_TUNE_MVIEW Views
Column Name | Column Description |
---|---|
OWNER |
The materialized view owner's name. |
TASK_NAME |
The task name as a key to access the set of recommendations |
SCRIPT_TYPE |
Recommendation ID used to indicate the row is for IMPLEMENTATION or UNDO script. |
ACTION_ID |
Action ID used as the command order number. |
STATEMENT |
For TUNE_MVIEW output, this column represents the following statements, and includes statement properties such as REFRESH and REWRITE options:
|
Examples
name VARCHAR2(30); DBMS_ADVISOR.TUNE_MVIEW.(name, 'SELECT AVG(C1) FROM my_fact_table WHERE c10 = 7');
The following is an example to show how to use TUNE_MVIEW
to optimize a CREATE
MATERIALIZED
VIEW
statement:
NAME VARCHAR2(30) := 'my_tune_mview_task'; EXECUTE DBMS_ADVISOR.TUNE_MVIEW (name, 'CREATE MATERIALIZED VIEW MY_MV REFRESH FAST AS SELECT C2, AVG(C1) FROM MY_FACT_TABLE WHERE C10 = 7 GROUP BY C2');
You can view the CREATE
output results by querying USER_TUNE_MVIEW
or DBA_TUNE_MVIEW
as the following example:
SELECT * FROM USER_TUNE_MVIEW WHERE TASK_NAME='my_tune_mview_task' AND SCRIPT_TYPE='CREATE';
Alternatively, you can save the output results in an external script file as in the following example:
CREATE DIRECTORY TUNE_RESULTS AS ''/myscript_dir'' ; GRANT READ, WRITE ON DIRECTORY TUNE_RESULTS TO PUBLIC; EXECUTE DBMS_ADVISOR.CREATE_FILE(DBMS_ADVISOR.GET_TASK_SCRIPT('my_tune_mview_task'), - '/homes/tune','my_tune_mview_create.sql');
The preceding statement will save the CREATE
output results in /myscript_dir/my_tune_mview_create.sql
.
This procedure updates an existing task object. Task objects are typically used as input data for a particular advisor. Segment advice can be generated at the object, segment, or tablespace level.
Syntax
DBMS_ADVISOR.UPDATE_OBJECT ( task_name IN VARCHAR2 object_id IN NUMBER, attr1 IN VARCHAR2 := NULL, attr2 IN VARCHAR2 := NULL, attr3 IN VARCHAR2 := NULL, attr4 IN CLOB := NULL, attr5 IN VARCHAR2 := NULL);
Parameters
Table 12-39 UPDATE_OBJECT Procedure Parameters
Parameter | Description |
---|---|
task_name |
A valid advisor task name that uniquely identifies an existing task. |
object_id |
The advisor-assigned object identifier. |
attr1 |
Advisor-specific data. If set to NULL , there will be no effect on the target object. |
attr2 |
Advisor-specific data. If set to NULL , there will be no effect on the target object. |
attr3 |
Advisor-specific data. If set to NULL , there will be no effect on the target object. |
attr4 |
Advisor-specific data. If set to NULL , there will be no effect on the target object. |
attr5 |
Advisor-specific data. If set to null, there will be no effect on the target object. |
The attribute parameters have different values depending upon the object type. See Oracle Database Administrator's Guide for details regarding these parameters and object types.
Usage Notes
If for the object level, advice is generated on all partitions of the object (if the object is partitioned). The advice is not cascaded to any dependent objects. If for the segment level, advice can be obtained on a single segment, such as the partition or subpartition of a table, index, or lob column. If for a tablespace level, target advice for every segment in the tablespace will be generated.
See Oracle Database Administrator's Guide for further information regarding the Segment Advisor.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); obj_id NUMBER; BEGIN task_name := 'My Task'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_OBJECT (task_name,'SQL',NULL,NULL,NULL, 'SELECT * FROM SH.SALES',obj_id); DBMS_ADVISOR.UPDATE_OBJECT (task_name, obj_id,NULL,NULL,NULL, 'SELECT count(*) FROM SH.SALES'); END; /
This procedure updates the owner, name, and tablespace for a recommendation.
Syntax
DBMS_ADVISOR.UPDATE_REC_ATTRIBUTES ( task_name IN VARCHAR2 rec_id IN NUMBER, action_id IN NUMBER, attribute_name IN VARCHAR2, value IN VARCHAR2);
Parameters
Table 12-40 UPDATE_REC_ATTRIBUTES Procedure Parameters
Parameter | Description |
---|---|
task_name |
The task name that uniquely identifies an existing task. |
rec_id |
The Advisor-generated identifier number that is assigned to the recommendation. |
action_id |
The Advisor-generated action identifier that is assigned to the particular command. |
attribute_name |
Name of the attribute to be changed. The valid values are:
|
value |
Specifies the new value for the recommendation attribute. |
Usage Notes
Recommendation attributes cannot be modified unless the task has successfully executed.
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); workload_name VARCHAR2(30); attribute VARCHAR2(100); BEGIN task_name := 'My Task'; workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_REF(task_name, workload_name); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales WHERE promo_id = 10'); DBMS_ADVISOR.EXECUTE_TASK(task_name); attribute := 'SH'; DBMS_ADVISOR.UPDATE_REC_ATTRIBUTES(task_name, 1, 3, 'OWNER', attribute); END; /
This procedure changes various attributes of a SQL Workload object or template.
Syntax
DBMS_ADVISOR.UPDATE_SQLWKLD_ATTRIBUTES ( workload_name IN VARCHAR2, new_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, read_only IN VARCHAR2 := NULL, is_template IN VARCHAR2 := NULL, how_created IN VARCHAR2 := NULL);
Parameters
Table 12-41 UPDATE_SQLWKLD_ATTRIBUTES Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The workload object name that uniquely identifies an existing workload. |
new_name |
The new workload object name. If the value is NULL or contains the value ADVISOR_UNUSED , the workload will not be renamed. A task name can be up to 30 characters long. |
description |
A new workload description. If the value is NULL or contains the value ADVISOR_UNUSED , the description will not be changed. Names can be up to 256 characters long. |
read_only |
Set to TRUE so it cannot be changed. |
is_template |
TRUE if workload is to be used as a template. |
how_created |
Indicates a source application name that initiated the workload creation. If the value is NULL or contains the value ADVISOR_UNUSED , the source will not be changed. |
Examples
DECLARE workload_name VARCHAR2(30); BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales WHERE promo_id = 10'); DBMS_ADVISOR.UPDATE_SQLWKLD_ATTRIBUTES(workload_name,'New workload name'); END; /
This procedure updates an existing SQL statement in a specified SQL workload.
Syntax
DBMS_ADVISOR.UPDATE_SQLWKLD_STATEMENT ( workload_name IN VARCHAR2, sql_id IN NUMBER, application IN VARCHAR2 := NULL, action IN VARCHAR2 := NULL, priority IN NUMBER := NULL, username IN VARCHAR2 := NULL); DBMS_ADVISOR.UPDATE_SQLWKLD_STATEMENT ( workload_name IN VARCHAR2, search IN VARCHAR2, updated OUT NUMBER, application IN VARCHAR2 := NULL, action IN VARCHAR2 := NULL, priority IN NUMBER := NULL, username IN VARCHAR2 := NULL);
Parameters
Table 12-42 UPDATE_SQLWKLD_STATEMENT Procedure Parameters
Parameter | Description |
---|---|
workload_name |
The SQL Workload object name that uniquely identifies an existing workload. |
sql_id |
The Advisor-generated identifier number that is assigned to the statement. To specify all workload statements, use the constant DBMS_ADVISOR.ADVISOR_ALL . |
updated |
Returns the number of statements changed by a searched update. |
application |
Specifies a business application name that will be associated with the SQL statement. If the value is NULL or contains the value ADVISOR_UNUSED , then the column will not be updated in the repository. |
action |
Specifies the application action for the statement. If the value is NULL or contains the value ADVISOR_UNUSED , then the column will not be updated in the repository. |
priority |
The relative priority of the SQL statement. The value must be one of the following: 1 - HIGH , 2 - MEDIUM , or 3 - LOW .
If the value is |
username |
The Oracle user name that executed the SQL statement. If the value is NULL or contains the value ADVISOR_UNUSED , then the column will not be updated in the repository.
Because a username is an Oracle identifier, the username value must be entered exactly like it is stored in the server. For example, if the user |
search |
Disabled. |
Usage Notes
A workload cannot be modified or deleted if it is currently referenced by an active task. A task is considered active if it is not in its initial state. See "RESET_TASK Procedure" to set a task to its initial state.
Examples
DECLARE workload_name VARCHAR2(30); updated NUMBER; id NUMBER; BEGIN workload_name := 'My Workload'; DBMS_ADVISOR.CREATE_SQLWKLD(workload_name, 'My Workload'); DBMS_ADVISOR.ADD_SQLWKLD_STATEMENT(workload_name, 'MONTHLY', 'ROLLUP', 100,400,5041,103,640445,680000,2, 1,SYSDATE,1,'SH','SELECT AVG(amount_sold) FROM sh.sales WHERE promo_id = 10'); SELECT sql_id INTO id FROM USER_ADVISOR_SQLW_STMTS WHERE workload_name = 'My Workload'; DBMS_ADVISOR.UPDATE_SQLWKLD_STATEMENT(workload_name, id); END; /
This procedure changes various attributes of a task or a task template.
Syntax
DBMS_ADVISOR.UPDATE_TASK_ATTRIBUTES ( task_name IN VARCHAR2 new_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, read_only IN VARCHAR2 := NULL, is_template IN VARCHAR2 := NULL, how_created IN VARCHAR2 := NULL);
Parameters
Table 12-43 UPDATE_TASK_ATTRIBUTES Procedure Parameters
Parameter | Description |
---|---|
task_name |
The Advisor task name that uniquely identifies an existing task. |
new_name |
The new Advisor task name. If the value is NULL or contains the value ADVISOR_UNUSED , the task will not be renamed. A task name can be up to 30 characters long. |
description |
A new task description. If the value is NULL or contains the value ADVISOR_UNUSED , the description will not be changed. Names can be up to 256 characters long. |
read_only |
Sets the task to read-only. Possible values are: TRUE and FALSE .
If the value is |
is_template |
Marks the task as a template. Physically, there is no difference between a task and a template; however, a template cannot be executed. Possible values are: TRUE and FALSE . If the value is NULL or contains the value ADVISOR_UNUSED , the setting will not be changed. |
how_created |
Indicates a source application name that initiated the task creation. If the value is NULL or contains the value ADVISOR_UNUSED , the source will not be changed. |
Examples
DECLARE task_id NUMBER; task_name VARCHAR2(30); BEGIN task_name := 'My Task'; DBMS_ADVISOR.CREATE_TASK(DBMS_ADVISOR.SQLACCESS_ADVISOR, task_id, task_name); DBMS_ADVISOR.UPDATE_TASK_ATTRIBUTES(task_name,'New Task Name'); DBMS_ADVISOR.UPDATE_TASK_ATTRIBUTES('New Task Name',NULL,'New description'); END; /