query

Description

Returns a list of search results within a data catalog.

Usage

oci data-catalog search query [OPTIONS]

Required Parameters

--catalog-id [text]

Unique catalog identifier.

Optional Parameters

--display-name [text]

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

--limit [integer]

The maximum number of items to return.

--name [text]

Immutable resource name.

--page [text]

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

--query-text [text]

Search query dsl that defines the query components including fields and predicates.

--sort-by [text]

The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Accepted values are:

DISPLAYNAME, TIMECREATED
--sort-order [text]

The sort order to use, either 'asc' or 'desc'.

Accepted values are:

ASC, DESC
--timeout [text]

A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.