``start-with-pwd``
==================
.. contents:: :local:
:depth: 1
Description
------------
Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.
Usage
-----
.. code-block:: none
oci database-management sql-tuning-task start-with-pwd [OPTIONS]
Required Parameters
--------------------
.. option:: --credential-details-password [text]
The database user's password encoded using BASE64 scheme.
.. option:: --credential-details-role [text]
The role of the database user.
Accepted values are:
.. code-block:: py
NORMAL, SYSDBA
.. option:: --credential-details-username [text]
The user name used to connect to the database.
.. option:: --managed-database-id [text]
The `OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>`__ of the Managed Database.
.. option:: --scope [text]
The scope for the SQL tuning task. For LIMITED scope, the SQL profile recommendation is excluded, so the task is executed faster. For COMPREHENSIVE scope, the SQL profile recommendation is included.
Accepted values are:
.. code-block:: py
COMPREHENSIVE, LIMITED
.. option:: --task-name [text]
The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.
.. option:: --total-time-limit-in-minutes [integer]
The time limit for running the SQL tuning task.
Optional Parameters
--------------------
.. option:: --database-credential [complex type]
This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using
the file://path/to/file syntax.
The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
.. option:: --from-json [text]
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
The :option:`--generate-full-command-json-input` option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id --> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.
Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.
For examples on usage of this option, please see our "using CLI with advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
.. option:: --sql-details [complex type]
The details of the SQL statement on which tuning is performed. To obtain the details of the SQL statement, you must provide either the sqlTuningSet or the tuple of sqlDetails/timeStarted/timeEnded.
This option is a JSON list with items of type SqlTuningTaskSqlDetail. For documentation on SqlTuningTaskSqlDetail please see our API reference: https://docs.cloud.oracle.com/api/#/en/sqltuning/20201101/datatypes/SqlTuningTaskSqlDetail.
This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using
the file://path/to/file syntax.
The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
.. option:: --sql-tuning-set [complex type]
This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using
the file://path/to/file syntax.
The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
.. option:: --statement-time-limit-in-minutes [integer]
The time limit per SQL statement (in minutes). This is for a task with the COMPREHENSIVE scope. The time limit per SQL statement should not be more than the total time limit.
.. option:: --task-description [text]
The description of the SQL tuning task.
.. option:: --time-ended [datetime]
The end time of the period in which SQL statements are running.
The following datetime formats are supported:
UTC with microseconds
***********************
.. code::
Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
Example: 2017-09-15T20:30:00.123456Z
UTC with milliseconds
***********************
.. code::
Format: YYYY-MM-DDTHH:mm:ss.sssTZD
Example: 2017-09-15T20:30:00.123Z
UTC without milliseconds
**************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T20:30:00Z
UTC with minute precision
**************************
.. code::
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T20:30Z
Timezone with microseconds
***************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800
Timezone with milliseconds
***************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
Timezone without milliseconds
*******************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
Timezone with minute precision
*******************************
.. code::
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800
Short date and time
********************
The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
.. code::
Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
Example: '2017-09-15 17:25'
Date Only
**********
This date will be taken as midnight UTC of that day
.. code::
Format: YYYY-MM-DD
Example: 2017-09-15
Epoch seconds
**************
.. code::
Example: 1412195400
.. option:: --time-started [datetime]
The start time of the period in which SQL statements are running.
The following datetime formats are supported:
UTC with microseconds
***********************
.. code::
Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
Example: 2017-09-15T20:30:00.123456Z
UTC with milliseconds
***********************
.. code::
Format: YYYY-MM-DDTHH:mm:ss.sssTZD
Example: 2017-09-15T20:30:00.123Z
UTC without milliseconds
**************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T20:30:00Z
UTC with minute precision
**************************
.. code::
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T20:30Z
Timezone with microseconds
***************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800
Timezone with milliseconds
***************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
Timezone without milliseconds
*******************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
Timezone with minute precision
*******************************
.. code::
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800
Short date and time
********************
The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
.. code::
Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
Example: '2017-09-15 17:25'
Date Only
**********
This date will be taken as midnight UTC of that day
.. code::
Format: YYYY-MM-DD
Example: 2017-09-15
Epoch seconds
**************
.. code::
Example: 1412195400
Global Parameters
------------------
Use ``oci --help`` for help on global parameters.
:option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v`
Example using required parameter
------------------
Copy the following CLI commands into a file named example.sh. Run the command by typing "bash example.sh" and replacing the example parameters with your own.
Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up `the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile>`__ and `appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm>`__ before trying the examples.
.. code-block:: none
:class: copy-code-block
export credential_details_password=<substitute-value-of-credential_details_password> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-pwd.html#cmdoption-credential-details-password
export credential_details_role=<substitute-value-of-credential_details_role> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-pwd.html#cmdoption-credential-details-role
export credential_details_username=<substitute-value-of-credential_details_username> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-pwd.html#cmdoption-credential-details-username
export managed_database_id=<substitute-value-of-managed_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-pwd.html#cmdoption-managed-database-id
export scope=<substitute-value-of-scope> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-pwd.html#cmdoption-scope
export task_name=<substitute-value-of-task_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-pwd.html#cmdoption-task-name
export total_time_limit_in_minutes=<substitute-value-of-total_time_limit_in_minutes> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-pwd.html#cmdoption-total-time-limit-in-minutes
oci database-management sql-tuning-task start-with-pwd --credential-details-password $credential_details_password --credential-details-role $credential_details_role --credential-details-username $credential_details_username --managed-database-id $managed_database_id --scope $scope --task-name $task_name --total-time-limit-in-minutes $total_time_limit_in_minutes