Lists all Sql Endpoints in the specified compartment. The query must include compartmentId or sqlEndpointId. If the query does not include either compartmentId or sqlEndpointId, an error is returned.


oci data-flow sql-endpoint-collection list-sql-endpoints [OPTIONS]

Optional Parameters


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

--compartment-id, -c [text]

The OCID of the compartment in which to query resources.

--display-name [text]

The query parameter for the Spark application 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:

--lifecycle-state [text]

A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.

Accepted values are:

--limit [integer]

The maximum number of items that can be returned.

--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. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified timeCreated is used by default.

Accepted values are:

displayName, id, timeCreated
--sort-order [text]

The ordering of results in ascending or descending order.

Accepted values are:

--sql-endpoint-id [text]

The unique id of the SQL Endpoint.

Example using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” 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.

    oci data-flow sql-endpoint-collection list-sql-endpoints