oracle.oci.oci_database_management_sql_tuning_advisor_task_recommendation_facts – Fetches details about one or multiple SqlTuningAdvisorTaskRecommendation resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_recommendation_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple SqlTuningAdvisorTaskRecommendation resources in Oracle Cloud Infrastructure
Gets the findings and possible actions for a given object in a SQL tuning task. The task ID and object ID are used to retrieve the findings and recommendations.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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. |
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 . |
|
execution_id
integer
/ required
|
The execution ID for an execution of a SQL tuning task. This is not the OCID.
|
|
managed_database_id
string
/ required
|
The OCID of the Managed Database.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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. |
|
sort_by
string
|
|
The possible sortBy values of an object's recommendations.
|
sort_order
string
|
|
The option to sort information in ascending ('ASC') or descending ('DESC') order. Descending order is the default order.
|
sql_object_id
integer
/ required
|
The SQL object ID for the SQL tuning task. This is not the OCID.
|
|
sql_tuning_advisor_task_id
integer
/ required
|
The SQL tuning task identifier. This is not the OCID.
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: List sql_tuning_advisor_task_recommendations
oci_database_management_sql_tuning_advisor_task_recommendation_facts:
# required
managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
sql_tuning_advisor_task_id: 56
sql_object_id: 56
execution_id: 56
# optional
sort_by: RECOMMENDATION_TYPE
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_recommendations
complex
|
on success |
List of SqlTuningAdvisorTaskRecommendation resources
Sample:
[{'benefit': 3.4, 'finding': 'finding_example', 'implement_action_sql': 'implement_action_sql_example', 'is_parallel_execution': True, 'rationale': 'rationale_example', 'recommendation': 'recommendation_example', 'recommendation_key': 56, 'recommendation_type': 'STATISTICS', 'sql_tuning_advisor_task_id': 56, 'sql_tuning_advisor_task_object_id': 56}]
|
|
benefit
float
|
on success |
The percentage benefit of this implementation.
Sample:
3.4
|
|
finding
string
|
on success |
Summary of the issue found in the SQL statement.
Sample:
finding_example
|
|
implement_action_sql
string
|
on success |
Action sql to be implemented based on the recommendation result.
Sample:
implement_action_sql_example
|
|
is_parallel_execution
boolean
|
on success |
Indicates whether a SQL Profile recommendation uses parallel execution.
Sample:
True
|
|
rationale
string
|
on success |
Describes the reasoning behind the recommendation and how it relates to the finding.
Sample:
rationale_example
|
|
recommendation
string
|
on success |
The recommendation for a specific finding.
Sample:
recommendation_example
|
|
recommendation_key
integer
|
on success |
The unique identifier of the recommendation in the scope of the task.
Sample:
56
|
|
recommendation_type
string
|
on success |
Type of recommendation.
Sample:
STATISTICS
|
|
sql_tuning_advisor_task_id
integer
|
on success |
The unique identifier of the task. 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)