synchronous-export

Description

Export technical objects from a Data Asset

Usage

oci data-catalog data-asset synchronous-export [OPTIONS]

Required Parameters

--catalog-id [text]

Unique catalog identifier.

--data-asset-key [text]

Unique data asset key.

--export-type [text]

Type of export.

Accepted values are:

ALL, CUSTOM_PROPERTY_VALUES
--file [filename]

The name of the file that will receive the response data, or ‘-‘ to write to STDOUT.

Optional Parameters

--export-scope [complex type]

Array of objects and their child types to be selected for export.

This option is a JSON list with items of type DataAssetExportScope. For documentation on DataAssetExportScope please see our API reference: https://docs.cloud.oracle.com/api/#/en/datacatalog/20190325/datatypes/DataAssetExportScope. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

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

Example using required parameter

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-catalog/catalog/create.html#cmdoption-compartment-id
    export data_asset_key=<substitute-value-of-data_asset_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-catalog/data-asset/synchronous-export.html#cmdoption-data-asset-key
    export export_type=<substitute-value-of-export_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-catalog/data-asset/synchronous-export.html#cmdoption-export-type
    export file=<substitute-value-of-file> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-catalog/data-asset/synchronous-export.html#cmdoption-file

    catalog_id=$(oci data-catalog catalog create --compartment-id $compartment_id --query data.id --raw-output)

    oci data-catalog data-asset synchronous-export --catalog-id $catalog_id --data-asset-key $data_asset_key --export-type $export_type --file $file