"list-columns"
**************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


Description
===========

Returns a list of column metadata objects.


Usage
=====

   oci data-safe target-database list-columns [OPTIONS]


Required Parameters
===================

--target-database-id [text]

The OCID of the Data Safe target database.


Optional Parameters
===================

--all

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

--column-name [text]

A filter to return only a specific column based on column name.

--column-name-contains [text]

A filter to return only items if column name contains a specific
string.

--datatype [text]

A filter to return only items related to specific datatype.

--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/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--limit [integer]

For list pagination. The maximum number of items to return per page in
a paginated “List” call. For details about how pagination works, see
List Pagination.

--page [text]

For list pagination. The page token representing the page at which to
start retrieving results. It is usually retrieved from a previous
“List” call. For details about how pagination works, see List
Pagination.

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

--schema-name [text]

A filter to return only items related to specific schema name.

--schema-name-contains [text]

A filter to return only items if schema name contains a specific
string.

--sort-by [text]

The field used for sorting. Only one sorting order (sortOrder) can be
specified.

Accepted values are:

   COLUMNNAME, DATATYPE, SCHEMANAME, TABLENAME

--sort-order [text]

The sort order to use, either ascending (ASC) or descending (DESC).

Accepted values are:

   ASC, DESC

--table-name [text]

A filter to return only items related to specific table name.

--table-name-contains [text]

A filter to return only items if table name contains a specific
string.


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 and paste the following example into a JSON file, replacing the
example parameters with your own.

       oci data-safe target-database create --generate-param-json-input database-details > database-details.json

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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-safe/target-database/create.html#cmdoption-compartment-id

       target_database_id=$(oci data-safe target-database create --compartment-id $compartment_id --database-details file://database-details.json --query data.id --raw-output)

       oci data-safe target-database list-columns --target-database-id $target_database_id
