---
name: watsonxdata-cpdctl_commands_wxdata
title: '`wx-data` Commands and Usage'
description: ''
last-updated: 2026-03-02
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/watsonxdata?format=markdown
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

{:javascript: #javascript .ph data-hd-programlang='javascript'}
{:java: #java .ph data-hd-programlang='java'}
{:ruby: #ruby .ph data-hd-programlang='ruby'}
{:php: #php .ph data-hd-programlang='php'}
{:python: #python .ph data-hd-programlang='python'}
{:external: target="_blank" .external}
{:shortdesc: .shortdesc}
{:codeblock: .codeblock}
{:screen: .screen}
{:tip: .tip}
{:important: .important}
{:note: .note}
{:deprecated: .deprecated}
{:pre: .pre}
{:video: .video}

# `wx-data` Commands and Usage
{: #cpdctl_commands_wxdata}

The `wx-data` command further has different commands within, using which you can perform various operations specific to IBM® watsonx.data. This topic lists the commands with a brief description of the tasks that can be performed.

The `wx-data` command performs operations such as ingesting data, managing engines, storage, and data sources in watsonx.data.

Syntax:
   ```bash
   ./cpdctl wx-data [command] [options]
   ```
   {: codeblock}


The `wx-data` command supports the following commands:

- `ingestion`
- `engine`
- `bucket`
- `database`
- `sparkjob`
- `tablemaint`
- `service`
- `component`
- `access-control`

## How to Use `wx-data` Command --help (-h)
{: #cpdctl_commands_wxdatahwto}

To list all the commands in the `wx-data` plugin:
   ```bash
   ./cpdctl wx-data --help
   ```
   {: codeblock}

To get details of all options and its descriptions for a specific command in `wx-data` plugin:
   ```bash
   ./cpdctl wx-data [command] --help
   ```
   {: codeblock}

For example:

   ```bash
   ./cpdctl wx-data ingestion -h
   NAME:
      ingestion - Commands for Ingestion resource.

   USAGE:
      cpdctl wx-data ingestion [action]

   COMMANDS:
      list     List ingestion jobs.
      create   Create an ingestion job.
      get      Get ingestion job details.

   GLOBAL OPTIONS:
         --cpd-config string   Configuration file path
         --cpdconfig string    [Deprecated] Use --cpd-config instead
     -h, --help                Show help
         --profile string      Name of the configuration profile to use
     -q, --quiet               Suppresses verbose messages.
         --raw-output          If set to true, single values in JSON output mode are not surrounded by quotes

   Use "cpdctl wx-data ingestion service-command --help" for more information about a command.
   ```
   {: screen}

To get the details of all available options and arguments in the wx-data commands to execute an operation:
   ```bash
   ./cpdctl wx-data [command] [options] --help
   ```
   {: codeblock}

To use the wx-data plugin to execute an operation:
   ```bash
   ./cpdctl wx-data [command] [options]
   ```
   {: codeblock}


## ingestion
{: #cpdctl_commands_wxdataingst}

The `ingestion` command is used for executing different ingestion operations in watsonx.data.

Syntax:
   ```bash
   ./cpdctl wx-data ingestion [options]
   ```
   {: codeblock}

The `ingestion` command further supports the following commands:

| Command | Description |
| --------- | ------------- |
| `./cpdctl wx-data ingestion list` | Lists the ingestion jobs executed in watsonx.data instance. |
| `./cpdctl wx-data ingestion create` | Create an ingestion job in watsonx.data instance. |
| `./cpdctl wx-data ingestion get` | Get the details of an ingestion job executed in watsonx.data instance. |
 {: caption="Supported commands by ingestion" caption-side="bottom"}


## engine
{: #cpdctl_commands_wxdataeng}

The `engine` command is used for executing different engine-related operations in watsonx.data.

Syntax:
   ```bash
   ./cpdctl wx-data engine [options]
   ```
   {: codeblock}

The `engine` command further supports the following commands:

| Command | Description |
| --------- | ------------- |
| `./cpdctl wx-data engine list` | Lists all the engines available in watsonx.data instance. |
| `./cpdctl wx-data engine create` | Create or register an engine in watsonx.data instance. |
| `./cpdctl wx-data engine delete` | Delete an engine from watsonx.data instance. |
| `./cpdctl wx-data engine attach` | Associate catalogs to a Presto engine in watsonx.data instance. |
| `./cpdctl wx-data engine detach` | Disassociate the catalogs associated with a Presto engine in watsonx.data instance. |
 {: caption="Supported commands by engine" caption-side="bottom"}

## bucket
{: #cpdctl_commands_wxdatabuck}

The `bucket` command is used for executing different storage-related operations in watsonx.data.

Syntax:
   ```bash
   ./cpdctl wx-data bucket [options]
   ```
   {: codeblock}

The `bucket` command further supports the following commands:

watsonx.data  automatically activates any newly created storage without requiring an associated catalog, eliminating the need for manual activation.
{: note}

| Command | Description |
| --------- | ------------- |
| `./cpdctl wx-data bucket list` | Lists all the storages available in watsonx.data instance. |
| `./cpdctl wx-data bucket create` | Register a storage in watsonx.data instance. Use of secrets from an external vault (HashiCorp) is enabled with `create` option. |
| `./cpdctl wx-data bucket get` | Get the details of a registered storage in watsonx.data instance. |
| `./cpdctl wx-data bucket delete` | Delete a storage from watsonx.data instance. |
| `./cpdctl wx-data bucket activate` | Activate a storage bucket in watsonx.data on IBM Cloud instance only. |
| `./cpdctl wx-data bucket deactivate` | Deactivate a storage bucket in watsonx.data on IBM Cloud instance only. This option is not supported from watsonx.data 2.2.1 version. |
| `./cpdctl wx-data bucket list-objects` | List all objects in the bucket. |
| `./cpdctl wx-data bucket upload` | Upload a file from local filesystem to a watsonx.data object storage bucket. |
 {: caption="Supported commands by bucket" caption-side="bottom"}

Limitations:

* When using the `list-objects` command, buckets with a large number of objects might not list all objects because of API timeouts.
* When using the `--paginated` parameter with the `list-objects` command, only top-level objects are listed. Nested objects are not expanded by default.
* Listing the objects using `list-objects` is not supported in ADLS and GCS buckets currently.

## database
{: #cpdctl_commands_wxdatadatabs}

The `database` command is used for executing different data source-related operations in watsonx.data.

Syntax:
   ```bash
   ./cpdctl wx-data database [options]
   ```
   {: codeblock}

The `database` command further supports the following commands:

| Command | Description |
| --------- | ------------- |
| `./cpdctl wx-data database list` | Lists all the data sources available in watsonx.data instance. |
| `./cpdctl wx-data database create` | Create or add a data source in watsonx.data instance. Use of secrets from an external vault (HashiCorp) is enabled with `create` option. |
| `./cpdctl wx-data database get` | Get the details of a registered data source in watsonx.data instance. |
| `./cpdctl wx-data database delete` | Delete a data source from watsonx.data instance. |
 {: caption="Supported commands by database" caption-side="bottom"}

## sparkjob
{: #cpdctl_commands_wxdatasprkjb}

The `sparkjob` command is used for executing different Spark-related operations in watsonx.data version 2.1.2 and later.

Syntax:
   ```bash
   ./cpdctl wx-data sparkjob [options]
   ```
   {: codeblock}

The `sparkjob` command further supports the following commands:

| Command | Description |
| --------- | ------------- |
| `./cpdctl wx-data sparkjob list` | List all applications available in a Spark engine. |
| `./cpdctl wx-data sparkjob create` | Submit a Spark application. |
| `./cpdctl wx-data sparkjob get` | Get the status of a Spark application. |
 {: caption="Supported commands by sparkjob" caption-side="bottom"}

For more information about how to Submit Spark application by using IBM cpdctl in watsonx.data on IBM Cloud, see [Submitting Spark application by using IBM cpdctl](https://cloud.ibm.com/docs/watsonxdata?topic=watsonxdata-nsp_cpdctl&format=markdown).

## tablemaint
{: #cpdctl_commands_tabmaint}

The tablemaint command is used for executing different Iceberg table maintenance operations in watsonx.data.

This is now applicable only for Amazon S3 storage.
{: important}

Syntax:
   ```bash
   ./cpdctl wx-data tablemaint [options]
   ```
   {: codeblock}

The tablemaint command supports the following commands:

|Options|Description|
|---------|-------------|
|`./cpdctl wx-data tablemaint rollback-to-snapshot`|Roll back, or restore the table to a specific snapshot ID.|
|`./cpdctl wx-data tablemaint rollback-to-timestamp`|Roll back a table to the snapshot at a specific timestamp.|
|`./cpdctl wx-data tablemaint set-current-snapshot`|Sets the current snapshot ID for a table.|
|`./cpdctl wx-data tablemaint cherrypick-snapshot`|Cherry-picks changes from a snapshot into the current table state. Cherry-picking creates a new snapshot from an existing snapshot without altering or removing the original.|
|`./cpdctl wx-data tablemaint expire-snapshot`|Remove older snapshots and their files which are no longer needed.|
|`./cpdctl wx-data tablemaint remove-orphan`|Remove files that are not referenced in any metadata files of an Iceberg table and can thus be considered "orphaned".|
|`./cpdctl wx-data tablemaint rewrite-data`|Rewrites the data files.|
|`./cpdctl wx-data tablemaint rewrite-manifests`|Rewrite manifests for a table to optimize scan planning.|
|`./cpdctl wx-data tablemaint register-table`|Creates a table.|
 {: caption="Supported commands by tablemaint" caption-side="bottom"}

The following flags are listed when you run each table maintenance command:

   * Force : If the value is set to TRUE, the SQL query that you are going to run will be printed.

   * Debug : If the value is set to TRUE, a copy of the Spark application file is stored to our computer.

For more information about perform Iceberg table maintenance operations by using IBM cpdctl in watsonx.data on IBM Cloud, see [Spark table maintenance](https://cloud.ibm.com/docs/watsonxdata?topic=watsonxdata-nsp_cpdctl&format=markdown).


## service
{: #cpdctl_commands_wxdatasvce}

The `service` command is used for executing different serviceability related operations in watsonx.data.

Syntax:
   ```bash
   ./cpdctl wx-data service [options]
   ```
   {: codeblock}

The `service` command further supports the following commands:

| Command | Description |
| --------- | ------------- |
| `./cpdctl wx-data service list-tables` | Lists all table names of hive or iceberg connectors in watsonx.data instance. |
| `./cpdctl wx-data service get-qhmm-config` | Get the qhmm enabled bucket name in watsonx.data instance. |
| `./cpdctl wx-data service monitor` | To run stats and qhmm related queries in watsonx.data instance. |
| `./cpdctl wx-data service generate-engine-dump` | Generate heap or thread dump specific to Presto worker or coordinator watsonx.data instance. |
 {: caption="Supported commands by service" caption-side="bottom"}


## component
{: #cpdctl_commands_wxdatacmpnt}

The `component` command is used for executing different serviceability related operations in watsonx.data.

Syntax:
   ```bash
   ./cpdctl wx-data component [options]
   ```
   {: codeblock}

The `component` command further supports the following commands:

| Command | Description |
| --------- | ------------- |
| `./cpdctl wx-data component get-mds-status` | Get configuration for Metadata Service (MDS) in watsonx.data instance. |
| `./cpdctl wx-data component get-ces-status` | Get CES status in watsonx.data instance. |
| `./cpdctl wx-data component get-cas-cpg-endpoint` | Get CPG and CAS endpoints in watsonx.data instance. |
| `./cpdctl wx-data component get-hms-status` | List all HMS meta stores in watsonx.data instance. |
| `./cpdctl wx-data component get-console-status` | Check console status of watsonx.data instance watsonx.data instance. |
 {: caption="Supported commands by component" caption-side="bottom"}

## access-control
{: #cpdctl_commands_wxdataacscntrl}

The `access-control` command is used for managing access policies for resources in watsonx.data from CPDCTL version 1.8.33.

Syntax:
   ```bash
   ./cpdctl wx-data access-control [options]
   ```
   {: codeblock}

The `access-control` command further supports the following commands:

| Command | Description |
| --------- | ------------- |
| `./cpdctl wx-data access-control list-users-groups` | Get users and groups who have access to watsonx.data instance. |
| `./cpdctl wx-data access-control list-access` | List resource access policies. |
| `./cpdctl wx-data access-control update-access` | Update resource access policies. |
| `./cpdctl wx-data access-control revoke-access` | Revoke resource access policies. |
{: caption="Supported commands by access-control" caption-side="bottom"}