oracle.oci.oci_database_management_sql_tuning_advisor_task_summary_report_facts – Fetches details about a SqlTuningAdvisorTaskSummaryReport resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_summary_report_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a SqlTuningAdvisorTaskSummaryReport resource in Oracle Cloud Infrastructure

  • Gets the summary report for the specified SQL Tuning Advisor task.

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_greater_than_or_equal_to
integer
The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks.
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_less_than_or_equal_to
integer
The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks.
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
How far back the API will search for begin and end exec id. Unused if neither exec ids nor time filter query params are supplied. This is applicable only for Auto SQL Tuning tasks.
sql_tuning_advisor_task_id
integer / required
The SQL tuning task identifier. This is not the OCID.

aliases: id
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
time_greater_than_or_equal_to
string
The optional greater than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks.
time_less_than_or_equal_to
string
The optional less than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks.

Examples

- name: Get a specific sql_tuning_advisor_task_summary_report
  oci_database_management_sql_tuning_advisor_task_summary_report_facts:
    # required
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
    sql_tuning_advisor_task_id: 56

    # optional
    search_period: LAST_24HR
    time_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_less_than_or_equal_to: 2013-10-20T19:20:30+01:00
    begin_exec_id_greater_than_or_equal_to: 56
    end_exec_id_less_than_or_equal_to: 56

Return Values

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

Key Returned Description
sql_tuning_advisor_task_summary_report
complex
on success
SqlTuningAdvisorTaskSummaryReport resource

Sample:
{'index_findings': [{'index_columns': [], 'index_hash_value': 56, 'index_name': 'index_name_example', 'reference_count': 56, 'schema': 'schema_example', 'table_name': 'table_name_example'}], 'object_stat_findings': [{'object_hash_value': 56, 'object_name': 'object_name_example', 'object_type': 'object_type_example', 'problem_type': 'MISSING', 'reference_count': 56, 'schema': 'schema_example'}], 'statistics': {'finding_benefits': {'db_time_after_implemented': 56, 'db_time_after_recommended': 56, 'db_time_before_implemented': 56, 'db_time_before_recommended': 56}, 'finding_counts': {'alternate_plan': 56, 'implemented_sql_profile': 56, 'index': 56, 'recommended_sql_profile': 56, 'restructure': 56, 'statistics': 56}, 'statement_counts': {'distinct_sql': 56, 'error_count': 56, 'finding_count': 56, 'total_sql': 56}}, 'task_info': {'description': 'description_example', 'id': 56, 'name': 'name_example', 'owner': 'owner_example', 'running_time': 56, 'status': 'COMPLETED', 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}}
 
index_findings
complex
on success
The list of object findings related to indexes.

   
index_columns
list / elements=string
on success
Columns of the index.

   
index_hash_value
integer
on success
Numerical representation of the index.

Sample:
56
   
index_name
string
on success
Name of the index.

Sample:
index_name_example
   
reference_count
integer
on success
The number of times the index is referenced within the SQL Tuning advisor task findings.

Sample:
56
   
schema
string
on success
Schema related to the index.

Sample:
schema_example
   
table_name
string
on success
Table's name related to the index.

Sample:
table_name_example
 
object_stat_findings
complex
on success
The list of object findings related to statistics.

   
object_hash_value
integer
on success
Numerical representation of the object.

Sample:
56
   
object_name
string
on success
Name of the object.

Sample:
object_name_example
   
object_type
string
on success
Type of the object.

Sample:
object_type_example
   
problem_type
string
on success
Type of statistics problem related to the object.

Sample:
MISSING
   
reference_count
integer
on success
The number of the times the object is referenced within the SQL Tuning advisor task findings.

Sample:
56
   
schema
string
on success
Schema of the object.

Sample:
schema_example
 
statistics
complex
on success

   
finding_benefits
complex
on success

     
db_time_after_implemented
integer
on success
The actual database time of the SQL statements for which SQL Tuning Advisor recommendations are implemented.

Sample:
56
      db_time_after_recommended
integer
on success
The estimated database time of the above SQL statements, if SQL Tuning Advisor recommendations are implemented.

Sample:
56
     
db_time_before_implemented
integer
on success
The actual database time of the above SQL statements, before SQL Tuning Advisor recommendations are implemented.

Sample:
56
      db_time_before_recommended
integer
on success
The actual database time of the SQL statements for which SQL Tuning Advisor recommendations are not implemented.

Sample:
56
   
finding_counts
complex
on success

     
alternate_plan
integer
on success
The number of distinct SQL statements with alternative plan recommendations.

Sample:
56
     
implemented_sql_profile
integer
on success
The number of distinct SQL statements with implemented SQL profiles.

Sample:
56
     
index
integer
on success
The number of distinct SQL statements with index recommendations.

Sample:
56
     
recommended_sql_profile
integer
on success
The number of distinct SQL statements with recommended SQL profiles.

Sample:
56
     
restructure
integer
on success
The number of distinct SQL statements with restructured SQL recommendations.

Sample:
56
     
statistics
integer
on success
The number of distinct SQL statements with stale or missing optimizer statistics recommendations.

Sample:
56
   
statement_counts
complex
on success

     
distinct_sql
integer
on success
The number of distinct SQL statements.

Sample:
56
     
error_count
integer
on success
The number of distinct SQL statements with errors.

Sample:
56
     
finding_count
integer
on success
The number of distinct SQL statements with findings.

Sample:
56
     
total_sql
integer
on success
The total number of SQL statements.

Sample:
56
 
task_info
complex
on success

   
description
string
on success
The description of the SQL Tuning Advisor task. This is not defined for Auto SQL Tuning tasks.

Sample:
description_example
   
id
integer
on success
The ID of the SQL Tuning Advisor task. This is not the OCID.

Sample:
56
   
name
string
on success
The name of the SQL Tuning Advisor task.

Sample:
name_example
   
owner
string
on success
The owner of the SQL Tuning Advisor task.

Sample:
owner_example
   
running_time
integer
on success
The total running time in seconds. This is not defined for Auto SQL Tuning tasks.

Sample:
56
   
status
string
on success
The status of the SQL Tuning Advisor task. This is not defined for Auto SQL Tuning tasks.

Sample:
COMPLETED
   
time_ended
string
on success
The end time of the task execution.

Sample:
2013-10-20T19:20:30+01:00
   
time_started
string
on success
The start time of the task execution.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)