connection datasource-type list

List all defined data source types.

Syntax

cpd-cli connection datasource-type list \
[--accept-language=<user-locale>] \
[--actions=true|false] \
[--connection-properties=true|false] \
[--context=source|target] \
[--cpd-config=<cpd-config-location>] \
[--discovery=true|false] \
[--entity-environment=<cloud,streams,local>] \
[--entity-product=<string1,string2,...>] \
[--interaction-properties=true|false] \
[--jmes-query=<jmespath-query>] \
[--limit=<resource-limit>] \
[--offset=<resource-offset>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--product-selector-scope=global|context] \
--profile=<cpd-profile-name> \
[--quiet] \
[--raw-output=true|false] \
[--sort=<field-sort-order>] \
[--verbose]

Arguments

The connection datasource-type list command has no arguments.

Options

Option Description
--accept-language Specify the user's preferred locale identifier.
Status
Optional.
Syntax
--accept-language=<user-locale>
Default value
No default.
Valid values
Any valid language locale identifier (for example 'en' for English).
--actions When the option is set to 'true', supported action information is returned.
Status
Optional.
Syntax
--actions=true|false
Default value
true
Valid values
true
Supported action information is returned.
false
Supported action information is not returned.
--connection-properties When the option is set to 'true',
 connection property information is returned.
Status
Optional.
Syntax
--connection-properties=true|false
Default value
true
Valid values
A valid connection path.
--context Specify whether assets are discovered for 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 reading.
target
Assets are discovered for 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
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.
--datasource-type Specify the name or ID of the data
source type to connect to. For example, "cfdcb449-1204-44ba-baa6-9a8a878e6aa7" or
"db2".
Status
Required.
Syntax
--datasource-type=<datasaource-type-id>
Default value
No default.
Valid values
A valid data source name or ID.
--discovery When the option is set to 'true', discovery capability information is returned.
Status
Optional.
Syntax
--discovery=true|false
Default value
true
Valid values
true
Discovery capability information is returned.
false
Discovery capability information is not returned.
--entity-environment Specify the environment that the
 data source type must support to be returned. The available environments are 'cloud',
'streams', and 'local'. Filtering is not applied unless the entity environment is specified. Use a
 comma-separated string to specify multiple environments. For example,
--entity-environment=cloud,streams.
Status
Optional.
Syntax
--entity-environment=<cloud,streams,local>
Default value
No default.
Valid values
A comma-separated string of data source types (cloud, streams, and local).
--entity-product Specify the product that the data
source type must support to be returned. The available products are 'catalog', 'cpd',
'datastage', 'dv', 'igc', 'mdi', 'ml', and 'studio'. Filtering is not applied unless the entity product is specified. Use a comma-separated string to specify multiple environments. For example,
--entity-product=catalog,studio.
Status
Optional.
Syntax
--entity-product=<string1,string2,...>
Default value
No default.
Valid values
A valid product name.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--interaction-properties When set to 'true', information about source and target interaction properties is returned.
Status
Optional.
Syntax
--interaction-properties=true|false
Default value
false
Valid values
false
Information about source and target interaction properties is not returned.
true
Information about source and target interaction properties is returned.
--jmes-query The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid Lucene query.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--product-selector-scope Specify the scope of the UI-only product selector property. The option applies to output under the common_properties key. Generated
 UI contains an option to switch between the first of the requested products and the rest. When a single product is specified, the option switches between the specified product and the remaining products that are supported by the data source.
Status
Optional.
Syntax
--product-selector-scope=global|context
Default value
global
Valid values
global
Sets the UI-only product selector property to 'global'.
context
Sets the UI-only product selector property to 'context'.
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values are not surrounded by quotation marks in
 JSON output mode.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--sort The field to
 sort the results on, including whether to sort ascending (+) or descending (-). For example,
 '--sort=-metadata.create_time'.
Status
Optional.
Syntax
--sort=<field-sort-order>
Default value
No default.
Valid values
A valid field sort order.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Table 1: Command options

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can add the listed environment variables to the installation variables script. For more information, see Best practice: Setting up installation environment variables.
List data source types.
cpd-cli connection datasource-type list \
List data source types, sorted by entity.name, and limited to 5 results.
cpd-cli connection datasource-type list \
--limit=5
--sort=entity.name

Example results:


ID                                     Name               Description                                          Type   Tags   
a0b1d14a-4767-404c-aac1-4ce0e62818c3   amazons3           Amazon Simple Storage Service (S3)                   file   []   
81bafdbd-b7c6-45c5-a4fd-6ec135f66f4e   assetfiles         Asset Files                                          file   []   
9a22e0af-8d19-4c4e-9aea-1d733e81315b   azureblobstorage   Microsoft Azure Blob Storage                         file   []   
2a7b4fa1-c770-4807-8871-a3c5def5aa2d   azurefilestorage   Microsoft Azure File Storage                         file   []   
Next token: 'https://internal-nginx-svc:12443/v2/datasource_types?offset=5&limit=5&sort=entity.name'
List private data source types that support the igc product type.
cpd-cli connection datasource-type list \
--entity-environment=private
--entity-product=igc

Example results:


ID                                     Name               Description                       Type       Tags   
0fd83fe5-8995-4e2e-a1be-679bb8813a6d   hive               Apache Hive database              database   []   
48695e79-6279-474a-b539-342625d3dfc2   sqlserver          Microsoft SQL Server database     database   []   
8c1a4480-1c29-4b33-9086-9cb799d7b157   db2                IBM Db2 database                  database   []   
8e65204d-6156-49e7-96e5-d635b2aa05f6   mongodb-ibmcloud   Databases for MongoDB database    database   []   
971223d3-093e-4957-8af9-a83181ee9dd9   oracle             Oracle database                   database   []   
c10e5224-f17d-4524-844f-e97b1305e489   hdfs-apache        Apache HDFS via the WebHDFS API   file       []   
c6fb9293-51eb-4f2b-b20c-4dafa3136744   mongodb            MongoDB database                  database   []   
cfdcb449-1204-44ba-baa6-9a8a878e6aa7   dashdb             Db2 Warehouse                     database   []   
e59b1c36-6f30-4879-9f74-7e81dde4cca6   genericjdbc        Generic JDBC database             database   []