NAME

opsi_database-insights_list-sql-plans -

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

DESCRIPTION

Query SQL Warehouse to list the plan xml for a given SQL execution plan. This returns a SqlPlanCollection object, but is currently limited to a single plan. Either databaseId or id must be specified.

USAGE

oci opsi database-insights list-sql-plans [OPTIONS]

REQUIRED PARAMETERS

--compartment-id, -c [text]

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

--plan-hash [text]

Unique plan hash for a SQL Plan of a particular SQL Statement. Example: 9820154385

--sql-identifier [text]

Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7

OPTIONAL PARAMETERS

--all

Fetches all pages of results.

--database-id [text]

Optional OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the associated DBaaS entity.

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

--id [text]

OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the database insight resource.

--page [text]

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination <https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine>.

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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opsi/database-insights/list-sql-plans.html#cmdoption-compartment-id
    export plan_hash=<substitute-value-of-plan_hash> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opsi/database-insights/list-sql-plans.html#cmdoption-plan-hash
    export sql_identifier=<substitute-value-of-sql_identifier> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opsi/database-insights/list-sql-plans.html#cmdoption-sql-identifier
    oci opsi database-insights list-sql-plans --compartment-id $compartment_id --plan-hash $plan_hash --sql-identifier $sql_identifier

AUTHOR

Oracle

COPYRIGHT

2016, 2022, Oracle