DATABASE-MANAGEMENT_SQL-TUNING-TASK(1)

clone

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Clones and runs a SQL tuning task in the database.

Usage

oci database-management sql-tuning-task clone [OPTIONS]

Required Parameters

--credential-details [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 --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.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--original-task-id [integer]

The identifier of the SQL tuning task being cloned. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>. It can be retrieved from the following endpoint ListSqlTuningAdvisorTasks <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-tasks.html>.

--task-name [text]

The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--task-description [text]

The description of the SQL tuning task.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci database-management sql-tuning-task clone --generate-param-json-input credential-details > credential-details.json

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.

    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/clone.html#cmdoption-managed-database-id
    export original_task_id=<substitute-value-of-original_task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/clone.html#cmdoption-original-task-id
    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/clone.html#cmdoption-task-name
    oci database-management sql-tuning-task clone --credential-details file://credential-details.json --managed-database-id $managed_database_id --original-task-id $original_task_id --task-name $task_name

clone-with-pwd

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Clones and runs a SQL tuning task in the database.

Usage

oci database-management sql-tuning-task clone-with-pwd [OPTIONS]

Required Parameters

--credential-details-password [text]

The database user’s password encoded using BASE64 scheme.

--credential-details-role [text]

The role of the database user.

Accepted values are:

NORMAL, SYSDBA

--credential-details-username [text]

The user name used to connect to the database.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--original-task-id [integer]

The identifier of the SQL tuning task being cloned. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>. It can be retrieved from the following endpoint ListSqlTuningAdvisorTasks <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-tasks.html>.

--task-name [text]

The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--task-description [text]

The description of the SQL tuning task.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    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/clone-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/clone-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/clone-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/clone-with-pwd.html#cmdoption-managed-database-id
    export original_task_id=<substitute-value-of-original_task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/clone-with-pwd.html#cmdoption-original-task-id
    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/clone-with-pwd.html#cmdoption-task-name
    oci database-management sql-tuning-task clone-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 --original-task-id $original_task_id --task-name $task_name

clone-with-secret

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Clones and runs a SQL tuning task in the database.

Usage

oci database-management sql-tuning-task clone-with-secret [OPTIONS]

Required Parameters

--credential-details-password-secret-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Secret where the database password is stored.

--credential-details-role [text]

The role of the database user.

Accepted values are:

NORMAL, SYSDBA

--credential-details-username [text]

The user name used to connect to the database.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--original-task-id [integer]

The identifier of the SQL tuning task being cloned. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>. It can be retrieved from the following endpoint ListSqlTuningAdvisorTasks <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-tasks.html>.

--task-name [text]

The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--task-description [text]

The description of the SQL tuning task.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    export credential_details_password_secret_id=<substitute-value-of-credential_details_password_secret_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/clone-with-secret.html#cmdoption-credential-details-password-secret-id
    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/clone-with-secret.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/clone-with-secret.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/clone-with-secret.html#cmdoption-managed-database-id
    export original_task_id=<substitute-value-of-original_task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/clone-with-secret.html#cmdoption-original-task-id
    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/clone-with-secret.html#cmdoption-task-name
    oci database-management sql-tuning-task clone-with-secret --credential-details-password-secret-id $credential_details_password_secret_id --credential-details-role $credential_details_role --credential-details-username $credential_details_username --managed-database-id $managed_database_id --original-task-id $original_task_id --task-name $task_name

drop

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Drops a SQL tuning task and its related results from the database.

Usage

oci database-management sql-tuning-task drop [OPTIONS]

Required Parameters

--credential-details [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 --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.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--task-id [integer]

The identifier of the SQL tuning task being dropped. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>. It can be retrieved from the following endpoint ListSqlTuningAdvisorTasks <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-tasks.html>.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci database-management sql-tuning-task drop --generate-param-json-input credential-details > credential-details.json

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.

    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/drop.html#cmdoption-managed-database-id
    export task_id=<substitute-value-of-task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/drop.html#cmdoption-task-id
    oci database-management sql-tuning-task drop --credential-details file://credential-details.json --managed-database-id $managed_database_id --task-id $task_id

drop-with-pwd

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Drops a SQL tuning task and its related results from the database.

Usage

oci database-management sql-tuning-task drop-with-pwd [OPTIONS]

Required Parameters

--credential-details-password [text]

The database user’s password encoded using BASE64 scheme.

--credential-details-role [text]

The role of the database user.

Accepted values are:

NORMAL, SYSDBA

--credential-details-username [text]

The user name used to connect to the database.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--task-id [integer]

The identifier of the SQL tuning task being dropped. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>. It can be retrieved from the following endpoint ListSqlTuningAdvisorTasks <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-tasks.html>.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    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/drop-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/drop-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/drop-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/drop-with-pwd.html#cmdoption-managed-database-id
    export task_id=<substitute-value-of-task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/drop-with-pwd.html#cmdoption-task-id
    oci database-management sql-tuning-task drop-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 --task-id $task_id

drop-with-secret

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Drops a SQL tuning task and its related results from the database.

Usage

oci database-management sql-tuning-task drop-with-secret [OPTIONS]

Required Parameters

--credential-details-password-secret-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Secret where the database password is stored.

--credential-details-role [text]

The role of the database user.

Accepted values are:

NORMAL, SYSDBA

--credential-details-username [text]

The user name used to connect to the database.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--task-id [integer]

The identifier of the SQL tuning task being dropped. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>. It can be retrieved from the following endpoint ListSqlTuningAdvisorTasks <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-tasks.html>.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    export credential_details_password_secret_id=<substitute-value-of-credential_details_password_secret_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/drop-with-secret.html#cmdoption-credential-details-password-secret-id
    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/drop-with-secret.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/drop-with-secret.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/drop-with-secret.html#cmdoption-managed-database-id
    export task_id=<substitute-value-of-task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/drop-with-secret.html#cmdoption-task-id
    oci database-management sql-tuning-task drop-with-secret --credential-details-password-secret-id $credential_details_password_secret_id --credential-details-role $credential_details_role --credential-details-username $credential_details_username --managed-database-id $managed_database_id --task-id $task_id

get-exec-plan-stats-compare

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Retrieves a comparison of the existing SQL execution plan and a new plan. A SQL tuning task may suggest a new execution plan for a SQL, and this API retrieves the comparison report of the statistics of the two plans.

Usage

oci database-management sql-tuning-task get-exec-plan-stats-compare [OPTIONS]

Required Parameters

--execution-id [integer]

The execution ID for an execution of a SQL tuning task. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--sql-object-id [integer]

The SQL object ID for the SQL tuning task. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

--sql-tuning-advisor-task-id [integer]

The SQL tuning task identifier. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    export execution_id=<substitute-value-of-execution_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/get-exec-plan-stats-compare.html#cmdoption-execution-id
    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/get-exec-plan-stats-compare.html#cmdoption-managed-database-id
    export sql_object_id=<substitute-value-of-sql_object_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/get-exec-plan-stats-compare.html#cmdoption-sql-object-id
    export sql_tuning_advisor_task_id=<substitute-value-of-sql_tuning_advisor_task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/get-exec-plan-stats-compare.html#cmdoption-sql-tuning-advisor-task-id
    oci database-management sql-tuning-task get-exec-plan-stats-compare --execution-id $execution_id --managed-database-id $managed_database_id --sql-object-id $sql_object_id --sql-tuning-advisor-task-id $sql_tuning_advisor_task_id

get-sql-exec-plan

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Retrieves a SQL execution plan for the SQL being tuned.

Usage

oci database-management sql-tuning-task get-sql-exec-plan [OPTIONS]

Required Parameters

--attribute [text]

The attribute of the SQL execution plan.

Accepted values are:

ORIGINAL, ORIGINAL_WITH_ADJUSTED_COST, USING_NEW_INDICES, USING_SQL_PROFILE

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--sql-object-id [integer]

The SQL object ID for the SQL tuning task. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

--sql-tuning-advisor-task-id [integer]

The SQL tuning task identifier. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    export attribute=<substitute-value-of-attribute> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/get-sql-exec-plan.html#cmdoption-attribute
    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/get-sql-exec-plan.html#cmdoption-managed-database-id
    export sql_object_id=<substitute-value-of-sql_object_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/get-sql-exec-plan.html#cmdoption-sql-object-id
    export sql_tuning_advisor_task_id=<substitute-value-of-sql_tuning_advisor_task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/get-sql-exec-plan.html#cmdoption-sql-tuning-advisor-task-id
    oci database-management sql-tuning-task get-sql-exec-plan --attribute $attribute --managed-database-id $managed_database_id --sql-object-id $sql_object_id --sql-tuning-advisor-task-id $sql_tuning_advisor_task_id

get-summary-report

Description
Usage
Required Parameters
Optional Parameters

UTC with microseconds
Timezone with microseconds
UTC with microseconds
Timezone with microseconds

Global Parameters
Examples

Description

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

Usage

oci database-management sql-tuning-task get-summary-report [OPTIONS]

Required Parameters

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--sql-tuning-advisor-task-id [integer]

The SQL tuning task identifier. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

Optional Parameters

--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.

--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.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--search-period [text]

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.

Accepted values are:

ALL, LAST_24HR, LAST_31DAY, LAST_7DAY, SINCE_LAST

--time-greater-than-or-equal-to [datetime]

The optional greater than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks.

The following datetime formats are supported:

UTC with microseconds

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

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

--time-less-than-or-equal-to [datetime]

The optional less than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks.

The following datetime formats are supported:

UTC with microseconds

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

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.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    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/get-summary-report.html#cmdoption-managed-database-id
    export sql_tuning_advisor_task_id=<substitute-value-of-sql_tuning_advisor_task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/get-summary-report.html#cmdoption-sql-tuning-advisor-task-id
    oci database-management sql-tuning-task get-summary-report --managed-database-id $managed_database_id --sql-tuning-advisor-task-id $sql_tuning_advisor_task_id

list-findings

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

Gets an array of the details of the findings that match specific filters.

Usage

oci database-management sql-tuning-task list-findings [OPTIONS]

Required Parameters

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--sql-tuning-advisor-task-id [integer]

The SQL tuning task identifier. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

Optional Parameters

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--begin-exec-id [integer]

The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task.

--end-exec-id [integer]

The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task.

--finding-filter [text]

The filter used to display specific findings in the report.

Accepted values are:

ALTERNATIVE, AUTO_PROFILES, ERRORS, FINDINGS, INDICES, NOFINDINGS, OTHER_PROFILES, PROFILES, RESTRUCTURE, STATS, none

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--index-hash-filter [text]

The hash value of the index table name.

--limit [integer]

The maximum number of records returned in the paginated response.

--page [text]

The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--search-period [text]

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.

Accepted values are:

ALL, LAST_24HR, LAST_31DAY, LAST_7DAY, SINCE_LAST

--sort-by [text]

The possible sortBy values of an object’s recommendations.

Accepted values are:

ALTERNATIVE, DATE, DBTIME_BENEFIT, ERROR, INDICES, MISC, PARSING_SCHEMA, PROFILES, RESTRUCTURE, SQL_BENEFIT, SQL_ID, STATS, TIMEOUTS

--sort-order [text]

The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order.

Accepted values are:

ASC, DESC

--stats-hash-filter [text]

The hash value of the object for the statistic finding search.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    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/list-findings.html#cmdoption-managed-database-id
    export sql_tuning_advisor_task_id=<substitute-value-of-sql_tuning_advisor_task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-findings.html#cmdoption-sql-tuning-advisor-task-id
    oci database-management sql-tuning-task list-findings --managed-database-id $managed_database_id --sql-tuning-advisor-task-id $sql_tuning_advisor_task_id

list-recommendations

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

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.

Usage

oci database-management sql-tuning-task list-recommendations [OPTIONS]

Required Parameters

--execution-id [integer]

The execution ID for an execution of a SQL tuning task. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--sql-object-id [integer]

The SQL object ID for the SQL tuning task. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

--sql-tuning-advisor-task-id [integer]

The SQL tuning task identifier. This is not the OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

Optional Parameters

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--limit [integer]

The maximum number of records returned in the paginated response.

--page [text]

The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

The possible sortBy values of an object’s recommendations.

Accepted values are:

BENEFIT, RECOMMENDATION_TYPE

--sort-order [text]

The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order.

Accepted values are:

ASC, DESC

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    export execution_id=<substitute-value-of-execution_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-recommendations.html#cmdoption-execution-id
    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/list-recommendations.html#cmdoption-managed-database-id
    export sql_object_id=<substitute-value-of-sql_object_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-recommendations.html#cmdoption-sql-object-id
    export sql_tuning_advisor_task_id=<substitute-value-of-sql_tuning_advisor_task_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/list-recommendations.html#cmdoption-sql-tuning-advisor-task-id
    oci database-management sql-tuning-task list-recommendations --execution-id $execution_id --managed-database-id $managed_database_id --sql-object-id $sql_object_id --sql-tuning-advisor-task-id $sql_tuning_advisor_task_id

list-tasks

Description
Usage
Required Parameters
Optional Parameters

UTC with microseconds
Timezone with microseconds
UTC with microseconds
Timezone with microseconds

Global Parameters
Examples

Description

Lists the SQL Tuning Advisor tasks for the specified Managed Database.

Usage

oci database-management sql-tuning-task list-tasks [OPTIONS]

Required Parameters

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

Optional Parameters

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--limit [integer]

The maximum number of records returned in the paginated response.

--name [text]

The optional query parameter to filter the SQL Tuning Advisor task list by name.

--page [text]

The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

The option to sort the SQL Tuning Advisor task summary data.

Accepted values are:

NAME, START_TIME

--sort-order [text]

The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order.

Accepted values are:

ASC, DESC

--status [text]

The optional query parameter to filter the SQL Tuning Advisor task list by status.

Accepted values are:

COMPLETED, ERROR, EXECUTING, INITIAL, INTERRUPTED

--time-greater-than-or-equal-to [datetime]

The optional greater than or equal to query parameter to filter the timestamp.

The following datetime formats are supported:

UTC with microseconds

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

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

--time-less-than-or-equal-to [datetime]

The optional less than or equal to query parameter to filter the timestamp.

The following datetime formats are supported:

UTC with microseconds

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

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.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

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.

    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/list-tasks.html#cmdoption-managed-database-id
    oci database-management sql-tuning-task list-tasks --managed-database-id $managed_database_id

start

Description
Usage
Required Parameters

UTC with microseconds
Timezone with microseconds
UTC with microseconds
Timezone with microseconds

Optional Parameters
Global Parameters
Examples

Description

Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.

Usage

oci database-management sql-tuning-task start [OPTIONS]

Required Parameters

--credential-details [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 --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.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--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:

COMPREHENSIVE, LIMITED

--sql-details [complex type]

The array of the details of SQL statement on which tuning is performed. 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 --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.

--task-name [text]

The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

--time-ended [datetime]

The end time of the period in which SQL statements are running.

The following datetime formats are supported:

UTC with microseconds

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

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

--time-started [datetime]

The start time of the period in which SQL statements are running.

The following datetime formats are supported:

UTC with microseconds

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

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

--total-time-limit-in-minutes [integer]

The time limit for running the SQL tuning task.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--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.

--task-description [text]

The description of the SQL tuning task.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci database-management sql-tuning-task start --generate-param-json-input credential-details > credential-details.json
    oci database-management sql-tuning-task start --generate-param-json-input sql-details > sql-details.json

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.

    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.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.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.html#cmdoption-task-name
    export time_ended=<substitute-value-of-time_ended> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start.html#cmdoption-time-ended
    export time_started=<substitute-value-of-time_started> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start.html#cmdoption-time-started
    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.html#cmdoption-total-time-limit-in-minutes
    oci database-management sql-tuning-task start --credential-details file://credential-details.json --managed-database-id $managed_database_id --scope $scope --sql-details file://sql-details.json --task-name $task_name --time-ended $time_ended --time-started $time_started --total-time-limit-in-minutes $total_time_limit_in_minutes

start-with-pwd

Description
Usage
Required Parameters

UTC with microseconds
Timezone with microseconds
UTC with microseconds
Timezone with microseconds

Optional Parameters
Global Parameters
Examples

Description

Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.

Usage

oci database-management sql-tuning-task start-with-pwd [OPTIONS]

Required Parameters

--credential-details-password [text]

The database user’s password encoded using BASE64 scheme.

--credential-details-role [text]

The role of the database user.

Accepted values are:

NORMAL, SYSDBA

--credential-details-username [text]

The user name used to connect to the database.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--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:

COMPREHENSIVE, LIMITED

--sql-details [complex type]

The array of the details of SQL statement on which tuning is performed. 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 --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.

--task-name [text]

The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

--time-ended [datetime]

The end time of the period in which SQL statements are running.

The following datetime formats are supported:

UTC with microseconds

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

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

--time-started [datetime]

The start time of the period in which SQL statements are running.

The following datetime formats are supported:

UTC with microseconds

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

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

--total-time-limit-in-minutes [integer]

The time limit for running the SQL tuning task.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--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.

--task-description [text]

The description of the SQL tuning task.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci database-management sql-tuning-task start-with-pwd --generate-param-json-input sql-details > sql-details.json

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.

    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 time_ended=<substitute-value-of-time_ended> # 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-time-ended
    export time_started=<substitute-value-of-time_started> # 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-time-started
    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 --sql-details file://sql-details.json --task-name $task_name --time-ended $time_ended --time-started $time_started --total-time-limit-in-minutes $total_time_limit_in_minutes

start-with-secret

Description
Usage
Required Parameters

UTC with microseconds
Timezone with microseconds
UTC with microseconds
Timezone with microseconds

Optional Parameters
Global Parameters
Examples

Description

Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.

Usage

oci database-management sql-tuning-task start-with-secret [OPTIONS]

Required Parameters

--credential-details-password-secret-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Secret where the database password is stored.

--credential-details-role [text]

The role of the database user.

Accepted values are:

NORMAL, SYSDBA

--credential-details-username [text]

The user name used to connect to the database.

--managed-database-id [text]

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database.

--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:

COMPREHENSIVE, LIMITED

--sql-details [complex type]

The array of the details of SQL statement on which tuning is performed. 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 --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.

--task-name [text]

The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

--time-ended [datetime]

The end time of the period in which SQL statements are running.

The following datetime formats are supported:

UTC with microseconds

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

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

--time-started [datetime]

The start time of the period in which SQL statements are running.

The following datetime formats are supported:

UTC with microseconds

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

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

--total-time-limit-in-minutes [integer]

The time limit for running the SQL tuning task.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --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

--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.

--task-description [text]

The description of the SQL tuning task.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Examples

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci database-management sql-tuning-task start-with-secret --generate-param-json-input sql-details > sql-details.json

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.

    export credential_details_password_secret_id=<substitute-value-of-credential_details_password_secret_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-secret.html#cmdoption-credential-details-password-secret-id
    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-secret.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-secret.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-secret.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-secret.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-secret.html#cmdoption-task-name
    export time_ended=<substitute-value-of-time_ended> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-secret.html#cmdoption-time-ended
    export time_started=<substitute-value-of-time_started> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/sql-tuning-task/start-with-secret.html#cmdoption-time-started
    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-secret.html#cmdoption-total-time-limit-in-minutes
    oci database-management sql-tuning-task start-with-secret --credential-details-password-secret-id $credential_details_password_secret_id --credential-details-role $credential_details_role --credential-details-username $credential_details_username --managed-database-id $managed_database_id --scope $scope --sql-details file://sql-details.json --task-name $task_name --time-ended $time_ended --time-started $time_started --total-time-limit-in-minutes $total_time_limit_in_minutes