get

Description

Get information about a single index.

Usage

oci nosql index get [OPTIONS]

Required Parameters

--index-name [text]

The name of a table’s index.

--table-name-or-id [text]

A table name within the compartment, or a table OCID.

Optional Parameters

--compartment-id, -c [text]

The ID of a table’s compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.

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

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 and appropriate security policies before trying the examples.

    export index_name=<substitute-value-of-index_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/nosql/index/get.html#cmdoption-index-name
    export table_name_or_id=<substitute-value-of-table_name_or_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/nosql/index/get.html#cmdoption-table-name-or-id

    oci nosql index get --index-name $index_name --table-name-or-id $table_name_or_id