oracle.oci.oci_opsi_sql_plan_insights_facts – Fetches details about a SqlPlanInsights resource 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_opsi_sql_plan_insights_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about a SqlPlanInsights resource in Oracle Cloud Infrastructure
Query SQL Warehouse to get the performance insights on the execution plans for a given SQL for a given time period. Either databaseId or id must be specified.
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 |
---|---|---|
analysis_time_interval
string
|
Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).
|
|
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.
|
|
compartment_id
string
/ required
|
The OCID of the compartment.
|
|
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 . |
|
database_id
string
|
Optional OCID of the associated DBaaS entity.
|
|
id
string
|
OCID of the database insight resource.
|
|
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. |
|
sql_identifier
string
/ required
|
Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7`
|
|
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_interval_end
string
|
Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
|
|
time_interval_start
string
|
Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
|
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_plan_insights
oci_opsi_sql_plan_insights_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
sql_identifier: sql_identifier_example
# optional
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
analysis_time_interval: analysis_time_interval_example
time_interval_start: 2013-10-20T19:20:30+01:00
time_interval_end: 2013-10-20T19:20:30+01:00
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
sql_plan_insights
complex
|
on success |
SqlPlanInsights resource
Sample:
{'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'insights': [{'category': 'category_example', 'text': 'text_example', 'value': 56}], 'items': [{'cpu_time_in_sec': 1.2, 'executions_count': 56, 'inefficient_wait_time_in_sec': 1.2, 'io_time_in_sec': 1.2, 'plan_hash': 56}], 'sql_identifier': 'sql_identifier_example', 'time_interval_end': '2013-10-20T19:20:30+01:00', 'time_interval_start': '2013-10-20T19:20:30+01:00'}
|
||
database_id
string
|
on success |
The OCID of the database.
Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
|
||
id
string
|
on success |
The OCID of the database insight resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
insights
complex
|
on success |
List of SQL plan insights.
|
||
category
string
|
on success |
SQL Insight category. For example PLANS_USED, MOST_EXECUTED, BEST_PERFORMER, WORST_PERFORMER, MOST_CPU or MOST_IO.
Sample:
category_example
|
||
text
string
|
on success |
SQL Plan Insight text. For example `Number of Plans Used`, `Most Executed Plan`, `Best Performing Plan`, `Worst Performing Plan`, `Plan With Most IO`, `Plan with Most CPU`
Sample:
text_example
|
||
value
integer
|
on success |
SQL execution plan hash value for a given insight. For example `Most Executed Plan` insight will have value as "3975467901"
Sample:
56
|
||
items
complex
|
on success |
List of SQL plan statistics.
|
||
cpu_time_in_sec
float
|
on success |
CPU Time in seconds
Sample:
1.2
|
||
executions_count
integer
|
on success |
Total number of executions
Sample:
56
|
||
inefficient_wait_time_in_sec
float
|
on success |
Inefficient Wait Time in seconds
Sample:
1.2
|
||
io_time_in_sec
float
|
on success |
IO Time in seconds
Sample:
1.2
|
||
plan_hash
integer
|
on success |
Plan hash value for the SQL Execution Plan
Sample:
56
|
||
sql_identifier
string
|
on success |
Unique SQL_ID for a SQL Statement.
Sample:
sql_identifier_example
|
||
time_interval_end
string
|
on success |
The end timestamp that was passed into the request.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_interval_start
string
|
on success |
The start timestamp that was passed into the request.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)