Try SpotterFetches details about one or multiple SqlTuningAdvisorTaskFinding resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple SqlTuningAdvisorTaskFinding resources in Oracle Cloud Infrastructure
Gets an array of the details of the findings that match specific filters.
- 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
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
sort_by:
choices:
- DBTIME_BENEFIT
- PARSING_SCHEMA
- SQL_ID
- STATS
- PROFILES
- SQL_BENEFIT
- DATE
- INDICES
- RESTRUCTURE
- ALTERNATIVE
- MISC
- ERROR
- TIMEOUTS
description:
- The possible sortBy values of an object's recommendations.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
sort_order:
choices:
- ASC
- DESC
description:
- The option to sort information in ascending ('ASC') or descending ('DESC') order.
Descending order is the default order.
type: str
cert_bundle:
description:
- 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.
type: str
end_exec_id:
description:
- The optional less than or equal to query parameter to filter on the execution ID
related to a specific SQL Tuning Advisor task.
type: int
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
begin_exec_id:
description:
- The optional greater than or equal to filter on the execution ID related to a specific
SQL Tuning Advisor task.
type: int
search_period:
choices:
- LAST_24HR
- LAST_7DAY
- LAST_31DAY
- SINCE_LAST
- ALL
description:
- 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.
type: str
finding_filter:
choices:
- none
- FINDINGS
- NOFINDINGS
- ERRORS
- PROFILES
- INDICES
- STATS
- RESTRUCTURE
- ALTERNATIVE
- AUTO_PROFILES
- OTHER_PROFILES
description:
- The filter used to display specific findings in the report.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
index_hash_filter:
description:
- The hash value of the index table name.
type: str
stats_hash_filter:
description:
- The hash value of the object for the statistic finding search.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
managed_database_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Managed Database.
required: true
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
sql_tuning_advisor_task_id:
description:
- The SQL tuning task identifier. This is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
required: true
type: int
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
sql_tuning_advisor_task_findings:
contains:
db_time_benefit:
description:
- The time benefit (in seconds) for the highest-rated finding for this object.
returned: on success
sample: 3.4
type: float
is_alternative_plan_finding_present:
description:
- Indicates whether an alternative execution plan was reported for this SQL
statement.
returned: on success
sample: true
type: bool
is_error_finding_present:
description:
- Indicates whether there is an error in this SQL statement.
returned: on success
sample: true
type: bool
is_index_finding_present:
description:
- Indicates whether an index recommendation was reported for this SQL statement.
returned: on success
sample: true
type: bool
is_miscellaneous_finding_present:
description:
- Indicates whether a miscellaneous finding was reported for this SQL statement.
returned: on success
sample: true
type: bool
is_restructure_sql_finding_present:
description:
- Indicates whether a restructure SQL recommendation was reported for this SQL
statement.
returned: on success
sample: true
type: bool
is_sql_profile_finding_implemented:
description:
- Indicates whether a SQL Profile recommendation has been implemented for this
SQL statement.
returned: on success
sample: true
type: bool
is_sql_profile_finding_present:
description:
- Indicates whether a SQL Profile recommendation was reported for this SQL statement.
returned: on success
sample: true
type: bool
is_stats_finding_present:
description:
- Indicates whether a statistics recommendation was reported for this SQL statement.
returned: on success
sample: true
type: bool
is_timeout_finding_present:
description:
- Indicates whether the task timed out.
returned: on success
sample: true
type: bool
parsing_schema:
description:
- The parsing schema of the object.
returned: on success
sample: parsing_schema_example
type: str
per_execution_percentage:
description:
- The per-execution percentage benefit.
returned: on success
sample: 56
type: int
sql_key:
description:
- The unique key of this SQL statement.
returned: on success
sample: sql_key_example
type: str
sql_text:
description:
- The text of the SQL statement.
returned: on success
sample: sql_text_example
type: str
sql_tuning_advisor_task_id:
description:
- The unique identifier of the SQL Tuning Advisor task. This is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
returned: on success
sample: 56
type: int
sql_tuning_advisor_task_object_execution_id:
description:
- The execution id of the analyzed SQL object. This is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
returned: on success
sample: 56
type: int
sql_tuning_advisor_task_object_id:
description:
- The key of the object to which these recommendations apply. This is not the
L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
returned: on success
sample: 56
type: int
description:
- List of SqlTuningAdvisorTaskFinding resources
returned: on success
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
type: complex