The DBMS_SQLTUNE package is the interface for tuning SQL on demand. The related package DBMS_AUTO_SQLTUNE package provides the interface for SQL Tuning Advisor run as an automated task.
The chapter contains the following topics:
Overview
Security Model
SQL Tuning Advisor Subprograms
SQL Profile Subprograms
SQL Tuning Set Subprograms
SQL Performance Reporting Subprograms
The DBMS_SQLTUNE package provides a number of interrelated areas of functionality:
SQL Tuning Advisor is one of a suite of advisors, a set of expert systems that identifies and helps resolve database performance problems. Specifically, SQL Tuning Advisor automates tuning of problematic SQL statements. It takes one or more SQL statements as input and gives precise advice on how to tune the statements. The advisor provides the advice in the form of SQL actions for tuning the SQL along with their expected performance benefit.
The group of SQL Tuning Advisor Subprograms provide a task-oriented interface that enables you to access the advisor. You can call the following subprograms in the order given to use some of SQL Tuning Advisor's features:
CREATE_TUNING_TASK Functions creates a tuning task for tuning one or more SQL statements.
The EXECUTE_TUNING_TASK Function and Procedure executes a previously created tuning task.
The REPORT_TUNING_TASK Function displays the results of a tuning task.
You use the SCRIPT_TUNING_TASK Function to create a SQL*PLUS script which can then be executed to implement a set of Advisor recommendations
SQL Tuning Advisor may recommend the creation of a SQL profile to improve the performance of a statement. SQL profiles consist of auxiliary statistics specific to the statement. The query optimizer makes estimates about cardinality, selectivity, and cost that can sometimes be off by a significant amount, resulting in poor execution plans. The SQL profile addresses this problem by collecting additional information using sampling and partial execution techniques to adjust these estimates.
The group of SQL Profile Subprograms provides a mechanism for delivering statistics to the optimizer that targets one particular SQL statement, and helps the optimizer make good decisions for that statement by giving it the most accurate statistical information possible. For example:
You can use the ACCEPT_SQL_PROFILE Procedure and Function to accept a SQL profile recommended by SQL Tuning Advisor.
You can alter the STATUS, NAME, DESCRIPTION, and CATEGORY attributes of an existing SQL profile with the ALTER_SQL_PROFILE Procedure.
You can drop a SQL profile with the DROP_SQL_PROFILE Procedure.
SQL Tuning Advisor input can be a single SQL statement or a set of statements. When tuning multiple statements in one advisor task, you give the input in the form of a SQL tuning set (STS). A SQL tuning set is a database object that stores SQL statements along with their execution context in a system-provided schema. SQL tuning sets provide an infrastructure for dealing with SQL workloads and simplify tuning of a large number of SQL statements.
SQL tuning sets store SQL statements along with
The execution context, such as the parsing schema name and bind values
Execution statistics such as average elapsed time and execution count
Execution plans - which are the sequence of operations Oracle performs to run SQL statements
Row source statistics such as the number of rows processed for each operation executed within the plan
SQL tuning sets can be created by filtering or ranking SQL statements from several sources:
The shared SQL area using the SELECT_CURSOR_CACHE Function
Top SQL statements from the Automatic Workload Repository using the SELECT_WORKLOAD_REPOSITORY Function
Other SQL tuning sets using the SELECT_SQLSET Function
SQL Performance Analyzer task comparison results using the SELECT_SQLPA_TASK Function
SQL Trace files using the SELECT_SQL_TRACE Function
A user-defined workload
The complete group of SQL Tuning Set Subprograms facilitates this functionality. As examples:
The CREATE_SQLSET Procedure and Function creates a SQL tuning set object in the database.
The LOAD_SQLSET Procedure populates the SQL tuning set with a set of selected SQL.
The CAPTURE_CURSOR_CACHE_SQLSET Procedure collects SQL statements from the shared SQL area over a specified time interval, attempting to build a realistic picture of database workload.
Import/Export SQL Tuning Sets and SQL Profiles
Use DBMS_SQLTUNE subprograms to move SQL profiles and SQL tuning sets from one system to another using a common programmatic model. In both cases, you create a staging table on the source database and populate this staging table with the relevant data. You then move that staging table to the destination system following the method of your choice (such as Oracle Data Pump, or a database link), where it is used to reconstitute the objects in their original form. The following steps are implemented by means of subprograms included in this package:
To create the staging table on the source system, call the CREATE_STGTAB_SQLPROF Procedure or the CREATE_STGTAB_SQLSET Procedure.
To populate the staging table with information from the source system, call the PACK_STGTAB_SQLPROF Procedure or PACK_STGTAB_SQLSET Procedure.
Move the staging table to the destination system.
To re-create the object on the new system, call the UNPACK_STGTAB_SQLPROF Procedure or the UNPACK_STGTAB_SQLSET Procedure.
See Also:
Oracle Database SQL Tuning Guide for more information about programmatic flowAutomatic Tuning Task Functions
The automated system task SYS_AUTO_SQL_TUNING_TASK is created by the database as part of the catalog scripts. This task automatically chooses a set of high-load SQL from AWR and runs SQL Tuning Advisor on this SQL. The automated task performs the same comprehensive analysis as any other SQL Tuning task.
You can obtain a report on the activity of the Automatic SQL Tuning task through the DBMS_AUTO_SQLTUNE.REPORT_AUTO_TUNING_TASK API. See the DBMS_AUTO_SQLTUNE package for the list of subprograms that you can use to manage the automated SQL tuning task.
See Also:
Using DBMS_AUTO_SQLTUNEReal-time SQL Monitoring enables DBAs or performance analysts to monitor the execution of long-running SQL statements while they are executing. Both cursor statistics (such as CPU times and IO times) and execution plan statistics (such as number of output rows, memory and temp space used) are updated in almost real time during statement execution. The V$SQL_MONITOR and V$SQL_PLAN_MONITOR views expose these statistics. In addition, DBMS_SQLTUNE provides the REPORT_SQL_MONITOR and REPORT_SQL_MONITOR_LIST functions to report monitoring information.
Note:
DBMS_SQL_MONITOR also contains the REPORT_SQL_MONITOR and REPORT_SQL_MONITOR_LIST functions.This package is available to PUBLIC and performs its own security checking:
As SQL Tuning Advisor relies on the advisor framework, all tuning task interfaces (XXX_TUNING_TASK) require privilege ADVISOR.
SQL tuning set subprograms (XXX_SQLSET) require either the ADMINISTER SQL TUNING SET or the ADMINISTER ANY SQL TUNING SET privilege. Users having the ADMINISTER SQL TUNING SET privilege can only create and modify a SQL tuning set they own, while the ADMINISTER ANY SQL TUNING SET privilege allows them to operate upon all SQL tuning sets, even those owned by other users. For example, using the CREATE_SQLSET Procedure and Function you can create a SQL tuning set to be owned by another user. In this case, the user need not necessarily have the ADMINISTER SQL TUNING SET privilege to operate upon her tuning set.
Previously, three different privileges were needed to invoke subprograms concerned with SQL profiles:
CREATE ANY SQL PROFILE
ALTER ANY SQL PROFILE
DROP ANY SQL PROFILE
These have now been deprecated in favor of ADMINISTER SQL MANAGEMENT OBJECT
The DBMS_SQLTUNE package defines the following OBJECT type
The SQLSET_ROW object models the content of a SQL tuning set for the user. Logically, a SQL tuning set is a collection of SQLSET_ROWs where each SQLSET_ROW contains a single SQL statement along with its execution context, statistics, binds, and plan. The SELECT_XXX subprograms each model a data source as a collection of SQLSET_ROWs, unique by (sql_id, plan_hash_value). Similarly, the LOAD_SQLSET procedure takes as input a cursor whose row type is SQLSET_ROW, treating each SQLSET_ROW in isolation according to the policies requested by the user.
Several subprograms in the DBMS_SQLTUNE package accept basic filters on the content of a SQL tuning set or data source. These filters are expressed in terms of the attributes within the SQLSET_ROW as defined.
CREATE TYPE sqlset_row AS object ( sql_id VARCHAR(13), force_matching_signature NUMBER, sql_text CLOB, object_list sql_objects, bind_data RAW(2000), parsing_schema_name VARCHAR2(30), module VARCHAR2(48), action VARCHAR2(32), elapsed_time NUMBER, cpu_time NUMBER, buffer_gets NUMBER, disk_reads NUMBER, direct_writes NUMBER, rows_processed NUMBER, fetches NUMBER, executions NUMBER, end_of_fetch_count NUMBER, optimizer_cost NUMBER, optimizer_env RAW(2000), priority NUMBER, command_type NUMBER, first_load_time VARCHAR2(19), stat_period NUMBER, active_stat_period NUMBER, other CLOB, plan_hash_value NUMBER, sql_plan sql_plan_table_type, bind_list sql_binds)
Table 154-1 SQLSET_ROW Attributes
| Attribute | Description |
|---|---|
|
|
Unique SQL ID |
|
|
Signature with literals, case, and whitespace removed |
|
|
Full text for the statement |
|
|
Currently not implemented |
|
|
Bind data as captured for this SQL. Note that you cannot stipulate an argument for this parameter and also for |
|
|
Schema where the SQL is parsed |
|
|
Last application module for the SQL |
|
|
Last application action for the SQL |
|
|
Sum total elapsed time for this SQL statement |
|
|
Sum total CPU time for this SQL statement |
|
|
Sum total number of buffer gets |
|
|
Sum total number of disk reads |
|
|
Sum total number of direct writes |
|
|
Sum total number of rows processed by this SQL |
|
|
Sum total number of fetches |
|
|
Total executions of this SQL |
|
|
Number of times the statement was fully executed with all of its rows fetched |
|
|
Optimizer cost for this SQL |
|
|
Optimizer environment for this SQL statement |
|
|
User-defined priority (1,2,3) |
|
|
Statement type, such as |
|
|
Load time of parent cursor |
|
|
Period of time (seconds) when the statistics of this SQL statement were collected |
|
|
Effective period of time (in seconds) during which the SQL statement was active |
|
|
Other column for user defined attributes |
|
|
Plan hash value of the plan |
|
|
Explain plan |
|
|
List of user specified binds for SQL This is used for user-specified workloads. Note that you cannot stipulate an argument for this parameter and also for |
DBMS_SQLTUNE subprograms are grouped by function:
This subprogram group provides an interface to manage SQL tuning tasks.
Table 154-2 SQL Tuning Task Subprograms
| Subprogram | Description |
|---|---|
|
Cancels the currently executing tuning task |
|
|
Creates a SQL plan baseline for an existing plan |
|
|
Creates a tuning of a single statement or SQL tuning set for either SQL Tuning Advisor |
|
|
Drops a SQL tuning task |
|
|
Executes a previously created tuning task |
|
|
Implements a set of SQL profile recommendations made by SQL Tuning Advisor |
|
|
Interrupts the currently executing tuning task |
|
|
Displays a report from the automatic tuning task, reporting on a range of executions |
|
|
Displays the results of a tuning task |
|
|
Resets the currently executing tuning task to its initial state |
|
|
Resumes a previously interrupted task that was created to process a SQL tuning set |
|
|
Creates a tuning task and schedules its execution as a scheduler job |
|
|
Creates a SQL*PLUS script which can then be executed to implement a set of SQL Tuning Advisor recommendations |
|
|
Updates the value of a SQL tuning parameter of type |
The Summary of DBMS_SQLTUNE Subprograms contains a complete listing of all subprograms in the package.
This subprogram group provides an interface to manage SQL profiles.
Table 154-3 SQL Profile Subprograms
| Subprogram | Description |
|---|---|
|
Accepts all SQL profiles recommended by a specific execution of a tuning task |
|
|
Creates a SQL profile for the specified tuning task |
|
|
Alters specific attributes of an existing SQL profile object |
|
|
Creates the staging table used for copying SQL profiles from one system to another |
|
|
Drops the named SQL profile from the database |
|
|
Moves profile data out of the |
|
|
Changes the profile data values kept in the staging table prior to performing an unpack operation |
|
|
Returns a SQL text's signature |
|
|
Uses the profile data stored in the staging table to create profiles on this system |
The Summary of DBMS_SQLTUNE Subprograms contains a complete listing of all subprograms in the package.
This subprogram group provides an interface to manage SQL tuning sets.
Table 154-4 SQL Tuning Set Subprograms
| Subprogram | Description |
|---|---|
|
Adds a new reference to an existing SQL tuning set to indicate its use by a client |
|
|
Over a specified time interval incrementally captures a workload from the shared SQL area into a SQL tuning set |
|
|
Creates a SQL tuning set object in the database |
|
|
Creates a staging table through which SQL Tuning Sets are imported and exported |
|
|
Deletes a set of SQL statements from a SQL tuning set |
|
|
Drops a SQL tuning set if it is not active |
|
|
Populates the SQL tuning set with a set of selected SQL |
|
|
Copies tuning sets out of the |
|
|
Deactivates a SQL tuning set to indicate it is no longer used by the client |
|
|
Collects SQL statements from the shared SQL area |
|
|
Reads the content of one or more trace files and returns the SQL statements it finds in the format of |
|
|
Collects SQL statements from a SQL performance analyzer comparison task |
|
|
Collects SQL statements from an existing SQL tuning set |
|
|
Collects SQL statements from the workload repository |
|
|
Copies one or more SQL tuning sets from the staging table |
|
|
Updates whether selected string fields for a SQL statement in a SQL tuning set or the set numerical attributes of a SQL in a SQL tuning set |
The Summary of DBMS_SQLTUNE Subprograms contains a complete listing of all subprograms in the package.
This subprogram group provides function to report on monitoring data collected in V$SQL_MONITOR and V$SQL_PLAN_MONITOR.
Table 154-7 DBMS_SQLTUNE Package Subprograms
| Subprogram | Description | Group |
|---|---|---|
|
Accepts all SQL profiles recommended by a particular execution of a particular tuning task |
||
|
Creates a SQL profile for the specified tuning task |
||
|
Adds a new reference to an existing SQL tuning set to indicate its use by a client |
||
|
Alters specific attributes of an existing SQL profile object |
||
|
Cancels the currently executing tuning task |
||
|
Over a specified time interval incrementally captures a workload from the shared SQL area into a SQL tuning set |
||
|
Creates a SQL plan baseline for an existing plan |
||
|
Creates a SQL tuning set object in the database |
||
|
Creates the staging table used for copying SQL profiles from one system to another |
||
|
Creates a staging table through which SQL tuning sets are imported and exported |
||
|
Creates a tuning of a single statement or SQL tuning set for either SQL Tuning Advisor |
||
|
Deletes a set of SQL statements from a SQL tuning set |
||
|
Drops the named SQL profile from the database |
||
|
Drops a SQL tuning set if it is not active |
||
|
Drops a SQL tuning task |
||
|
Executes a previously created tuning task |
||
|
implements a set of SQL profile recommendations made by SQL Tuning Advisor |
||
|
Interrupts the currently executing tuning task |
||
|
Populates the SQL tuning set with a set of selected SQL |
||
|
Moves profile data out of the |
||
|
Moves tuning sets out of the |
||
|
Changes the profile data values kept in the staging table prior to performing an unpack operation |
||
|
Changes the tuning set names and owners in the staging table so that they can be unpacked with different values than they had on the host system |
||
|
Deactivates a SQL tuning set to indicate it is no longer used by the client |
||
|
Displays a report from the automatic tuning task, reporting on a range of subtasks |
||
|
Reports on a specific SQLID |
||
|
Displays the results of a tuning task |
||
|
Resets the currently executing tuning task to its initial state |
||
|
Resumes a previously interrupted task that was created to process a SQL tuning set |
||
|
Creates a SQL tuning task and schedule its execution as a scheduler job |
||
|
Creates a SQL*PLUS script which can then be executed to implement a set of SQL Tuning Advisor recommendations |
||
|
Collects SQL statements from the shared SQL area |
||
|
Reads the content of one or more trace files and returns the SQL statements it finds in the format of |
||
|
Collects SQL statements from an existing SQL tuning set |
||
|
Collects SQL statements from the workload repository |
||
|
Updates the value of a SQL tuning parameter of type |
||
|
Returns a SQL text's signature |
||
|
Uses the profile data stored in the staging table to create profiles on this system |
||
|
Moves one or more SQL tuning sets from the staging table |
||
|
Updates selected fields for a SQL statement in a SQL tuning set |
This procedure accepts all SQL profiles recommended by a specific execution of a tuning task, and sets the attributes of the SQL profiles according to the parameter values passed by the user.
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.ACCEPT_ALL_SQL_PROFILES ( task_name IN VARCHAR2, category IN VARCHAR2 := NULL, replace IN BOOLEAN := FALSE, force_match IN BOOLEAN := FALSE, profile_type IN VARCHAR2 := REGULAR_PROFILE, autotune_period IN NUMBER := NULL, execution_name IN VARCHAR2 := NULL, task_owner IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL);
Table 154-8 ACCEPT_ALL_SQL_PROFILES Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The (mandatory) name of the SQL tuning task |
|
|
This is the category name which must match the value of the |
|
|
If the profile already exists, it is replaced if this argument is |
|
|
If If |
|
|
Options:
|
|
|
The time period for the automatic SQL tuning. This setting applies only to the automatic SQL Tuning Advisor task. Possible values are as follows:
The procedure interprets any other value as the time of the most recent task execution minus the value of this argument. |
|
|
Name of the task execution to use. If null, then the procedure generates the report for the most recent task execution. |
|
|
Owner of the tuning task. This is an optional parameter that must be specified to accept a SQL profile associated to a tuning task owned by another user. The current user is the default value. |
|
|
A user specified string describing the purpose of the SQL profile. The description is truncated if longer than 256 characters. The maximum size is 500 characters. |
This procedure creates a SQL profile recommended by SQL Tuning Advisor. The SQL text is normalized for matching purposes though it is stored in the data dictionary in de-normalized form for readability. SQL text is provided through a reference to the SQL Tuning task. If the referenced SQL statement doesn't exist, an error is reported.
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.ACCEPT_SQL_PROFILE ( task_name IN VARCHAR2, object_id IN NUMBER := NULL, name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, category IN VARCHAR2 := NULL); task_owner IN VARCHAR2 := NULL, replace IN BOOLEAN := FALSE, force_match IN BOOLEAN := FALSE, profile_type IN VARCHAR2 := REGULAR_PROFILE);
DBMS_SQLTUNE.ACCEPT_SQL_PROFILE ( task_name IN VARCHAR2, object_id IN NUMBER := NULL, name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, category IN VARCHAR2 := NULL; task_owner IN VARCHAR2 := NULL, replace IN BOOLEAN := FALSE, force_match IN BOOLEAN := FALSE, profile_type IN VARCHAR2 := REGULAR_PROFILE) RETURN VARCHAR2;
Table 154-9 ACCEPT_SQL_PROFILE Procedure and Function Parameters
| Parameter | Description |
|---|---|
|
|
The (mandatory) name of the SQL tuning task |
|
|
The identifier of the advisor framework object representing the SQL statement associated with the tuning task |
|
|
The name of the SQL profile. It cannot contain double quotation marks. The name is case sensitive. If not specified, the system generates a unique name for the SQL profile. |
|
|
A user specified string describing the purpose of the SQL profile. The description is truncated if longer than 256 characters. The maximum size is 500 characters. |
|
|
This is the category name which must match the value of the |
|
|
Owner of the tuning task. This is an optional parameter that has to be specified to accept a SQL profile associated to a tuning task owned by another user. The current user is the default value. |
|
|
If the profile already exists, it is replaced if this argument is |
|
|
If If |
|
|
Options:
|
You use both the procedure and the function versions of the subprogram in the same way except you must specify a return value to invoke the function. Here we give examples of the procedure only.
In this example, you tune a single SQL statement form the workload repository and you create the SQL profile recommended by SQL Tuning Advisor.
variable stmt_task VARCHAR2(64); variable sts_task VARCHAR2(64); -- create a tuning task tune the statement EXEC :stmt_task := DBMS_SQLTUNE.CREATE_TUNING_TASK( begin_snap => 1, - end_snap => 2, - sql_id => 'ay1m3ssvtrh24'); -- execute the resulting task EXEC DBMS_SQLTUNE.EXECUTE_TUNING_TASK(:stmt_task); EXEC DBMS_SQLTUNE.ACCEPT_SQL_PROFILE(:stmt_task);
Note that you do not have to specify the ID (that is, object_id) for the advisor framework object created by SQL Tuning Advisor to represent the tuned SQL statement.
You might also want to accept the recommended SQL profile in a different category, (for example, TEST), so that it is not used by default.
EXEC DBMS_SQLTUNE.ACCEPT_SQL_PROFILE ( task_name => :stmt_task, - category => 'TEST');
You can use command ALTER SESSION SET SQLTUNE_CATEGORY = 'TEST' to see how this profile behaves.
The following call creates a SQL profile that targets any SQL statement with the same force_matching_signature as the tuned statement.
EXEC DBMS_SQLTUNE.ACCEPT_SQL_PROFILE (task_name => :stmt_task, -
force_match => TRUE);
In the following example, you tune a SQL tuning set, and you create a SQL profile for only one of the SQL statements in the SQL tuning set. The SQL statement is represented by an advisor framework object with ID equal to '5'. Please notice that you must pass an object id to the ACCEPT_SQL_PROFILE procedure because there are potentially many SQL profiles for the tuning task. This object id is given along with the report.
EXEC :sts_task := DBMS_SQLTUNE.CREATE_TUNING_TASK ( - sqlset_name => 'my_workload', - rank1 => 'ELAPSED_TIME', - time_limit => 3600, - description => 'my workload ordered by elapsed time'); -- execute the resulting task EXEC DBMS_SQLTUNE.EXECUTE_TUNING_TASK(:sts_task); -- create the profile for the sql statement corresponding to object_id = 5. EXEC DBMS_SQLTUNE.ACCEPT_SQL_PROFILE ( task_name => :sts_task, - object_id => 5);
This procedure adds a new reference to an existing SQL tuning set to indicate its use by a client.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.ADD_SQLSET_REFERENCE ( sqlset_name IN VARCHAR2, description IN VARCHAR2 := NULL) RETURN NUMBER;
You can add reference to a SQL tuning set. This prevents the tuning set from being modified while it is being used. References are automatically added when you invoke SQL Tuning Advisor on the SQL tuning set, so you should use this function for custom purposes only.The function returns a reference ID that is used to remove it later. You use the REMOVE_SQLSET_REFERENCE Procedure to delete references to a SQL tuning set.
variable rid number;
EXEC :rid := DBMS_SQLTUNE.ADD_SQLSET_REFERENCE( -
sqlset_name => 'my_workload', -
description => 'my sts reference');
You can use the views USER/DBA_SQLSET_REFERENCES to find all references on a given SQL tuning set.
This procedure alters specific attributes of an existing SQL profile object. The following attributes can be altered (using these attribute names):
"STATUS" can be set to "ENABLED" or "DISABLED"
"NAME" can be reset to a valid name which must be a valid Oracle identifier and must be unique.
"DESCRIPTION" can be set to any string of size no more than 500 characters
"CATEGORY" can be reset to a valid category name which must be a valid Oracle identifier and must be unique when combined with normalized SQL text)
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.ALTER_SQL_PROFILE ( name IN VARCHAR2, attribute_name IN VARCHAR2, value IN VARCHAR2);
Table 154-11 ALTER_SQL_PROFILE Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The (mandatory) name of the existing SQL profile to alter |
|
|
The (mandatory) attribute name to alter (case insensitive) using valid attribute names |
|
|
The (mandatory) new value of the attribute using valid attribute values |
-- Disable a profile, so it is not be used by any sessions.
EXEC DBMS_SQLTUNE.ALTER_SQL_PROFILE ( name => :pname, -
attribute_name => 'STATUS', -
value => 'DISABLED');
-- Enable it back:
EXEC DBMS_SQLTUNE.ALTER_SQL_PROFILE ( name => :pname, -
attribute_name => 'STATUS', -
value => 'ENABLED');
-- Change the category of the profile so it is used only by sessions
-- with category set to TEST.
-- Use ALTER SESSION SET SQLTUNE_CATEGORY = 'TEST' to see how this profile
-- behaves.
EXEC DBMS_SQLTUNE.ALTER_SQL_PROFILE ( name => :pname, -
attribute_name => 'CATEGORY', -
value => 'TEST');
-- Change it back:
EXEC DBMS_SQLTUNE.ALTER_SQL_PROFILE ( name => :pname, -
attribute_name => 'CATEGORY', -
value => 'DEFAULT');
This procedure cancels the currently executing tuning task. All intermediate result data is deleted.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupOver a specified time interval this procedure incrementally captures a workload from the shared SQL area into a SQL tuning set. The procedure captures a workload from the shared SQL area into a SQL tuning set, polling the cache multiple times over a time period and updating the workload data stored there. It can execute over as long a period as required to capture an entire system workload.
See Also:
SQL Tuning Set Subprograms for other subprograms in this group
DBMS_SQLTUNE.CAPTURE_CURSOR_CACHE_SQLSET (
sqlset_name IN VARCHAR2,
time_limit IN POSITIVE := 1800,
repeat_interval IN POSITIVE := 300,
capture_option IN VARCHAR2 := 'MERGE',
capture_mode IN NUMBER := MODE_REPLACE_OLD_STATS,
basic_filter IN VARCHAR2 := NULL,
sqlset_owner IN VARCHAR2 := NULL,
recursive_sql IN VARCHAR2 := HAS_RECURSIVE_SQL);
Table 154-13 CAPTURE_CURSOR_CACHE_SQLSET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The SQL tuning set name |
|
|
The total amount of time, in seconds, to execute |
|
|
The amount of time, in seconds, to pause between sampling |
|
|
During capture, either insert new statements, update existing statements, or both. ' |
|
|
Capture mode (
|
|
|
Filter to apply to shared SQL area on each sampling (see |
|
|
The owner of the SQL tuning set or |
|
|
Filter that includes recursive SQL in the SQL tuning set ( |
In this example capture takes place over a 30-second period, polling the cache once every five seconds. This captures all statements run during that period but not before or after. If the same statement appears a second time, the process replaces the stored statement with the new occurrence.
Note that in production systems the time limit and repeat interval would be set much higher. You should tune the time_limit and repeat_interval parameters based on the workload time and shared SQL area turnover properties of your system.
EXEC DBMS_SQLTUNE.CAPTURE_CURSOR_CACHE_SQLSET( -
sqlset_name => 'my_workload', -
time_limit => 30, -
repeat_interval => 5);
In the following call you accumulate execution statistics as you go. This option produces an accurate picture of the cumulative activity of each cursor, even across age-outs, but it is more expensive than the previous example.
EXEC DBMS_SQLTUNE.CAPTURE_CURSOR_CACHE_SQLSET( -
sqlset_name => 'my_workload', -
time_limit => 30, -
repeat_interval => 5, -
capture_mode => dbms_sqltune.MODE_ACCUMULATE_STATS);
This call performs a very inexpensive capture where you only insert new statements and do not update their statistics once they have been inserted into the SQL tuning set
EXEC DBMS_SQLTUNE.CAPTURE_CURSOR_CACHE_SQLSET( -
sqlset_name => 'my_workload', -
time_limit => 30, -
repeat_interval => 5, -
capture_option => 'INSERT');
This procedure creates a SQL plan baseline for an execution plan. It can be used in the context of an Alternative Plan Finding made by SQL Tuning Advisor.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupDBMS_SQLTUNE.CREATE_SQL_PLAN_BASELINE ( task_name IN VARCHAR2, object_id IN NUMBER := NULL, plan_hash_value IN NUMBER, owner_name IN VARCHAR2 := NULL);
Table 154-14 CREATE_SQL_PLAN_BASELINE Procedure Parameters
| Parameter | Description |
|---|---|
|
|
Name of the task for which to get a script |
|
|
Object ID to which the SQL corresponds |
|
|
Plan to create plan baseline |
|
|
Owner of the relevant tuning task. Defaults to the current schema owner. |
The procedure creates a SQL tuning set object in the database.
The function causes the system to generate a name for the SQL tuning set.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.CREATE_SQLSET ( sqlset_name IN VARCHAR2, description IN VARCHAR2 := NULL sqlset_owner IN VARCHAR2 := NULL);
DBMS_SQLTUNE.CREATE_SQLSET ( sqlset_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, sqlset_owner IN VARCHAR2 := NULL) RETURN VARCHAR2;
This procedure creates the staging table used for copying SQL profiles from one system to another.
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.CREATE_STGTAB_SQLPROF ( table_name IN VARCHAR2, schema_name IN VARCHAR2 := NULL, tablespace_name IN VARCHAR2 := NULL);
Table 154-16 CREATE_STGTAB_SQLPROF Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The name of the table to create (case-insensitive unless double quoted). Required. |
|
|
The schema to create the table in, or |
|
|
The tablespace to store the staging table within, or |
Call this procedure once before issuing a call to the PACK_STGTAB_SQLPROF Procedure.
This procedure can be called multiple times if you would like to have different SQL profiles in different staging tables.
Note that this is a DDL operation, so it does not occur within a transaction.
This procedure creates a staging table through which SQL tuning sets are imported and exported
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.CREATE_STGTAB_SQLSET ( table_name IN VARCHAR2, schema_name IN VARCHAR2 := NULL, tablespace_name IN VARCHAR2 := NULL, db_version IN NUMBER := NULL);
Table 154-17 CREATE_STGTAB_SQLSET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
Name of the table to create (case-sensitive) |
|
|
Schema in which to create the table in, or |
|
|
Tablespace in which to store the staging table, or |
|
|
Database (DB) version determining the format of the staging table. User can also create an older DB version staging table to export STS to an older DB version. One of the following values:
|
Call this procedure once before issuing a call to the PACK_STGTAB_SQLSET Procedure.
This procedure can be called multiple times if you would like to have different tuning sets in different staging tables.
Note that this is a DDL operation, so it does not occur within a transaction.
Users issuing the call must have permission to CREATE TABLE in the schema provided and the relevant tablespace.
Please note that the staging table contains nested table columns and indexes, so it should not be renamed.
Create a staging table for packing and eventually exporting a SQL tuning sets
EXEC DBMS_SQLTUNE.CREATE_STGTAB_SQLSET(table_name => 'STGTAB_SQLSET');
Create a staging table to pack a SQL tuning set in Oracle Database 10g Release 2 (10.2) format
EXEC DBMS_SQLTUNE.CREATE_STGTAB_SQLSET( table_name => 'STGTAB_SQLSET', db_version => DBMS_SQLTUNE.STS_STGTAB_10_2_VERSION)
Create a staging table to pack a SQL tuning set in Oracle Database 11g Release 1 (11.1) format
EXEC DBMS_SQLTUNE.CREATE_STGTAB_SQLSET( table_name => 'STGTAB_SQLSET', db_version => DBMS_SQLTUNE.STS_STGTAB_11_1_VERSION)
You can use different forms of this function to:
Create a tuning task for a single statement given its text.
Create a tuning task for a single statement from the shared SQL area given its identifier.
Create a tuning task for a single statement from the workload repository given a range of snapshot identifiers.
Create a tuning task for a SQL tuning set.
Create tuning task for a SQL Performance Analyzer
In all cases, the function mainly creates an advisor task and sets its parameters.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupSQL text format:
DBMS_SQLTUNE.CREATE_TUNING_TASK ( sql_text IN CLOB, bind_list IN sql_binds := NULL, user_name IN VARCHAR2 := NULL, scope IN VARCHAR2 := SCOPE_COMPREHENSIVE, time_limit IN NUMBER := TIME_LIMIT_DEFAULT, task_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, con_name IN VARCHAR2 := NULL) RETURN VARCHAR2;
SQL ID format:
DBMS_SQLTUNE.CREATE_TUNING_TASK ( sql_id IN VARCHAR2, plan_hash_value IN NUMBER := NULL, scope IN VARCHAR2 := SCOPE_COMPREHENSIVE, time_limit IN NUMBER := TIME_LIMIT_DEFAULT, task_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, con_name IN VARCHAR2 := NULL) RETURN VARCHAR2;
AWR format:
DBMS_SQLTUNE.CREATE_TUNING_TASK ( begin_snap IN NUMBER, end_snap IN NUMBER, sql_id IN VARCHAR2, plan_hash_value IN NUMBER := NULL, scope IN VARCHAR2 := SCOPE_COMPREHENSIVE, time_limit IN NUMBER := TIME_LIMIT_DEFAULT, task_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, con_name IN VARCHAR2 := NULL) RETURN VARCHAR2;
SQL tuning set format:
DBMS_SQLTUNE.CREATE_TUNING_TASK ( sqlset_name IN VARCHAR2, basic_filter IN VARCHAR2 := NULL, object_filter IN VARCHAR2 := NULL, rank1 IN VARCHAR2 := NULL, rank2 IN VARCHAR2 := NULL, rank3 IN VARCHAR2 := NULL, result_percentage IN NUMBER := NULL, result_limit IN NUMBER := NULL, scope IN VARCHAR2 := SCOPE_COMPREHENSIVE, time_limit IN NUMBER := TIME_LIMIT_DEFAULT, task_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL plan_filter IN VARCHAR2 := 'MAX_ELAPSED_TIME', sqlset_owner IN VARCHAR2 := NULL) RETURN VARCHAR2;
SQL Performance Analyzer format:
DBMS_SQLTUNE.CREATE_TUNING_TASK ( spa_task_name IN VARCHAR2, spa_task_owner IN VARCHAR2 := NULL, spa_compare_exec IN VARCHAR2 := NULL, basic_filter IN VARCHAR2 := NULL, time_limit IN NUMBER := TIME_LIMIT_DEFAULT, task_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL) RETURN VARCHAR2;
Table 154-18 CREATE_TUNING_TASK Function Parameters
| Parameter | Description |
|---|---|
|
|
Text of a SQL statement |
|
|
Begin snapshot identifier |
|
|
End snapshot identifier |
|
|
Identifier of a SQL statement |
|
|
An ordered list of bind values in |
|
|
Hash value of the SQL execution plan |
|
|
SQL tuning set name |
|
|
SQL predicate to filter the SQL from the SQL tuning set |
|
|
Object filter |
|
|
Order-by clause on the selected SQL |
|
|
Percentage on the sum of a ranking measure |
|
|
Top L(imit) SQL from the (filtered/ranked) SQL |
|
|
User name for whom the statement is to be tuned |
|
|
Tuning scope (limited/comprehensive) |
|
|
The maximum duration in seconds for the tuning session |
|
|
Optional tuning task name |
|
|
Description of the SQL tuning session to a maximum of 256 characters. |
|
|
Plan filter. It is applicable when multiple plans (
|
|
|
Owner of the SQL tuning set, or |
|
|
Name of the SQL Performance Analyzer task whose regressions are to be tuned |
|
|
Owner of specified SQL Performance Analyzer task or |
|
|
Execution name of Compare Performance trial of SQL Performance Analyzer task. If |
|
|
Specifies the container for the tuning task. The semantics depend on the function format:
The following statements are true of all function formats:
|
A SQL tuning task name that is unique by user (two different users can give the same name to their advisor tasks).
With regard to the form of this subprogram that takes a SQL tuning set, filters provided to this function are evaluated as part of a SQL run by the current user. As such, they are executed with that user's security privileges and can contain any constructs and subqueries that user can access, but no more.
VARIABLE stmt_task VARCHAR2(64); VARIABLE sts_task VARCHAR2(64); VARIABLE spa_tune_task VARCHAR2(64);
Create Tuning Task with SQL Text Format
EXEC :stmt_task := DBMS_SQLTUNE.CREATE_TUNING_TASK( -
sql_text => 'select quantity_sold from sales s, times t where s.time_id = t.time_id and s.time_id = TO_DATE(''24-NOV-00'')');
Create Tuning Task with SQL ID Format
EXEC :stmt_task := DBMS_SQLTUNE.CREATE_TUNING_TASK(sql_id => 'ay1m3ssvtrh24'); -- tune in limited scope EXEC :stmt_task := DBMS_SQLTUNE.CREATE_TUNING_TASK(sql_id => 'ay1m3ssvtrh24', - scope => 'LIMITED'); -- only give 10 minutes for tuning statement EXEC :stmt_task := DBMS_SQLTUNE.CREATE_TUNING_TASK(sql_id => 'ay1m3ssvtrh24', - time_limit => 600);
Create Tuning Task with AWR Snapshot Format
EXEC :stmt_task := DBMS_SQLTUNE.CREATE_TUNING_TASK(begin_snap => 1, - end_snap => 2, sql_id => 'ay1m3ssvtrh24');
Create Tuning Task with SQL Tuning Set Format
-- First we need to load an STS, then tune it -- Tune our statements in order by buffer gets, time limit of one hour -- the default ranking measure is elapsed time. EXEC :sts_task := DBMS_SQLTUNE.CREATE_TUNING_TASK( - sqlset_name => 'my_workload', - rank1 => 'BUFFER_GETS', - time_limit => 3600, - description => 'tune my workload ordered by buffer gets');
Create Tuning Task with SPA Task Format
-- Tune the SQLs that were reported as having regressed from the compare -- performance execution of the SPA task named task_123 EXEC :spa_tune_task := DBMS_SQLTUNE.CREATE_TUNING_TASK( spa_task_name => 'task_123', spa_task_owner => 'SCOTT', spa_compare_exec => 'exec1');
This procedure deletes a set of SQL statements from a SQL tuning set.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.DELETE_SQLSET ( sqlset_name IN VARCHAR2, basic_filter IN VARCHAR2 := NULL, sqlset_owner IN VARCHAR2 := NULL);
Table 154-19 DELETE_SQLSET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The SQL tuning set name |
|
|
SQL predicate to filter the SQL from the SQL tuning set. This basic filter is used as a where clause on the SQL tuning set content to select a desired subset of SQL from the Tuning Set. |
|
|
The owner of the SQL tuning set, or |
-- Delete all statements in a sql tuning set.
EXEC DBMS_SQLTUNE.DELETE_SQLSET(sqlset_name => 'my_workload');
-- Delete all statements in a sql tuning set which ran for less than a second
EXEC DBMS_SQLTUNE.DELETE_SQLSET(sqlset_name => 'my_workload', -
basic_filter => 'elapsed_time < 1000000');
This procedure drops the named SQL profile from the database.
See Also:
SQL Profile Subprograms for other subprograms in this groupThis procedure drops a SQL tuning set if it is not active.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupThis procedure drops a SQL tuning task. The task and all its result data are deleted.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupThis function and procedure executes a previously created tuning task. Both the function and the procedure run in the context of a new task execution. The difference is that the function version returns that new execution name.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupDBMS_SQLTUNE.EXECUTE_TUNING_TASK ( task_name IN VARCHAR2, execution_name IN VARCHAR2 := NULL, execution_params IN dbms_advisor.argList := NULL, execution_desc IN VARCHAR2 := NULL) RETURN VARCHAR2;
DBMS_SQLTUNE.EXECUTE_TUNING_TASK ( task_name IN VARCHAR2, execution_name IN VARCHAR2 := NULL, execution_params IN dbms_advisor.argList := NULL, execution_desc IN VARCHAR2 := NULL);
Table 154-23 EXECUTE_TUNING_TASK Function & Procedure Parameters
| Parameter | Description |
|---|---|
|
|
Name of the tuning task to execute |
|
|
A name to qualify and identify an execution. If not specified, it is generated by the advisor and returned by function. |
|
|
List of parameters (name, value) for the specified execution. The execution parameters have effect only on the execution for which they are specified. They override the values for the parameters stored in the task (set through the SET_TUNING_TASK_PARAMETER Procedures). |
|
|
A 256-length string describing the execution |
This function implements a set of SQL profile recommendations made by SQL Tuning Advisor. Call this subprogram is equivalent to calling the SCRIPT_TUNING_TASK Function and then running the script.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this group
DBMS_SQLTUNE.IMPLEMENT_TUNING_TASK (
task_name IN VARCHAR2,
rec_type IN VARCHAR2 := REC_TYPE_SQL_PROFILES,
owner_name IN VARCHAR2 := NULL,
execution_name IN VARCHAR2 := NULL);
Table 154-24 IMPLEMENT_TUNING_TASK Function Parameters
| Parameter | Description |
|---|---|
|
|
Name of the tuning task for which to implement recommendations |
|
|
Filter the types of recommendations to implement. Only ' |
|
|
Owner of the relevant tuning task or |
|
|
name of the task execution to use. If |
This procedure interrupts the currently executing tuning task. The task ends its operations as it would at normal exit so that the user can access the intermediate results.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupThis procedure populates the SQL tuning set with a set of selected SQL. You can call the procedure multiple times to add new SQL statements or replace attributes of existing statements.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.LOAD_SQLSET ( sqlset_name IN VARCHAR2, populate_cursor IN sqlset_cursor, load_option IN VARCHAR2 := 'INSERT', update_option IN VARCHAR2 := 'REPLACE', update_condition IN VARCHAR2 := NULL, update_attributes IN VARCHAR2 := NULL, ignore_null IN BOOLEAN := TRUE, commit_rows IN POSITIVE := NULL, sqlset_owner IN VARCHAR2 := NULL);
Table 154-26 LOAD_SQLSET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The SQL tuning set name to populate |
|
|
The cursor reference from which to populate |
|
|
Specifies how the statements are loaded into the SQL tuning set. The possible values are:
|
|
|
Specifies how the existing statements are updated. This parameter is considered only if
|
|
|
Specifies a where clause to execute the update operation. The update is performed only if the specified condition is true. The condition can refer to either the data source or destination. The condition must use the following prefixes to refer to attributes from the source or the destination:
|
|
|
Specifies the list of a SQL statement attributes to update during a merge or update operation.The possible values are:
|
|
|
If |
|
|
If a value is provided, the load commits after each set of that many statements is inserted. If |
|
|
The owner of the SQL tuning set, or the current schema owner or |
This procedure returns an error when sqlset_name is invalid, or a corresponding SQL tuning set does not exist, or the populate_cursor is incorrect and cannot be executed.
Exceptions are also raised when invalid filters are provided. Filters can be invalid either because they don't parse (for example, they refer to attributes not in sqlset_row), or because they violate the user's privileges.
In this example, you create and populate a SQL tuning set with all shared SQL area statements with an elapsed time of 5 seconds or more excluding statements that belong to SYS schema (to simulate an application user workload). You select all attributes of the SQL statements and load them in the tuning set using the default mode, which loads only new statements, since the SQL tuning set is empty.
-- create the tuning set
EXEC DBMS_SQLTUNE.CREATE_SQLSET('my_workload');
-- populate the tuning set from the shared SQL area
DECLARE
cur DBMS_SQLTUNE.SQLSET_CURSOR;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(
DBMS_SQLTUNE.SELECT_CURSOR_CACHE(
'parsing_schema_name <> ''SYS'' AND elapsed_time > 5000000',
NULL, NULL, NULL, NULL, 1, NULL,
'ALL')) P;
DBMS_SQLTUNE.LOAD_SQLSET(sqlset_name => 'my_workload',
populate_cursor => cur);
END;
/
Suppose now you wish to augment this information with what is stored in the workload repository (AWR). You populate the tuning set with 'ACCUMULATE' as your update_option because it is assumed the cursors currently in the cache had aged out since the snapshot was taken.
You omit the elapsed_time filter because it is assumed that any statement captured in AWR is important, but still you throw away the SYS-parsed cursors to avoid recursive SQL.
DECLARE
cur DBMS_SQLTUNE.SQLSET_CURSOR;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(
DBMS_SQLTUNE.SELECT_WORKLOAD_REPOSITORY(1,2,
'parsing_schema_name <> ''SYS''',
NULL, NULL,NULL,NULL,
1,
NULL,
'ALL')) P;
DBMS_SQLTUNE.LOAD_SQLSET(sqlset_name => 'my_workload',
populate_cursor => cur,
Using DBMS_SQLTUNE
load_option => 'MERGE',
update_option => 'ACCUMULATE');
END;
The following example is a simple load that only inserts new statements from the workload repository, skipping existing ones (in the SQL tuning set). Note that 'INSERT' is the default value for the load_option argument of the LOAD_SQLSET procedure.
DECLARE cur sys_refcursor; BEGIN OPEN cur FOR SELECT VALUE(P) FROM table(DBMS_SQLTUNE.SELECT_WORKLOAD_REPOSITORY(1,2)) P; DBMS_SQLTUNE.LOAD_SQLSET(sqlset_name => 'my_workload', populate_cursor => cur); END; /
The next example demonstrates a load with UPDATE option. This updates statements that already exist in the SQL tuning set but does not add new ones. By default, old statistics are replaced by their new values.
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(DBMS_SQLTUNE.SELECT_CURSOR_CACHE) P;
DBMS_SQLTUNE.LOAD_SQLSET(sqlset_name => 'my_workload',
populate_cursor => cur,
load_option => 'UPDATE');
END;
/
This procedure copies profile data from the SYS. schema into the staging table.
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.PACK_STGTAB_SQLPROF ( profile_name IN VARCHAR2 := '%', profile_category IN VARCHAR2 := 'DEFAULT', staging_table_name IN VARCHAR2, staging_schema_owner IN VARCHAR2 := NULL);
Table 154-27 PACK_STGTAB_SQLPROF Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The name of the profile to pack (% wildcards acceptable, case-sensitive) |
|
|
The category to pack profiles from (% wildcards acceptable, case-sensitive) |
|
|
The name of the table to use (case-insensitive unless double quoted). Required. |
|
|
The schema where the table resides, or |
This procedures requires ADMINISTER SQL MANAGEMENT OBJECT privilege and INSERT privilege on the staging table.
Note that this function issues a COMMIT after packing each SQL profile, so if an error is raised mid-execution, clear the staging table by deleting its rows.
Put only those profiles in the DEFAULT category into the staging table. This corresponds to all profiles used by default on this system.
EXEC DBMS_SQLTUNE.PACK_STGTAB_SQLPROF (staging_table_name => 'PROFILE_STGTAB');
This is another example where you put all profiles into the staging table. Note this moves profiles that are not currently being used by default but are in other categories, such as for testing purposes.
EXEC DBMS_SQLTUNE.PACK_STGTAB_SQLPROF (profile_category => '%', -
staging_table_name => 'PROFILE_STGTAB');
This procedure copies one or more SQL tuning sets from their location in the SYS schema to a staging table created by the CREATE_STGTAB_SQLSET Procedure.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.PACK_STGTAB_SQLSET ( sqlset_name IN VARCHAR2, sqlset_owner IN VARCHAR2 := NULL, staging_table_name IN VARCHAR2, staging_schema_owner IN VARCHAR2 := NULL, db_version IN NUMBER := NULL);
Table 154-28 PACK_STGTAB_SQLSET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The name of the SQL tuning set to pack (% wildcards acceptable, case-sensitive) |
|
|
The category from which to pack SQL tuning sets (% wildcards acceptable, case-sensitive) |
|
|
The name of the table to use (case-sensitive) |
|
|
The schema where the table resides, or |
|
|
Database (DB) version determining the format of the staging table. User can also create an older DB version staging table to export STS to an older DB version. One of the following values:
|
This procedure can be called several times to move more than one SQL tuning set. Users can then move the populated staging table to another system using any method, such as a database link or Oracle Data Pump. Users can then call the UNPACK_STGTAB_SQLSET Procedure create the SQL tuning set on the other system.
Note that this function issues a COMMIT after packing each SQL tuning set, so if an error is raised mid-execution, clear the staging table by deleting its rows.
Put all SQL tuning sets on the system in the staging table
-- to create a staging table, see the CREATE_STGTAB_SQLSET Procedure
EXEC DBMS_SQLTUNE.PACK_STGTAB_SQLSET(sqlset_name => '%', -
sqlset_owner => '%', -
staging_table_name => 'STGTAB_SQLSET');
Put only those SQL tuning sets owned by the current user in the staging table
EXEC DBMS_SQLTUNE.PACK_STGTAB_SQLSET( sqlset_name => '%', staging_table_name => 'STGTAB_SQLSET');
Pack a specific SQL tuning set
EXEC DBMS_SQLTUNE.PACK_STGTAB_SQLSET( sqlset_name => 'my_workload', - staging_table_name => 'STGTAB_SQLSET');
EXEC DBMS_SQLTUNE.PACK_STGTAB_SQLSET( sqlset_name => 'workload_subset', - staging_table_name => 'STGTAB_SQLSET');
Pack the STS my_workload to a staging table STGTAB_SQLSET created for Oracle Database 10g Release 2 (10.2)
EXEC DBMS_SQLTUNE.PACK_STGTAB_SQLSET( sqlset_name => 'workload_subset', staging_table_name => 'STGTAB_SQLSET', db_version => DBMS_SQLTUNE.STS_STGTAB_10_2_VERSION);
Pack the STS my_workload to a staging table STGTAB_SQLSET created for Oracle Database 11g Release 1 (11.1)
EXEC DBMS_SQLTUNE.PACK_STGTAB_SQLSET( sqlset_name => 'workload_subset', staging_table_name => 'STGTAB_SQLSET', db_version => DBMS_SQLTUNE.STS_STGTAB_11_1_VERSION);
This procedure allows DBAs to change the profile data values kept in the staging table prior to performing an unpack operation. The procedure can be used to change the category of a profile.It can be used to change the name of a profile if one already exists on the system with the same name.
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.REMAP_STGTAB_SQLPROF ( old_profile_name IN VARCHAR2, new_profile_name IN VARCHAR2 := NULL, new_profile_category IN VARCHAR2 := NULL, staging_table_name IN VARCHAR2, staging_schema_owner IN VARCHAR2 := NULL);
Table 154-29 REMAP_STGTAB_SQLPROF Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The name of the profile to target for a remap operation (case-sensitive) |
|
|
The new name of the profile, or |
|
|
The new category for the profile, or |
|
|
The name of the table on which to perform the remap operation (case-sensitive). Required. |
|
|
The schema where the table resides, or |
Change the name of a profile before we unpack, to avoid conflicts
EXEC DBMS_SQLTUNE.REMAP_STGTAB_SQLPROF(old_profile_name => :pname, -
new_profile_name => 'IMP' || :pname, -
staging_table_name => 'PROFILE_STGTAB');
Change the SQL profile in the staging table to be 'TEST' category before we import it. This way users can test the profile on the new system before it is active.
EXEC DBMS_SQLTUNE.REMAP_STGTAB_SQLPROF(old_profile_name => :pname, -
new_profile_category => 'TEST', -
staging_table_name => 'PROFILE_STGTAB');
This procedure changes the tuning set names and owners in the staging table so that they can be unpacked with different values than they had on the host system.
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.REMAP_STGTAB_SQLSET ( old_sqlset_name IN VARCHAR2, old_sqlset_owner IN VARCHAR2 := NULL, new_sqlset_name IN VARCHAR2 := NULL, new_sqlset_owner IN VARCHAR2 := NULL, staging_table_name IN VARCHAR2, staging_schema_owner IN VARCHAR2 := NULL old_con_dbid IN NUMBER := NULL, new_con_dbid IN NUMBER := NULL); );
Table 154-30 REMAP_STGTAB_SQLSET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The name of the tuning set to target for a remap operation. Wildcards are not supported. |
|
|
The new name of the tuning set owner to target for a remap operation. |
|
|
The new name for the tuning set, or |
|
|
The new owner for the tuning set, or |
|
|
The name of the table on which to perform the remap operation (case-sensitive). |
|
|
The name of staging table owner, or |
|
|
The old container DBID to be remapped to a new container DBID. Specify |
|
|
The new container DBID to replace with the old container DBID. Specify |
You can call this procedure multiple times to remap more than one tuning set name or owner. Note that this procedure only handles one tuning set per call.
-- Change the name of an STS in the staging table before we unpack it.
EXEC DBMS_SQLTUNE.REMAP_STGTAB_SQLSET(old_sqlset_name => 'my_workload', -
old_sqlset_owner => 'SH', -
new_sqlset_name => 'imp_workload', -
staging_table_name => 'STGTAB_SQLSET');
-- Change the owner of an STS in the staging table before we unpack it.
EXEC DBMS_SQLTUNE.REMAP_STGTAB_SQLSET(old_sqlset_name => 'imp_workload', -
old_sqlset_owner => 'SH', -
new_sqlset_owner => 'SYS', -
staging_table_name => 'STGTAB_SQLSET');
This procedure deactivates a SQL tuning set to indicate it is no longer used by the client.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupYou can remove references on a given SQL tuning set when you finish using it and want to make it writable again.
EXEC DBMS_SQLTUNE.REMOVE_SQLSET_REFERENCE( -
sqlset_name => 'my_workload', -
reference_id => :rid);
Use views USER/DBA_SQLSET_REFERENCES to find all references on a given SQL tuning set.
This function displays a report from the automatic tuning task. This function reports on a range of task executions, whereas the REPORT_TUNING_TASK Function reports on a single execution. Note that this function is deprecated with Oracle Database 11g Release 2 (11.2) in favor of DBMS_AUTO_SQLTUNE.REPORT_AUTO_TUNING_TASK.
See Also:
SQL Tuning Set Subprograms for other subprograms in this group
DBMS_SQLTUNE.REPORT_AUTO_TUNING_TASK(
begin_exec IN VARCHAR2 := NULL,
end_exec IN VARCHAR2 := NULL,
type IN VARCHAR2 := TYPE_TEXT,
level IN VARCHAR2 := LEVEL_TYPICAL,
section IN VARCHAR2 := SECTION_ALL,
object_id IN NUMBER := NULL,
result_limit IN NUMBER := NULL)
RETURN CLOB;
Table 154-32 REPORT_AUTO_TUNING_TASK Function Parameters
| Parameter | Description |
|---|---|
|
|
Name of execution from which to begin the report. |
|
|
Name of execution at which to end the report. |
|
|
Type of the report to produce. Possible values are |
|
|
Level of detail in the report:
|
|
|
Optionally limit the report to a single section (
|
|
|
Advisor framework object id that represents a single statement to restrict reporting to. |
|
|
Maximum number of SQL statements to show in the report |
This function builds a report for a specific SQLID. For each SQLID it gives various statistics and details as obtained from the V$ views and AWR.
See Also:
SQL Performance Reporting Subprograms for other subprograms in this groupDBMS_SQLTUNE.REPORT_SQL_DETAIL ( sql_id IN VARCHAR2 DEFAULT NULL, sql_plan_hash_value IN NUMBER DEFAULT NULL, start_time IN DATE DEFAULT NULL, duration IN NUMBER DEFAULT NULL, inst_id IN NUMBER DEFAULT NULL, dbid IN NUMBER DEFAULT NULL, event_detail IN VARCHAR2 DEFAULT 'YES', bucket_max_count IN NUMBER DEFAULT 128, bucket_interval IN NUMBER DEFAULT NULL, top_n IN NUMBER DEFAULT 10, report_level IN VARCHAR2 DEFAULT 'TYPICAL', type IN VARCHAR2 DEFAULT 'ACTIVE') RETURN CLOB;
Table 154-33 REPORT_SQL_DETAIL Function Parameters
| Parameter | Description |
|---|---|
|
|
SQLID for which monitoring information should be displayed. If |
|
|
Displays SQL statistics and details for a specific |
|
|
If specified, shows SQL activity (from |
|
|
Duration of activity in seconds for the report. If |
|
|
Target instance to get SQL details from. If |
|
|
DBID from which to get SQL details. If |
|
|
When set to |
|
|
If specified, this should be the maximum number of histogram buckets created in the report. If not specified, a value of 128 is used. |
|
|
If specified, this represents the exact time interval in seconds, of all histogram buckets. If specified, |
|
|
Controls the number of entries to display per dimension in the top dimensions section. If not specified, a default value of 10 is used. |
|
|
Level of detail for the report, either In addition, individual report sections can also be enabled or disabled by using a +/-
In addition, SQL text can be specified at different levels:
The meanings of the three top-level report levels are:
Only one of these 4 levels can be specified and, if it is, it has to be at the start of the |
|
|
Report format: |
ACTIVE reports have a rich, interactive user interface similar to Enterprise Manager while not requiring any EM installation. The report file built is in HTML format, so it can be interpreted by most modern browsers. The code powering the active report is downloaded transparently by the web browser when the report is first viewed, hence viewing it requires outside connectivity.
The invoker needs the SELECT or READ privilege on the following views:
V$SESSION
DBA_ADVISOR_FINDINGS
V$DATABASE
GV$ASH_INFO
GV$ACTIVE_SESSION_HISTORY
GV$SQLAREA_PLAN_HASH
GV$SQL
DBA_HIST_SNAPSHOT
DBA_HIST_WR_CONTROL
DBA_HIST_ACTIVE_SESS_HISTORY
DBA_HIST_SQLSTAT
DBA_HIST_SQL_BIND_METADATA
DBA_HIST_SQLTEXT
DBA_SQL_PLAN_BASELINES
DBA_SQL_PROFILES
DBA_ADVISOR_TASKS
DBA_SERVICES
DBA_USERS
DBA_OBJECTS
DBA_PROCEDURES
The invoker needs the EXECUTE privilege on the DBMS_XPLAN package.
This function builds a report (text, simple HTML, active HTML, XML) for the monitoring information collected on behalf of the targeted statement execution.
See Also:
Real-Time SQL Monitoring for other subprograms in this groupDBMS_SQLTUNE.REPORT_SQL_MONITOR( sql_id IN VARCHAR2 DEFAULT NULL, dbop_name IN VARCHAR2 DEFAULT NULL, dbop_exec_id IN NUMBER DEFAULT NULL, session_id IN NUMBER DEFAULT NULL, session_serial IN NUMBER DEFAULT NULL, sql_exec_start IN DATE DEFAULT NULL, sql_exec_id IN NUMBER DEFAULT NULL, inst_id IN NUMBER DEFAULT NULL, start_time_filter IN DATE DEFAULT NULL, end_time_filter IN DATE DEFAULT NULL, instance_id_filter IN NUMBER DEFAULT NULL, parallel_filter IN VARCHAR2 DEFAULT NULL, plan_line_filter IN NUMBER DEFAULT NULL, event_detail IN VARCHAR2 DEFAULT 'YES', bucket_max_count IN NUMBER DEFAULT 128, bucket_interval IN NUMBER DEFAULT NULL, base_path IN VARCHAR2 DEFAULT NULL, last_refresh_time IN DATE DEFAULT NULL, report_level IN VARCHAR2 DEFAULT 'TYPICAL', type IN VARCHAR2 DEFAULT 'TEXT', sql_plan_hash_value IN NUMBER DEFAULT NULL) RETURN CLOB;
Table 154-34 REPORT_SQL_MONITOR Function Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
|
|
|
Execution ID for the composite database operation for which monitoring information is displayed. |
|
|
If not |
|
|
In addition to the |
|
|
This parameter, along with |
|
|
This parameter, along with |
|
|
Only considers statements started on the specified instance. Use -1 to target the login instance. |
|
|
If not |
|
|
If not |
|
|
Only applies when the execution runs parallel across multiple Oracle Real Application Cluster (Oracle RAC) instances. This parameter allows to only report the activity of the specified instance. Use a |
|
|
Applies only to parallel execution and allows reporting the activity of only a subset of the processes involved in the parallel execution (Query Coordinator and/or Parallel eXecution servers). The value of this parameter can be:
The following examples show how to target a subset of the parallel processes:
|
|
|
When value is ' |
|
|
If specified, this should be the maximum number of histogram buckets created in the report |
|
|
If specified, this represents the exact time interval in seconds, of all histogram buckets. If specified, |
|
|
URL path for flex HTML resources since flex HTML format is required to access external files (java scripts and the flash SWF file itself) |
|
|
If not
|
|
|
Level of detail for the report, either In addition, individual report sections can also be enabled or disabled by using a +/-
In addition, SQL text can be specified at different levels:
|
|
|
The meanings of the three top-level report levels are:
Only one of these 4 levels can be specified and, if it is, it has to be at the start of the |
|
|
Report format, |
|
|
Target only those SQL executions with the specified |
The target SQL statement for this report can be:
The last SQL monitored by Oracle (this is the default behavior, so there is no need to specify any parameter). The last SQL executed by a specific session and monitored by Oracle. The session is identified by its session id and optionally it serial number. For example, use session_id => USERENV ('SID') for the current session or session_id=>20, session_serial=>103 for session ID 20, serial number 103.The last execution of a specific statement identified by its sql_id.A specific execution of a SQL statement identified by its execution key (sql_id, sql_exec_start and sql_exec_id).
This report produces performance data exposed by several fixed views, listed below. For this reason, the invoker of the report function must have privilege to select data from these fixed views (such as the SELECT_CATALOG role).
GV$SQL_MONITOR
GV$SQL_PLAN_MONITOR
GV$SQL_PLAN
GV$ACTIVE_SESSION_HISTORY
GV$SESSION_LONGOPS
GV$SQL
The bucket_max_count and bucket_interval parameters control the activity histogram. By default, the maximum number of buckets is set to 128 and the RDBMS derives the bucket_interval based on this. The bucket_interval (value is in seconds) is computed such that it is the smallest possible power of 2 value (starting at 1s) without exceeding the maximum number of buckets. For example, if the query has executed for 600s, the RDBMS selects a bucket_interval of 8s (a power of two) given that 600/8 = 74 which is less than 128 buckets maximum. Smaller than 8s would be 4s which would lead to more buckets than the 128 maximum. If bucket_interval is specified, then the RDBMS uses that value instead of deriving it from bucket_max_count.
ACTIVE reports have a rich, interactive user interface similar to Enterprise Manager while not requiring any EM installation. The report file built is in HTML format, so it can be interpreted by most modern browsers. The code powering the active report is downloaded transparently by the web browser when the report is first viewed, hence viewing it requires outside connectivity.
See Also:
Oracle Database SQL Tuning Guide for more information about SQL real-time monitoring.This function builds a report for all or a sub-set of statements monitored by Oracle. For each statement, the subprogram gives key information and associated global statistics.
Use the REPORT_SQL_MONITOR Function to get detail monitoring information for a single SQL statement.
See Also:
Real-Time SQL Monitoring for other subprograms in this groupDBMS_SQLTUNE.REPORT_SQL_MONITOR_LIST( sql_id IN VARCHAR2 DEFAULT NULL, session_id IN NUMBER DEFAULT NULL, session_serial IN NUMBER DEFAULT NULL, inst_id IN NUMBER DEFAULT NULL, active_since_date IN DATE DEFAULT NULL, active_since_sec IN NUMBER DEFAULT NULL, last_refresh_time IN DATE DEFAULT NULL, report_level IN VARCHAR2 DEFAULT 'TYPICAL', auto_refresh IN NUMBER DEFAULT NULL, base_path IN VARCHAR2 DEFAULT NULL, type IN VARCHAR2 DEFAULT 'TEXT') RETURN CLOB;
Table 154-35 REPORT_SQL_MONITOR_LIST Function Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
If not |
|
|
In addition to the |
|
|
Only considers statements started on the specified instance. Use -1 to target the login instance. |
|
|
If not |
|
|
Same as |
|
|
If not |
|
|
Level of detail for the report. The level is one of the following:
|
|
|
Currently non-operational, reserved for future use. |
|
|
URL path for flex HTML resources because flex HTML format is required to access external files (java scripts and the flash SWF file itself). |
|
|
Report format: |
The user tuning this function needs to have privilege to access the following fixed views: GV$SQL_MONITOR and GV$SQL
See Also:
Oracle Database SQL Tuning Guide for more information about SQL real-time monitoring.This procedure displays the results of a tuning task.
See Also:
SQL Performance Reporting Subprograms for other subprograms in this groupDBMS_SQLTUNE.REPORT_TUNING_TASK( task_name IN VARCHAR2, type IN VARCHAR2 := 'TEXT', level IN VARCHAR2 := 'TYPICAL', section IN VARCHAR2 := ALL, object_id IN NUMBER := NULL, result_limit IN NUMBER := NULL, owner_name IN VARCHAR2 := NULL, execution_name IN VARCHAR2 := NULL) RETURN CLOB;
Table 154-36 REPORT_TUNING_TASK Function Parameters
| Parameter | Description |
|---|---|
|
|
Name of the tuning task to report. |
|
|
Type of the report to produce. Possible values are |
|
|
Level of detail in the report:
|
|
|
Optionally limit the report to a single section (
|
|
|
Advisor framework object id that represents a single statement to restrict reporting to. |
|
|
Maximum number of SQL statements to show in the report. |
|
|
Owner of the relevant tuning task. Defaults to the current schema owner. |
|
|
Name of the task execution to use. If |
-- Display the report for a single statement. SELECT DBMS_SQLTUNE.REPORT_TUNING_TASK(:stmt_task) FROM DUAL; -- Display the summary for a SQL tuning set. SELECT DBMS_SQLTUNE.REPORT_TUNING_TASK(:sts_task, 'TEXT', 'TYPICAL', 'SUMMARY') FROM DUAL; -- Display the findings for a specific statement. SELECT DBMS_SQLTUNE.REPORT_TUNING_TASK(:sts_task, 'TEXT', 'TYPICAL','FINDINGS', 5) FROM DUAL;
This procedure is called on a tuning task that is not currently executing to prepare it for re-execution.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupThis procedure resumes a previously interrupted task that was created to process a SQL tuning set.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupTable 154-38 RESUME_TUNING_TASK Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The name of the tuning task to resume. |
|
|
A SQL predicate to filter the SQL from the SQL tuning set. Note that this filter is applied in conjunction with the basic filter (i.e., parameter |
Resuming a single SQL tuning task (a task that was created to tune a single SQL statement as compared to a SQL tuning set) is not supported.
This function creates a tuning task for a single SQL statement and schedules a DBMS_SCHEDULER job to execute the tuning task. One form of the function finds the information about the statement to be tuned in the shared SQL area, whereas the other finds the information in AWR.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupDBMS_SQLTUNE.SCHEDULE_TUNING_TASK( sql_id IN VARCHAR2, plan_hash_value IN NUMBER := NULL, start_date IN TIMESTAMP WITH TIME ZONE := NULL, scope IN VARCHAR2 := SCOPE_COMPREHENSIVE, time_limit IN NUMBER := TIME_LIMIT_DEFAULT, task_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, con_name IN VARCHAR2 := NULL) RETURN VARCHAR2;
DBMS_SQLTUNE.SCHEDULE_TUNING_TASK( begin_snap IN NUMBER, end_snap IN NUMBER, sql_id IN VARCHAR2, plan_hash_value IN NUMBER := NULL, start_date IN TIMESTAMP WITH TIME ZONE := NULL, scope IN VARCHAR2 := SCOPE_COMPREHENSIVE, time_limit IN NUMBER := TIME_LIMIT_DEFAULT, task_name IN VARCHAR2 := NULL, description IN VARCHAR2 := NULL, con_name IN VARCHAR2 := NULL) RETURN VARCHAR2;
Table 154-39 SCHEDULE_TUNING_TASK Function Parameters
| Parameter | Description |
|---|---|
|
|
The beginning snapshot identifier. The range is exclusive, which means that SQL statements in this snapshot ID are not included. |
|
|
The end snapshot identifier. The range is inclusive, which means that SQL statements in this snapshot ID are included. |
|
|
The SQL ID of the statement to be tuned. |
|
|
The plan hash value of the statement to be tuned. For example, the tuning job fetches captured binds for this SQL plan. |
|
|
The date on which the schedule becomes valid. If null, then SQL Tuning Advisor immediately executes the task. |
|
|
The scope of the tuning job: limited, or comprehensive. |
|
|
The maximum duration in seconds for the SQL tuning session. |
|
|
Optional SQL tuning task name. |
|
|
Description of the SQL tuning session. The description can contain a maximum of 256 characters. |
|
|
The container from which SQL Tuning Advisor accesses the SQL statement information. |
A SQL tuning task name that is unique for each user. Multiple users can assign the same name to their advisor tasks.
This function creates a SQL*PLUS script which can then be executed to implement a set of Advisor recommendations.
See Also:
SQL Tuning Advisor Subprograms for other subprograms in this groupDBMS_SQLTUNE.SCRIPT_TUNING_TASK( task_name IN VARCHAR2, rec_type IN VARCHAR2 := REC_TYPE_ALL, object_id IN NUMBER := NULL, result_limit IN NUMNBER := NULL, owner_name IN VARCHAR2 := NULL, execution_name IN VARCHAR2 := NULL) RETURN CLOB;
Table 154-40 SCRIPT_TUNING_TASK Function Parameters
| Parameter | Description |
|---|---|
|
|
Name of the tuning task for which to apply a script |
|
|
Filter the script by types of recommendations to include. Any subset of the following separated by commas: or ' |
|
|
Optionally filters by a single object ID |
|
|
Optionally shows commands for only top n SQL (ordered by |
|
|
Owner of the relevant tuning task. Defaults to the current schema owner |
|
|
Name of the task execution to use. If |
Once the script is returned, it should then by checked by the DBA and executed.
Wrap with a call to DBMS_ADVISOR.CREATE_FILE to put it into a file.
SET LINESIZE 140 -- Get a script for all actions recommended by the task. SELECT DBMS_SQLTUNE.SCRIPT_TUNING_TASK(:stmt_task) FROM DUAL; -- Get a script of just the sql profiles we should create. SELECT DBMS_SQLTUNE.SCRIPT_TUNING_TASK(:stmt_task, 'PROFILES') FROM DUAL; -- get a script of just stale / missing stats SELECT DBMS_SQLTUNE.SCRIPT_TUNING_TASK(:stmt_task, 'STATISTICS') FROM DUAL; -- Get a script with recommendations about just one SQL statement when we have -- tuned an entire STS. SELECT DBMS_SQLTUNE.SCRIPT_TUNING_TASK(:sts_task, 'ALL', 5) FROM DUAL;
This function collects SQL statements from the shared SQL area.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.SELECT_CURSOR_CACHE ( basic_filter IN VARCHAR2 := NULL, object_filter IN VARCHAR2 := NULL, ranking_measure1 IN VARCHAR2 := NULL, ranking_measure2 IN VARCHAR2 := NULL, ranking_measure3 IN VARCHAR2 := NULL, result_percentage IN NUMBER := 1, result_limit IN NUMBER := NULL, attribute_list IN VARCHAR2 := NULL, recursive_sql IN VARCHAR2 := HAS_RECURSIVE_SQL) RETURN sys.sqlset PIPELINED;
Table 154-41 SELECT_CURSOR_CACHE Function Parameters
| Parameter | Description |
|---|---|
|
|
The SQL predicate to filter the SQL from the shared SQL area defined on attributes of the |
|
|
Currently not supported. |
|
|
An order-by clause on the selected SQL. |
|
|
A filter which picks the top N% according to the ranking measure given. Note that this applies only if one ranking measure is given. |
|
|
The top L(imit) SQL from the (filtered) source ranked by the ranking measure |
|
|
List of SQL statement attributes to return in the result. The possible values are:
|
|
|
Filter that includes recursive SQL in the SQL tuning set ( |
This function returns a one SQLSET_ROW per SQL_ID or PLAN_HASH_VALUE pair found in each data source.
Filters provided to this function are evaluated as part of a SQL run by the current user. As such, they are executed with that user's security privileges and can contain any constructs and subqueries that user can access, but no more.
Users need privileges on the shared SQL area views.
-- Get sql ids and sql text for statements with 500 buffer gets.
SELECT sql_id, sql_text
FROM table(DBMS_SQLTUNE.SELECT_CURSOR_CACHE('buffer_gets > 500'))
ORDER BY sql_id;
-- Get all the information we have about a particular statement.
SELECT *
FROM table(DBMS_SQLTUNE.SELECT_CURSOR_CACHE('sql_id = ''4rm4183czbs7j'''));
-- Notice that some statements can have multiple plans. The output of the
-- SELECT_XXX table functions is unique by (sql_id, plan_hash_value). This is
-- because a data source can store multiple plans per sql statement.
SELECT sql_id, plan_hash_value
FROM table(dbms_sqltune.select_cursor_cache('sql_id = ''ay1m3ssvtrh24'''))
ORDER BY sql_id, plan_hash_value;
-- PL/SQL examples: load_sqlset is called after opening a cursor, along the
-- lines given below
-- Select all statements in the shared SQL area.
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT value(P)
FROM table(DBMS_SQLTUNE.SELECT_CURSOR_CACHE) P;
-- Process each statement (or pass cursor to load_sqlset).
CLOSE cur;
END;/
-- Look for statements not parsed by SYS.
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur for
SELECT VALUE(P)
FROM table(
DBMS_SQLTUNE.SELECT_CURSOR_CACHE('parsing_schema_name <> ''SYS''')) P;
-- Process each statement (or pass cursor to load_sqlset).
CLOSE cur;
end;/
-- All statements from a particular module/action.
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(
DBMS_SQLTUNE.SELECT_CURSOR_CACHE(
'module = ''MY_APPLICATION'' and action = ''MY_ACTION''')) P;
-- Process each statement (or pass cursor to load_sqlset)
CLOSE cur;
END;/
-- all statements that ran for at least five seconds
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(DBMS_SQLTUNE.SELECT_CURSOR_CACHE('elapsed_time > 5000000')) P;
-- Process each statement (or pass cursor to load_sqlset)
CLOSE cur;
end;/
-- select all statements that pass a simple buffer_gets threshold and
-- are coming from an APPS user
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(
DBMS_SQLTUNE.SELECT_CURSOR_CACHE(
'buffer_gets > 100 and parsing_schema_name = ''APPS'''))P;
-- Process each statement (or pass cursor to load_sqlset)
CLOSE cur;
end;/
-- select all statements exceeding 5 seconds in elapsed time, but also
-- select the plans (by default we only select execution stats and binds
-- for performance reasons - in this case the SQL_PLAN attribute of sqlset_row
-- is NULL)
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(dbms_sqltune.select_cursor_cache(
'elapsed_time > 5000000', NULL, NULL, NULL, NULL, 1, NULL,
'EXECUTION_STATISTICS, SQL_BINDS, SQL_PLAN')) P;
-- Process each statement (or pass cursor to load_sqlset)
CLOSE cur;
END;/
-- Select the top 100 statements in the shared SQL area ordering by elapsed_time.
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(DBMS_SQLTUNE.SELECT_CURSOR_CACHE(NULL,
NULL,
'ELAPSED_TIME', NULL, NULL,
1,
100)) P;
-- Process each statement (or pass cursor to load_sqlset)
CLOSE cur;
end;/
-- Select the set of statements which cumulatively account for 90% of the
-- buffer gets in the shared SQL area. This means that the buffer gets of all
-- of these statements added up is approximately 90% of the sum of all
-- statements currently in the cache.
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT VALUE(P)
FROM table(DBMS_SQLTUNE.SELECT_CURSOR_CACHE(NULL,
NULL,
'BUFFER_GETS', NULL, NULL,
.9)) P;
-- Process each statement (or pass cursor to load_sqlset).
CLOSE cur;
END;
/
This table function reads the content of one or more trace files and returns the SQL statements it finds in the format of sqlset_row.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.SELECT_SQL_TRACE ( directory IN VARCHAR2, file_name IN VARCHAR2 := NULL, mapping_table_name IN VARCHAR2 := NULL, mapping_table_owner IN VARCHAR2 := NULL,, select_mode IN POSITIVE := SINGLE_EXECUTION, options IN BINARY_INTEGER := LIMITED_COMMAND_TYPE, pattern_start IN VARCHAR2 := NULL, pattern_end IN VARCHAR2 := NULL, result_limit IN POSITIVE := NULL) RETURN sys.sqlset PIPELINED;
Table 154-42 SELECT_SQL_TRACE Function Parameters
| Parameter | Description |
|---|---|
|
|
The directory object containing the trace file(s). This field is mandatory. |
|
|
All or part of name of the trace file(s) to process. If |
|
|
The mapping table name. Note that the mapping table name is case insensitive. If the mapping table name is |
|
|
the mapping table owner. If it is |
|
|
the mode for selecting SQL from the trace. By default, it is
|
|
|
The options. By default, it is
|
|
|
Opening delimiting pattern of the trace file section(s) to consider. CURRENTLY INOPERABLE. |
|
|
closing delimiting pattern of the trace file section(s) to process. CURRENTLY INOPERABLE. |
|
|
Top SQL from the (filtered) source. Default to |
The following code shows how to enable SQL trace for a few SQL statements and load the results into a SQL tuning set:
-- turn on the SQL trace in the capture database
ALTER SESSION SET EVENTS '10046 TRACE NAME CONTEXT FOREVER, LEVEL 4'
-- run sql statements
SELECT 1 FROM DUAL;
SELECT COUNT(*) FROM dba_tables WHERE table_name = :mytab;
ALTER SESSION SET EVENTS '10046 TRACE NAME CONTEXT OFF';
-- create mapping table from the capture database
CREATE TABLE mapping AS
SELECT object_id id, owner, substr(object_name, 1, 30) name
FROM dba_objects
WHERE object_type NOT IN ('CONSUMER GROUP', 'EVALUATION CONTEXT',
'FUNCTION', 'INDEXTYPE', 'JAVA CLASS',
'JAVA DATA', 'JAVA RESOURCE', 'LIBRARY',
'LOB', 'OPERATOR', 'PACKAGE',
'PACKAGE BODY', 'PROCEDURE', 'QUEUE',
'RESOURCE PLAN', 'TRIGGER', 'TYPE',
'TYPE BODY')
UNION ALL
SELECT user_id id, username owner, NULL name
FROM dba_users;
-- create the directory object where the SQL traces are stored
CREATE DIRECTORY SQL_TRACE_DIR as '/home/foo/trace';
-- create the STS
EXEC DBMS_SQLTUNE.CREATE_SQLSET('my_sts', 'test purpose');
-- load the SQL statements into STS from SQL TRACE
DECLARE
cur sys_refcursor;
BEGIN
OPEN cur FOR
SELECT value(p)
FROM TABLE(
DBMS_SQLTUNE.SELECT_SQL_TRACE(
directory=>'SQL_TRACE_DIR',
file_name=>'%trc',
mapping_table_name=>'mapping')) p;
DBMS_SQLTUNE.LOAD_SQLSET('my_sts', cur);
CLOSE cur;
END;
/
This function collects SQL statements from a SQL Performance Analyzer comparison task.
See Also:
SQL Tuning Set Subprograms for other subprograms in this group
DBMS_SQLTUNE.SELECT_SQLPA_TASK(
task_name IN VARCHAR2,
task_owner IN VARCHAR2 := NULL,
execution_name IN VARCHAR2 := NULL,
level_filter IN VARCHAR2 := 'REGRESSED',
basic_filter IN VARCHAR2 := NULL,
object_filter IN VARCHAR2 := NULL,
attribute_list IN VARCHAR2 := 'TYPICAL')
RETURN sys.sqlset PIPELINED;
Table 154-43 SELECT_SQLPA_TASK Function Parameters
| Parameter | Description |
|---|---|
|
|
Name of the SQL Performance Analyzer task |
|
|
Owner of the SQL Performance Analyzer task. If |
|
|
Name of the SQL Performance Analyzer task execution (type |
|
|
Filter to specify which subset of SQL statements to include. Same format as
|
|
|
SQL predicate to filter the SQL in addition to the level filters. |
|
|
Currently not supported. |
|
|
List of SQL statement attributes to return in the result. The possible values are:
|
This function reads SQLSET contents.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.SELECT_SQLSET ( sqlset_name IN VARCHAR2, basic_filter IN VARCHAR2 := NULL, object_filter IN VARCHAR2 := NULL, ranking_measure1 IN VARCHAR2 := NULL, ranking_measure2 IN VARCHAR2 := NULL, ranking_measure3 IN VARCHAR2 := NULL, result_percentage IN NUMBER := 1, result_limit IN NUMBER := NULL) attribute_list IN VARCHAR2 := NULL, plan_filter IN VARCHAR2 := NULL, sqlset_owner IN VARCHAR2 := NULL, recursive_sql IN VARCHAR2 := HAS_RECURSIVE_SQL) RETURN sys.sqlset PIPELINED;
Table 154-44 SELECT_SQLSET Function Parameters
| Parameter | Description |
|---|---|
|
|
The SQL tuning set name |
|
|
The SQL predicate to filter the SQL from the SQL tuning set defined on attributes of the |
|
|
Currently not supported. |
|
|
An order-by clause on the selected SQL |
|
|
A filter which picks the top N% according to the ranking measure given. Note that this applies only if one ranking measure is given. |
|
|
The top L(imit) SQL from the (filtered) source ranked by the ranking measure |
|
|
List of SQL statement attributes to return in the result. The possible values are:
|
|
|
The plan filter |
|
|
The owner of the SQL tuning set, or |
|
|
Filter that includes recursive SQL in the SQL tuning set ( |
This function returns a one SQLSET_ROW per SQL_ID or PLAN_HASH_VALUE pair found in each data source.
Filters provided to this function are evaluated as part of a SQL run by the current user. As such, they are executed with that user's security privileges and can contain any constructs and subqueries that user can access, but no more.
This function collects SQL statements from the workload repository. The overloaded forms let you:
Collect SQL statements from all snapshots between begin_snap and end_snap.
Collect SQL statements from a workload repository baseline.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.SELECT_WORKLOAD_REPOSITORY ( begin_snap IN NUMBER, end_snap IN NUMBER, basic_filter IN VARCHAR2 := NULL, object_filter IN VARCHAR2 := NULL, ranking_measure1 IN VARCHAR2 := NULL, ranking_measure2 IN VARCHAR2 := NULL, ranking_measure3 IN VARCHAR2 := NULL, result_percentage IN NUMBER := 1, result_limit IN NUMBER := NULL, attribute_list IN VARCHAR2 := NULL, recursive_sql IN VARCHAR2 := HAS_RECURSIVE_SQL) RETURN sys.sqlset PIPELINED; DBMS_SQLTUNE.SELECT_WORKLOAD REPOSITORY ( baseline_name IN VARCHAR2, basic_filter IN VARCHAR2 := NULL, object_filter IN VARCHAR2 := NULL, ranking_measure1 IN VARCHAR2 := NULL, ranking_measure2 IN VARCHAR2 := NULL, ranking_measure3 IN VARCHAR2 := NULL, result_percentage IN NUMBER := 1, result_limit IN NUMBER := NULL, attribute_list IN VARCHAR2 := NULL, recursive_sql IN VARCHAR2 := HAS_RECURSIVE_SQL) RETURN sys.sqlset PIPELINED;
Table 154-45 SELECT_WORKLOAD_REPOSITORY Function Parameters
| Parameter | Description |
|---|---|
|
|
Begin snapshot (non-inclusive). |
|
|
End snapshot (inclusive). |
|
|
The name of the baseline period. |
|
|
The SQL predicate to filter the SQL from the workload repository defined on attributes of the |
|
|
Currently not supported. |
|
|
An order-by clause on the selected SQL. |
|
|
A filter which picks the top N% according to the ranking measure given. Note that this applies only if one ranking measure is given. |
|
|
The top L(imit) SQL from the (filtered) source ranked by the ranking measure. |
|
|
List of SQL statement attributes to return in the result. The possible values are:
|
|
|
Filter that includes recursive SQL in the SQL tuning set ( |
This function returns a one SQLSET_ROW per SQL_ID or PLAN_HASH_VALUE pair found in each data source.
Filters provided to this function are evaluated as part of a SQL run by the current user. As such, they are executed with that user's security privileges and can contain any constructs and subqueries that user can access, but no more.
This procedure updates the value of a SQL tuning parameter of type VARCHAR2 or NUMBER.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.SET_TUNING_TASK_PARAMETER ( task_name IN VARCHAR2, parameter IN VARCHAR2, value IN VARCHAR2);
DBMS_SQLTUNE.SET_TUNING_TASK_PARAMETER ( task_name IN VARCHAR2, parameter IN VARCHAR2, value IN NUMBER);
Table 154-46 SET_TUNING_TASK_PARAMETER Procedure Parameters
| Parameter | Description |
|---|---|
|
|
Identifier of the task to execute |
|
|
Name of the parameter to set. The possible tuning parameters that can be set by this procedure using the parameter in the form
|
|
|
New value of the specified parameter |
When setting automatic tuning task parameters, use the SET_AUTO_TUNING_TASK_PARAMETER Procedures in the DBMS_AUTO_SQLTUNE package.
This function returns a SQL text's signature. The signature can be used to identify SQL text in dba_sql_profiles.
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.SQLTEXT_TO_SIGNATURE ( sql_text IN CLOB, force_match IN BOOLEAN := FALSE) RETURN NUMBER;
Table 154-47 SQLTEXT_TO_SIGNATURE Function Parameters
| Parameter | Description |
|---|---|
|
|
SQL text whose signature is required. Required. |
|
|
If |
This procedure copies profile data stored in the staging table to create profiles on the system.
See Also:
SQL Profile Subprograms for other subprograms in this groupDBMS_SQLTUNE.UNPACK_STGTAB_SQLPROF ( profile_name IN VARCHAR2 := '%', profile_category IN VARCHAR2 := 'DEFAULT', replace IN BOOLEAN, staging_table_name IN VARCHAR2, staging_schema_owner IN VARCHAR2 := NULL);
Table 154-48 UNPACK_STGTAB_SQLPROF Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The name of the profile to unpack (% wildcards acceptable, case-sensitive) |
|
|
The category from which to unpack profiles (% wildcards acceptable, case-sensitive) |
|
|
The option to replace profiles if they already exist. Note that profiles cannot be replaced if one in the staging table has the same name as an active profile in a different SQL statement.If |
|
|
The name of the table on which to perform the remap operation (case-insensitive unless double quoted). Required. |
|
|
The schema where the table resides, or |
Using this procedure requires the CREATE ANY SQL PROFILE privilege and the SELECT privilege on staging table.
-- Unpack all profiles stored in a staging table
EXEC DBMS_SQLTUNE.UNPACK_STGTAB_SQLPROF(replace => FALSE, -
staging_table_name => 'PROFILE_STGTAB');
-- If there is a failure during the unpack operation, users can find the profile
-- we failed on and perform a remap_stgtab_sqlprof operation targeting it. Then
-- they can resume the unpack operation by setting replace to TRUE so that
-- the profiles that were already created are replaced
EXEC DBMS_SQLTUNE.UNPACK_STGTAB_SQLPROF(replace => TRUE, -
staging_table_name => 'PROFILE_STGTAB');
This procedure copies one or more SQL tuning sets from their location in the staging table into the SQL tuning sets schema, making them proper SQL tuning sets.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.UNPACK_STGTAB_SQLSET ( sqlset_name IN VARCHAR2 := '%', sqlset_owner IN VARCHAR2 := NULL, replace IN BOOLEAN, staging_table_name IN VARCHAR2, staging_schema_owner IN VARCHAR2 := NULL);
Table 154-49 UNPACK_STGTAB_SQLSET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The name of the tuning set to unpack (not NULL). Wildcard characters ('%') are supported to unpack multiple tuning sets in a single call. For example, just specify '%' to unpack all tuning sets from the staging table. |
|
|
The name of tuning set owner, or |
|
|
Replaces tuning set if they already exist.If |
|
|
The name of the staging table, moved after a call to the PACK_STGTAB_SQLSET Procedure (case-sensitive) |
|
|
The name of staging table owner, or |
Users can drop the staging table after this procedure completes successfully.
The unpack procedure commits after successfully loading each SQL tuning set. If it fails with one tuning set, no part of that tuning set will have been unpacked, but those which the subprogram had already apprehended continue to exist.
When failures occur due to SQL tuning set name or owner conflicts, users should use the REMAP_STGTAB_SQLSET Procedure to patch the staging table, and then call this procedure again to unpack those tuning sets that remain.
-- unpack all STS in the staging table
EXEC DBMS_SQLTUNE.UNPACK_STGTAB_SQLSET(sqlset_name => '%', -
sqlset_owner => '%', -
replace => FALSE, -
staging_table_name => 'STGTAB_SQLSET');
-- errors can arise during STS unpack when a STS in the staging table has the
-- same name/owner as STS on the system. In this case, users should call
-- remap_stgtab_sqlset to patch the staging table and with which to call unpack
-- Replace set to TRUE.
EXEC DBMS_SQLTUNE.UNPACK_STGTAB_SQLSET(sqlset_name => '%', -
sqlset_owner => '%', -
replace => TRUE, -
staging_table_name => 'STGTAB_SQLSET');
This procedure updates selected fields for SQL statement in a SQL tuning set.
See Also:
SQL Tuning Set Subprograms for other subprograms in this groupDBMS_SQLTUNE.UPDATE_SQLSET ( sqlset_name IN VARCHAR2, sql_id IN VARCHAR2, attribute_name IN VARCHAR2, attribute_value IN VARCHAR2 := NULL); DBMS_SQLTUNE.UPDATE_SQLSET ( sqlset_name IN VARCHAR2, sql_id IN VARCHAR2, attribute_name IN VARCHAR2, attribute_value IN NUMBER := NULL);