oracle.oci.oci_database_management_sql_tuning_advisor_task_finding_facts – Fetches details about one or multiple SqlTuningAdvisorTaskFinding resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_database_management_sql_tuning_advisor_task_finding_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple SqlTuningAdvisorTaskFinding resources in Oracle Cloud Infrastructure

  • Gets an array of the details of the findings that match specific filters.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
begin_exec_id
integer
The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
end_exec_id
integer
The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task.
finding_filter
string
    Choices:
  • none
  • FINDINGS
  • NOFINDINGS
  • ERRORS
  • PROFILES
  • INDICES
  • STATS
  • RESTRUCTURE
  • ALTERNATIVE
  • AUTO_PROFILES
  • OTHER_PROFILES
The filter used to display specific findings in the report.
index_hash_filter
string
The hash value of the index table name.
managed_database_id
string / required
The OCID of the Managed Database.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
search_period
string
    Choices:
  • LAST_24HR
  • LAST_7DAY
  • LAST_31DAY
  • SINCE_LAST
  • ALL
The search period during which the API will search for begin and end exec id, if not supplied. Unused if beginExecId and endExecId optional query params are both supplied.
sort_by
string
    Choices:
  • DBTIME_BENEFIT
  • PARSING_SCHEMA
  • SQL_ID
  • STATS
  • PROFILES
  • SQL_BENEFIT
  • DATE
  • INDICES
  • RESTRUCTURE
  • ALTERNATIVE
  • MISC
  • ERROR
  • TIMEOUTS
The possible sortBy values of an object's recommendations.
sort_order
string
    Choices:
  • ASC
  • DESC
The option to sort information in ascending ('ASC') or descending ('DESC') order. Descending order is the default order.
sql_tuning_advisor_task_id
integer / required
The SQL tuning task identifier. This is not the OCID.
stats_hash_filter
string
The hash value of the object for the statistic finding search.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: List sql_tuning_advisor_task_findings
  oci_database_management_sql_tuning_advisor_task_finding_facts:
    # required
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
    sql_tuning_advisor_task_id: 56

    # optional
    begin_exec_id: 56
    end_exec_id: 56
    search_period: LAST_24HR
    finding_filter: none
    stats_hash_filter: stats_hash_filter_example
    index_hash_filter: index_hash_filter_example
    sort_by: DBTIME_BENEFIT
    sort_order: ASC

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
sql_tuning_advisor_task_findings
complex
on success
List of SqlTuningAdvisorTaskFinding resources

Sample:
[{'db_time_benefit': 3.4, 'is_alternative_plan_finding_present': True, 'is_error_finding_present': True, 'is_index_finding_present': True, 'is_miscellaneous_finding_present': True, 'is_restructure_sql_finding_present': True, 'is_sql_profile_finding_implemented': True, 'is_sql_profile_finding_present': True, 'is_stats_finding_present': True, 'is_timeout_finding_present': True, 'parsing_schema': 'parsing_schema_example', 'per_execution_percentage': 56, 'sql_key': 'sql_key_example', 'sql_text': 'sql_text_example', 'sql_tuning_advisor_task_id': 56, 'sql_tuning_advisor_task_object_execution_id': 56, 'sql_tuning_advisor_task_object_id': 56}]
 
db_time_benefit
float
on success
The time benefit (in seconds) for the highest-rated finding for this object.

Sample:
3.4
 
is_alternative_plan_finding_present
boolean
on success
Indicates whether an alternative execution plan was reported for this SQL statement.

Sample:
True
 
is_error_finding_present
boolean
on success
Indicates whether there is an error in this SQL statement.

Sample:
True
 
is_index_finding_present
boolean
on success
Indicates whether an index recommendation was reported for this SQL statement.

Sample:
True
 
is_miscellaneous_finding_present
boolean
on success
Indicates whether a miscellaneous finding was reported for this SQL statement.

Sample:
True
 
is_restructure_sql_finding_present
boolean
on success
Indicates whether a restructure SQL recommendation was reported for this SQL statement.

Sample:
True
 
is_sql_profile_finding_implemented
boolean
on success
Indicates whether a SQL Profile recommendation has been implemented for this SQL statement.

Sample:
True
 
is_sql_profile_finding_present
boolean
on success
Indicates whether a SQL Profile recommendation was reported for this SQL statement.

Sample:
True
 
is_stats_finding_present
boolean
on success
Indicates whether a statistics recommendation was reported for this SQL statement.

Sample:
True
 
is_timeout_finding_present
boolean
on success
Indicates whether the task timed out.

Sample:
True
 
parsing_schema
string
on success
The parsing schema of the object.

Sample:
parsing_schema_example
 
per_execution_percentage
integer
on success
The per-execution percentage benefit.

Sample:
56
 
sql_key
string
on success
The unique key of this SQL statement.

Sample:
sql_key_example
 
sql_text
string
on success
The text of the SQL statement.

Sample:
sql_text_example
 
sql_tuning_advisor_task_id
integer
on success
The unique identifier of the SQL Tuning Advisor task. This is not the OCID.

Sample:
56
 
sql_tuning_advisor_task_object_execution_id
integer
on success
The execution id of the analyzed SQL object. This is not the OCID.

Sample:
56
 
sql_tuning_advisor_task_object_id
integer
on success
The key of the object to which these recommendations apply. This is not the OCID.

Sample:
56


Authors

  • Oracle (@oracle)