`datastage`

Important: IBM Cloud Pak® for Data Version 4.7 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.7 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Manage DataStage resources in Cloud Pak for Data.

Extended description

A DataStage® job consists of the following components:

A DataStage flow.
A runtime environment.
Job parameters.
Parameter sets.

Prerequisites

cpd-cli: Before you run any cpd-cli commands, ensure that you downloaded the cpd-cli 13.0.4 command-line utility for your operating system and Cloud Pak for Data edition. For more information, see Installing the Cloud Pak for Data command-line interface (cpd-cli).
Common core services: The datastage commands are relevant only when common core services are installed.

Required permissions

The datastage command requires cluster administrator or similar roles.

Commands

Table 1. `datastage` commands
Command	Description
`datastage codegen generate-buildop`	Generate the DataStage buildop runtime assets for a specific runtime type in the specified project or catalog.
`datastage flow clone`	Create a DataStage flow in the specified project or catalog that is based on an existing DataStage flow in the same project or catalog.
`datastage flow compile`	Generate the DataStage flow runtime assets for a specific runtime type in the specified project or catalog.
`datastage flow create`	Create a DataStage flow in the specified project or catalog. You must set either project_id or catalog_id.
`datastage flow delete`	Delete a DataStage flow in the specified project or catalog. You must set either project_id or catalog_id.
`datastage flow get`	Retrieve the DataStage flow that is contained in the specified project.
`datastage flow list`	List the metadata, entity, and lock information for DataStage flows that are contained in the specified project.
`datastage flow update`	Modify a data flow in the specified project or catalog. You must set either project_id or catalog_id.
`datastage migration create`	Modify a data flow in the specified project or catalog. You must set either project_id or catalog_id.
`datastage migration create-from-zip`	Create data flows from a job export file.
`datastage migration delete`	Cancel an import request.
`datastage migration delete-zip`	Cancel an import request that was started from a job export file.
`datastage migration export-flows-with-dependencies`	Export flows with dependencies to a compressed file.
`datastage migration get`	Retrieve the status of an import request.
`datastage migration get-zip`	Retrieve the status of an import request that was started from a job export file.
`datastage subflow clone`	Create a DataStage subflow in a specified project or catalog. The new subflow is based on an existing DataStage subflow in the same project or catalog.
`datastage subflow create`	Create a DataStage subflow in a specified project or catalog. You must set either project_id or catalog_id.
`datastage subflow delete`	Delete a DataStage subflow in a specified project or catalog. You must set project_id or catalog_id.
`datastage subflow get`	Retrieve the DataStage subflow that is contained in a specified project.
`datastage subflow list`	List the metadata, entity, and lock information for DataStage subflows that are contained in a specified project.
`datastage subflow update`	Modify a data flow in a specified project or catalog. You must set either project_id or catalog_id.
`datastage table-definition clone`	Clone a table definition.
`datastage table-definition create`	Create a table definition in a specified project or catalog. You must set either project_id or catalog_id.
`datastage table-definition delete`	Delete specified table definitions from a project or catalog. You must set either project_id or catalog_id.
`datastage table-definition get`	Retrieve a table definition.
`datastage table-definition list`	List table definitions that are contained in a specified project or catalog. You must set either project_id or catalog_id.
`datastage table-definition replace`	Replace the contents of a table definition in a specified project or catalog. You must set either project_id or catalog_id.
`datastage table-definition update`	Update a table definition in a specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library clone`	Clone a DataStage XML schema library based on a specific library ID in a specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library create`	Create a DataStage XML schema library in a specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library delete`	Delete a DataStage XML schema library in a specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library delete-files`	Delete files from a DataStage XML schema library that are based on file names in the specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library download`	Download files from a DataStage XML schema library that are based on file names in the specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library get`	Retrieve the DataStage XML schema library in the specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library list`	List the DataStage XML schema libraries in the specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library rename`	Rename a DataStage XML schema library based on a specific library ID in a specified project or catalog. You must set either project_id or catalog_id.
`datastage xml-schema-library upload`	Upload a file to an existing DataStage XML schema library in a specified project or catalog. You must set either project_id or catalog_id.