[CLI-3590] Rename `tableflow topic [create | delete]` to `[enable | disable]` and add `[create | delete]` as aliases #3090

sgagniere · 2025-05-08T05:58:43Z

Release Notes

Breaking Changes

PLACEHOLDER

New Features

Rename confluent tableflow topic create to confluent tableflow topic enable, and add create as an alias to preserve existing workflows and avoid a breaking change
Rename confluent tableflow topic delete to confluent tableflow topic disable, and add delete as an alias to preserve existing workflows and avoid a breaking change

Bug Fixes

Improve error messages for various delete commands

Checklist

What

Rename Cloud commands confluent tableflow topic [create | delete] to confluent tableflow topic [enable | disable], but keep create and delete as aliases to prevent breaking changes.

In order to make the wording of outputs and error messages consistent with the delete -> disable change, the bulk deletion code has been updated to not hardcode "delete" in strings. Some code duplication has been removed as well.

This has also improved output strings for the plugin uninstall command, which now uses uninstall instead of delete in the confirmation prompts and error messages.

This PR also adds some new integration tests for schema-registry kek [delete | undelete] to 1) improve test coverage and 2) make sure that removing duplicate code in the bulk deletion code didn't alter these outputs.

Finally, I removed some redundant error wrapping.

Blast Radius

The blast radius of the primary change should be 0, since aliases have been added to preserve the existing behavior. Any issues with the updates to the bulk deletion code could affect the wording of confirmation prompts and deletion error messages of any delete command (although the actual behavior should not be affected).

References

Test & Review

Added new integration tests for confluent tableflow topic [enable | disable] and kept existing integration tests for create and delete to check the validity of those aliases.
Added new integration tests for confluent sr kek [delete | undelete] and on-prem confluent kafka link delete to test the wording of the confirmation prompts.

Manual Testing:
Enable:

confluent tableflow topic enable test-tableflow-topic --retention-ms 604900000 --storage-type MANAGED                                     
+-------------------------+----------------------+
| Kafka Cluster           | lkc-xq5vrx           |
| Topic Name              | test-tableflow-topic |
| Enable Compaction       | true                 |
| Enable Partitioning     | true                 |
| Environment             | env-7y5pjj           |
| Record Failure Strategy | SUSPEND              |
| Retention Ms            | 604900000            |
| Storage Type            | MANAGED              |
| Suspended               | false                |
| Table Formats           | ICEBERG              |
| Phase                   | PENDING              |
+-------------------------+----------------------+

Create (Alias):

confluent tableflow topic create test-tableflow-topic-2 --retention-ms 604900000 --storage-type MANAGED                                        
+-------------------------+------------------------+
| Kafka Cluster           | lkc-xq5vrx             |
| Topic Name              | test-tableflow-topic-2 |
| Enable Compaction       | true                   |
| Enable Partitioning     | true                   |
| Environment             | env-7y5pjj             |
| Record Failure Strategy | SUSPEND                |
| Retention Ms            | 604900000              |
| Storage Type            | MANAGED                |
| Suspended               | false                  |
| Table Formats           | ICEBERG                |
| Phase                   | PENDING                |
+-------------------------+------------------------+

Disable:

confluent tableflow topic disable test-tableflow-topic test-tableflow-topic-2
Are you sure you want to disable topics "test-tableflow-topic" and "test-tableflow-topic-2"? (y/n): y
Requested to disable topics "test-tableflow-topic" and "test-tableflow-topic-2".

Delete (alias; after recreating/re-enabling the two topics):

confluent tableflow topic delete test-tableflow-topic test-tableflow-topic-2
Are you sure you want to delete topics "test-tableflow-topic" and "test-tableflow-topic-2"? (y/n): y
Requested to delete topics "test-tableflow-topic" and "test-tableflow-topic-2".

Help output for enable, showing alias:

confluent tableflow topic enable -h
Enable a topic.

Usage:
  confluent tableflow topic enable <name> [flags]

Aliases:
  enable, create

Examples:
Enable a BYOS Tableflow topic related to a Kafka cluster.

  $ confluent tableflow topic enable my-tableflow-topic --cluster lkc-123456 --retention-ms 604800000 --storage-type BYOS --provider-integration cspi-stgce89r7 --bucket-name bucket_1

Enable a confluent managed Tableflow topic related to a Kafka cluster.

  $ confluent tableflow topic enable my-tableflow-topic --cluster lkc-123456 --retention-ms 604800000 --storage-type MANAGED

Flags:
      --cluster string                   Kafka cluster ID.
      --retention-ms string              Specify the max age of snapshots (Iceberg) or versions (Delta) (snapshot/version expiration) to keep on the table in milliseconds for the Tableflow enabled topic. (default "604800000")
      --storage-type string              Specify the storage type of the Kafka cluster, one of MANAGED or BYOS. (default "MANAGED")
      --provider-integration string      Specify the provider integration id.
      --bucket-name string               Specify the name of the AWS S3 bucket.
      --table-formats string             Specify the table formats, one of DELTA or ICEBERG. (default "ICEBERG")
      --record-failure-strategy string   Specify the record failure strategy, one of SUSPEND or SKIP. (default "SUSPEND")
      --context string                   CLI context name.
      --environment string               Environment ID.
  -o, --output string                    Specify the output format as "human", "json", or "yaml". (default "human")

