asset data-asset upload

Upload the local path as an asset attachment.

Syntax

cpd-cli asset data-asset upload \
--asset-id=<asset-guid> \
[--catalog-id=<catalog-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-config-location>] \
[--description=<description>] \
[--file=<upload-file-path>] \
[--jmes-query=<jmespath-query>] \
[--mime=<mime-type>] \
[--name=<upload-name>] \
[--origin-country=<data-asset-country>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--progress=true|false] \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--revision-id=<revision-id>] \
[--space-id=<space-identifier>] \
[--tags=<tag1,tag2,...>] \
[--verbose]

Arguments

The asset data-asset upload command has no arguments.

Options

Option Description
--asset-id Specify the asset GUID.
Status
Required.
Syntax
--asset-id=<asset-guid>
Default value
No default.
Valid values
Any valid asset GUID.
--catalog-id Specify either a catalog ID,
project ID, or space ID (specify only one).
Status
Optional.
Syntax
--catalog-id=<catalog-id>
Default value
No default.
Valid values
A valid catalog, project or space ID.
--context Specify the configuration context 
name.
Status
Optional.
Syntax
--context=<catalog-project-or-space-id>
Default value
Not applicable.
Valid values
A valid configuration context name.
--cpd-config The Cloud Pak for Data
configuration location (for example, $HOME/.cpd-cli/config).
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
No default.
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data space, project, or catalog scope (for example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135).
Status
Optional.
Syntax
--cpd-scope=<cpd-config-location>
Default value
No default.
Valid values
A valid Cloud Pak for Data space, project, or catalog scope.
--description Specify a data asset
 description.
Status
Optional.
Syntax
--description=<description>
Default value
No default.
Valid values
A valid data asset description.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--file Specify the path and name of the file to upload.
Status
Optional.
Syntax
--file=<upload-file-path>
Default value
No default.
Valid values
A valid path and file name.
--jmes-query The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid lucene query.
--mime Specify the file content mime
type.
Status
Optional.
Syntax
--mime=<mime-type>
Default value
Determined by the file content.
Valid values
A valid file content mime type.
--name Specify the data asset
 name.
Status
Required.
Syntax
--name=<upload-name>
Default value
No default.
Valid values
A valid data asset name.
--origin-country Specify the data asset ISO 3166 origin country code.
Status
Optional.
Syntax
--origin-country=<data-asset-country>
Default value
us
Valid values
A valid ISO 3166 origin country code.
--output Specify an output format. Valid formats include json, yaml, or text (the default format).
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
json|yaml|text
--output-file Specify a file path where all output is redirected.
Status
Required.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--profile The profile-name from the Cloud Pak for Data configuration.
Status
Required.
Syntax
--profile=<cpd-configuration-profile-name>
Default value
default
Valid values
Any valid profile name from the Cloud Pak for Data configuration.
--progress Show the upload
 progress.
Status
Optional.
Syntax
--progress=true|false
Default value
true
Valid values
true
Show the upload progress.
false
Do not show the upload progress.
--project-id Specify a Cloud Pak for Data project instance.
Status
Required.
Syntax
--project-id=<cpd-project-id>
Default value
No default.
Valid values
A valid project identifier.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values in
 JSON output mode are not surrounded by quotes.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotes.
true
Single values in JSON output mode are not surrounded by quotes.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--tags Specify the data asset tags. Multiple tags can be specified.
Status
Optional.
Syntax
--tags=<tag1,tag2,...>
Default value
No default.
Valid values
A valid list of comma-separated data asset tags.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can optionally add the listed environment variables to the install variables script. For more information, see Best practice: Setting up install variables.
Specify the environment variables in a script file.
project_id = <The Cloud Pak for Data project instance>
upload_dataset_name = "housing_data.csv"
Create a data asset in the Cloud Pak for Data project from a downloaded file.
cpd-cli asset data-asset upload \
--file=${upload_dataset_name} \
--mime="text/csv" \
--progress=true \
--project-id=${PROJECT_CPD_INSTANCE} \
--tags="cpdctl-demo"
Example output:

...
40.65 KiB / 40.43 KiB [---------------------------------------] 100.54% ? p/s 0s
                  
ID:            17ebcd96-588e-4287-9cb9-eb4608a4693e   
Name:          housing_data.csv   
Created:       2021-01-29T10:20:26.000Z   
Description:      
Type:          data_asset   
State:         available   
Tags:          [cpdctl-demo]   
Size:          41399   
Attachments:   ID                                     Name               Type         Mime Type      
               7f6c9650-36e5-414e-9620-8e8f0bf90c71   housing_data.csv   data_asset   text/csv