connection discover

Discover assets from the data source that is accessed through the connection.

Syntax

cpd-cli connection discover \
[--catalog-id=<catalog-id>] \
--connection-id=source|target \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-config-location>] \
[--data-asset-catalog-id=<data-asset-catalog-id>] \
[--data-asset-id=<data-asset-id>] \
[--data-asset-project-id=<data-asset-project-id>] \
[--data-asset-space-id=<data-asset-space-id>] \
[--detail=true|false] \
[--fetch=<asset-type1,asset-type2,...>] \
[--filters=<json-filter>] \
[--jmes-query=<jmespath-query>] \
[--limit=<resource-limit>] \
[--offset=<resource-offset>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--path=<asset-file-path> \
--profile=<cpd-configuration-profile-name> \
[--project-id=<cpd-project-id>] \
[--properties=<connections-properties>] \
[--quiet] \
[--raw-output=true|false] \
[--space-id=<space-identifier>] \
[--verbose]

Arguments

The connection discover command has no arguments.

Options

Option Description
--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.
--connection-id Specify the connection ID.
Status
Required.
Syntax
--connection-id=<connection-id>
Default value
No default.
Valid values
A valid connection ID.
--context Specify whether assets are discovered for the purpose of reading (source) or writing (target). 'source' is the default when
 no value is specified.
Status
Optional.
Syntax
--context=source|target
Default value
source
Valid values
source
Assets are discovered for the purpose of reading.
target
Assets are discovered for the purpose of writing.
--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.
--data-asset-catalog-id Specify the data asset catalog ID. A catalog_id, project_id, or space_id must also be specified.
Status
Required.
Syntax
--data-asset-catalog-id=<data-asset-catalog-id>
Default value
No default.
Valid values
A valid data asset catalog ID.
--data-asset-id Specify the data asset ID.
Status
Required.
Syntax
--data-asset-id=<data-asset-id>
Default value
No default.
Valid values
A valid data asset ID.
--data-asset-project-id Specify the data asset project ID. A catalog_id, project_id, or space_id must also be specified.
Status
Required.
Syntax
--data-asset-project-id=<data-asset-project-id>
Default value
No default.
Valid values
A valid data asset project ID.
--data-asset-space-id Specify the data asset space ID. A catalog_id, project_id, or space_id must also be specified.
Status
Required.
Syntax
--data-asset-space-id=<data-asset-space-id>
Default value
No default.
Valid values
A valid data asset space ID.
--detail When the option is set to 'true', additional asset-specific details are returned. When the option is set to 'false' specified, the details are
not returned.
Status
Optional.
Syntax
--detail=true|false
Default value
true
Valid values
true
Additional asset-specific details are returned.
false
Additional asset-specific details are not returned.
--fetch Specify whether to return the
 asset's metadata, the asset's data, interaction properties, connection properties, or the data
 source type. 'metadata' is the default when the option is not specified. The option applies only
 when requesting details about a data set. Use a comma-separated string to specify multiple fetch
 values (for example,
 --fetch=data,metadata,interaction,connection,datasource_type).
Status
Optional.
Syntax
--fetch=<asset-type1,asset-type2,...>
Default value
No default.
Valid values
A comma-separated string of asset properties.
--filters Specify a custom filters *.json file path. The default filters work for most cases.
Status
Optional.
Syntax
--filters=<json-file-path>
Default value
No default.
Valid values
A valid *.json file path. The following example provides typical filter formatting.
{
   "Custom": {
      "LDAP_USERFILTER": "(&(%s=%%v)(objectclass=ePerson))",
      "LDAP_GROUPFILTER": "(&(%s=%%v)(objectclass=groupOfUniqueNames))",
      "LDAP_USERIDMAP": "*:%s",
      "LDAP_GROUPIDMAP": "*:%s",
      "LDAP_GROUPMEMBERIDMAP": "groupOfUniqueNames:%s"
   }
}
The objectclass sections are customizable; the other strings are part of the template and must be left as is. In most cases, the defaults settings work. Editing the objectclass sections is only needed when special extended schema is used.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--jmes-query The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid lucene query.
--limit Specify the total number of
 resources.
Status
Optional.
Syntax
--limit=<resource-limit>
Default value
100
Valid values
An integer value in the range 0 - 200.
--offset Specify the 0-based index of the first result to return (for example, --offset=200). The default offset of 0 is used when no value is specified.
Status
Optional.
Syntax
Specify an offset value for
 returned resources.=<resource-offset>
Default value
0
Valid values
A valid offset value.
--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.
--path Specify the asset file path.
Status
Required.
Syntax
--path=<asset-file-path>
Default value
No default.
Valid values
A valid asset file path.
--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.
--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.
--properties Specify a JSON object
 that contains a set of properties to configure asset browsing
 aspects.
Status
Optional.
Syntax
--properties=<connections-properties>
Default value
No default.
Valid values
A valid JSON object.
--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.
--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.
Define the environment variables.
Replace the following properties with your data.
export CONNECTION_ID=<The connection identifier>
export PATH=<The asset file path> 
export PROJECT_CPD_INSTANCE=<The Cloud Pak for Data project instance>
Discover a connection.
cpd-cli connection discover \
--connection-id=${CONNECTION_ID} \
--path=${PATH} \
--project-id=${PROJECT_CPD_INSTANCE}