list

Description

Get a list of indexes on a table.

Usage

oci nosql index list [OPTIONS]

Required Parameters

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

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

Optional Parameters

--all

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

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

--lifecycle-state [text]

Filter list by the lifecycle state of the item.

Accepted values are:

ACTIVE, ALL, CREATING, DELETED, DELETING, FAILED, UPDATING
--limit [integer]

The maximum number of items to return.

--name [text]

A shell-globbing-style (*?[]) filter for names.

--page [text]

The page token representing the page at which to start retrieving results. 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 field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default.

Accepted values are:

name, timeCreated
--sort-order [text]

The sort order to use, either 'ASC' or 'DESC'.

Accepted values are:

ASC, DESC