Global Flags:
  -h, --help            Show help for this command.
      --unsafe-trace    Equivalent to -vvvv, but also log HTTP requests and responses which might contain plaintext secrets.
  -v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).

Help output for disable, showing alias:

confluent tableflow topic disable -h
Disable topics.

Usage:
  confluent tableflow topic disable <name-1> [name-2] ... [name-n] [flags]

Aliases:
  disable, delete

Examples:
Disable a Tableflow topic "my-tableflow-topic" related to a Kafka cluster "lkc-123456".

  $ confluent tableflow topic disable my-tableflow-topic --cluster lkc-123456

Flags:
      --cluster string       Kafka cluster ID.
      --force                Skip the deletion confirmation prompt.
      --context string       CLI context name.
      --environment string   Environment ID.

Global Flags:
  -h, --help            Show help for this command.
      --unsafe-trace    Equivalent to -vvvv, but also log HTTP requests and responses which might contain plaintext secrets.
  -v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).

confluent-cla-assistant · 2025-05-08T05:58:53Z

🎉 All Contributor License Agreements have been signed. Ready to merge.
_{Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.}

sgagniere · 2025-06-05T19:47:15Z

internal/network/command_network_link_service_delete.go

-			return fmt.Errorf(errors.DeleteResourceErrorMsg, resource.NetworkLinkService, id, err)
-		}
-		return nil
+		return c.V2Client.DeleteNetworkLinkService(environmentId, id)


The Delete (and DeleteWithoutMessage) functions already wrap these errors w/ a message nearly identical to DeleteResourceErrorMsg, so these changes are to remove redundant phrasing from error messages like Error: failed to delete n-abc123: failed to delete network "n-abc123": ...

sonarqube-confluent · 2025-06-05T20:35:34Z

Analysis Details

0 Issues

0 Bugs
0 Vulnerabilities
0 Code Smells

Coverage and Duplications

97.70% Coverage (77.20% Estimated after merge)
No duplication information (0.00% Estimated after merge)

Project ID: cli

View in SonarQube

cqin-confluent

Great job on this! Everything looks good to me 👍

sgagniere · 2025-06-09T20:24:52Z

Going to wait on merging this one.

rename tableflow topic create to enable and add create as an alias

8479172

This comment has been minimized.

Sign in to view

sgagniere added 3 commits June 4, 2025 18:20

rename tableflow topic delete to disable and add delete as an alias

aeb4c1c

Fix some of the wording

93a50a2

Add missing golden files

74267bf

This comment has been minimized.

Sign in to view

sgagniere added 6 commits June 5, 2025 00:57

Clean up delete, disable, and uninstall error messages

8dc2f5a

Add new tests for kek delete and undelete

4519579

Match messages to alias for delete and disable

1438cf6

remove redundant golden files

9c30ed7

Merge branch 'main' of https://github.com/confluentinc/cli into cli-3590

98ee1d4

Fix build errors after pulling from main

c54dfd0

This comment has been minimized.

Sign in to view

sgagniere commented Jun 5, 2025

View reviewed changes

Improve coverage

d953310

sgagniere marked this pull request as ready for review June 5, 2025 20:00

sgagniere requested a review from a team as a code owner June 5, 2025 20:00

sgagniere changed the title ~~[CLI-3590] Rename tableflow topic create to enable and add create as an alias~~ [CLI-3590] Rename tableflow topic [create | delete] to [enable | disable] and add [create | delete] as aliases Jun 5, 2025

cqin-confluent approved these changes Jun 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[CLI-3590] Rename `tableflow topic [create | delete]` to `[enable | disable]` and add `[create | delete]` as aliases #3090

[CLI-3590] Rename `tableflow topic [create | delete]` to `[enable | disable]` and add `[create | delete]` as aliases #3090

Uh oh!

sgagniere commented May 8, 2025 •

edited

Loading

Uh oh!

confluent-cla-assistant bot commented May 8, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

sgagniere Jun 5, 2025

Uh oh!

sonarqube-confluent bot commented Jun 5, 2025

Uh oh!

cqin-confluent left a comment

Uh oh!

sgagniere commented Jun 9, 2025

Uh oh!

Uh oh!

[CLI-3590] Rename tableflow topic [create | delete] to [enable | disable] and add [create | delete] as aliases #3090

Are you sure you want to change the base?

[CLI-3590] Rename tableflow topic [create | delete] to [enable | disable] and add [create | delete] as aliases #3090

Uh oh!

Conversation

sgagniere commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Notes

Checklist

What

Blast Radius

References

Test & Review

Uh oh!

confluent-cla-assistant bot commented May 8, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

sgagniere Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqube-confluent bot commented Jun 5, 2025

Analysis Details

0 Issues

Coverage and Duplications

Uh oh!

cqin-confluent left a comment

Choose a reason for hiding this comment

Uh oh!

sgagniere commented Jun 9, 2025

Uh oh!

Uh oh!

[CLI-3590] Rename `tableflow topic [create | delete]` to `[enable | disable]` and add `[create | delete]` as aliases #3090

[CLI-3590] Rename `tableflow topic [create | delete]` to `[enable | disable]` and add `[create | delete]` as aliases #3090

sgagniere commented May 8, 2025 •

edited

Loading