CF-1870 : Manage SQL Catalog databases through CLI by paras-negi-flink · Pull Request #3287 · confluentinc/cli

Paras Negi (paras-negi-flink) · 2026-03-22T02:41:21Z

Release Notes

Breaking Changes

None.

New Features

Added confluent flink catalog database create|list|describe|update|delete commands to manage Kafka databases (Kafka cluster connections) inside a Flink SQL catalog on Confluent Platform.

Bug Fixes

None.

Checklist

What

This PR implements CF-1870 — Manage SQL Catalog databases for the Confluent CLI, targeting Confluent Platform / CP Flink (CMF on-prem):

Adds a new command group under confluent flink catalog:
- confluent flink catalog database create <resourceFilePath> --catalog <catName>
- confluent flink catalog database list --catalog <catName>
- confluent flink catalog database describe <dbName> --catalog <catName>
- confluent flink catalog database update <resourceFilePath> --catalog <catName>
- confluent flink catalog database delete <dbName> --catalog <catName>
Wires these commands to the existing CMF KafkaDatabase REST APIs:
- POST/GET/PUT/DELETE /cmf/api/v1/catalogs/kafka/{catName}/databases[/ {dbName}].
Introduces a CmfRestClient wrapper for KafkaDatabase operations and corresponding local types/output formatting, following existing patterns used for catalogs and compute pools.

Blast Radius

Scope is limited to new Flink catalog database commands; existing CLI behavior (including other confluent flink and confluent kafka commands) is unchanged.
If something goes wrong:
- Impact is confined to users managing Kafka databases via the new commands:
  - Database creation/update/delete may fail or surface CMF errors.
  - Listing/describe may not show correct state for databases.
- No changes are made to Flyway migrations or catalog persistence; CMF remains the source of truth.
There are no breaking changes to existing commands, flags, or APIs. Removing or reverting this feature is straightforward (command group + client wrapper).

References

Jira: CF-1870 — CLI: Manage SQL Catalog databases
Epic: CF-3136 — 2026 Q1: Streamline CLI with CMF 2.3.0 APIs
CMF migration context (KafkaCatalog → KafkaDatabase): cp-flink-cmf PR that introduced KafkaDatabase and the Flyway migration (e.g., [CF-1772] Add flyway migration for KafkaCatalog -> KafkaDatabase).

Test & Review

Environment

Repo: confluentinc/cli
Branch: CF-1870
CMF: 2.3-SNAPSHOT (image: confluentinc/cp-cmf:c505ee8b) - Kubernetes: local cluster with CMF deployed (cmf-service exposed via kubectl port-forward svc/cmf-service 8080:80 -n e2e)

Manual CLI validation

Attached in the comment below

confluent-cla-assistant · 2026-03-22T02:41:30Z

❌ Error getting contributor login(s).
Please ensure the email address associated with this commit is added to your Github account.

… command

Copilot

Pull request overview

Adds Confluent Platform (CMF/on-prem) CLI support for managing Flink SQL catalog databases, along with integration test coverage and fixtures.

Changes:

Introduces confluent flink catalog database command group with create and list subcommands.
Extends CMF REST client with CreateDatabase and ListDatabases.
Updates on-prem test server routes/handlers and adds integration tests + golden/input fixtures for the new commands.

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`internal/flink/command_catalog.go`	Registers the new `database` subcommand under `flink catalog`.
`internal/flink/command_catalog_database.go`	Adds the `database` command group and SDK→local conversion for serialized output.
`internal/flink/command_catalog_database_create.go`	Implements `flink catalog database create` from a JSON/YAML resource file.
`internal/flink/command_catalog_database_list.go`	Implements `flink catalog database list` with human + serialized output.
`internal/flink/local_types.go`	Adds local (serialized) types for KafkaDatabase output.
`pkg/flink/cmf_rest_client.go`	Adds CMF client methods to create/list Kafka databases (paginated).
`test/test-server/flink_onprem_router.go`	Adds the CMF test-server route for catalog databases.
`test/test-server/flink_onprem_handler.go`	Adds test-server handler + helpers for listing/creating databases.
`test/flink_onprem_test.go`	Adds integration tests for on-prem database create/list.
`test/fixtures/input/flink/catalog/database/create-successful.json`	Input fixture for successful database creation.
`test/fixtures/input/flink/catalog/database/create-invalid-failure.json`	Input fixture for validation failure on create.
`test/fixtures/output/flink/catalog/help-onprem.golden`	Updates catalog help output to include `database`.
`test/fixtures/output/flink/catalog/database/help-onprem.golden`	Adds help fixture for `flink catalog database`.
`test/fixtures/output/flink/catalog/database/create-help-onprem.golden`	Adds help fixture for `flink catalog database create`.
`test/fixtures/output/flink/catalog/database/list-help-onprem.golden`	Adds help fixture for `flink catalog database list`.
`test/fixtures/output/flink/catalog/database/create-success.golden`	Human output golden for create success.
`test/fixtures/output/flink/catalog/database/create-success-json.golden`	JSON output golden for create success.
`test/fixtures/output/flink/catalog/database/create-success-yaml.golden`	YAML output golden for create success.
`test/fixtures/output/flink/catalog/database/create-invalid-failure.golden`	Error output golden for create failure.
`test/fixtures/output/flink/catalog/database/list-success.golden`	Human output golden for list success.
`test/fixtures/output/flink/catalog/database/list-success-json.golden`	JSON output golden for list success.
`test/fixtures/output/flink/catalog/database/list-success-yaml.golden`	YAML output golden for list success.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/test-server/flink_onprem_handler.go

Copilot

Pull request overview

Copilot reviewed 42 out of 42 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/flink/command_catalog_database_delete.go

internal/flink/command_catalog_database_create.go

internal/flink/command_catalog_database_update.go

internal/flink/command_catalog_database.go

Copilot

Pull request overview

Copilot reviewed 42 out of 42 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/flink/command_catalog_database_delete.go

Paras Negi (paras-negi-flink) · 2026-04-03T02:57:26Z

Here are the E2E validations done for the new Flink catalog database commands in this PR, with concrete commands and outputs.

Create database (human output)

parasnegi@C6V9RN9V2Y confluent_darwin_arm64_v8.0 % ./confluent --url http://localhost:8080 flink catalog database create my-database.json --catalog kcat 
+---------------+--------------------------+
| Creation Time | 2026-04-03T02:51:11.634Z |
| Name          | my-database              |
| Catalog       | kcat                     |
+---------------+--------------------------+

Create database (JSON output)

parasnegi@C6V9RN9V2Y confluent_darwin_arm64_v8.0 % ./confluent --url http://localhost:8080 flink catalog database create my-database.json --catalog kcat --output json
{
  "apiVersion": "cmf.confluent.io/v1",
  "kind": "KafkaDatabase",
  "metadata": {
    "name": "my-database",
    "creationTimestamp": "2026-04-03T02:53:18.202Z",
    "updateTimestamp": "2026-04-03T02:53:18.202Z",
    "uid": "e01b7728-e578-4630-80fe-7c01e8b4e478",
    "labels": {
      "env": "dev",
      "team": "flink"
    },
    "annotations": {}
  },
  "spec": {
    "kafkaCluster": {
      "connectionConfig": {
        "bootstrap.servers": "localhost:9093"
      }
    }
  }
}

List databases

parasnegi@C6V9RN9V2Y confluent_darwin_arm64_v8.0 % ./confluent --url http://localhost:8080 flink catalog database list --catalog kcat          
       Creation Time       |     Name      | Catalog  
---------------------------+---------------+----------
  2026-03-25T14:08:11.397Z | free-kafka    | kcat     
  2026-03-26T06:16:54.494Z | test-database | kcat     
  2026-04-03T02:53:18.202Z | my-database   | kcat

Describe database

parasnegi@C6V9RN9V2Y confluent_darwin_arm64_v8.0 % ./confluent --url http://localhost:8080 flink catalog database describe my-database --catalog kcat
+---------------+--------------------------+
| Creation Time | 2026-04-03T02:53:18.202Z |
| Name          | my-database              |
| Catalog       | kcat                     |
+---------------+--------------------------+

Describe database (YAML)

parasnegi@C6V9RN9V2Y confluent_darwin_arm64_v8.0 % ./confluent --url http://localhost:8080 flink catalog database describe my-database --catalog kcat --output yaml 
apiVersion: cmf.confluent.io/v1
kind: KafkaDatabase
metadata:
    name: my-database
    creationTimestamp: "2026-04-03T02:53:18.202Z"
    updateTimestamp: "2026-04-03T02:53:18.202Z"
    uid: e01b7728-e578-4630-80fe-7c01e8b4e478
    labels:
        env: dev
        team: flink
    annotations: {}
spec:
    kafkaCluster:
        connectionConfig:
            bootstrap.servers: localhost:9093

Delete Database

parasnegi@C6V9RN9V2Y confluent_darwin_arm64_v8.0 % ./confluent --url http://localhost:8080 flink catalog database delete my-database --catalog kcat                  
Are you sure you want to delete Flink database "my-database"? (y/n): y
Deleted Flink database "my-database".
parasnegi@C6V9RN9V2Y confluent_darwin_arm64_v8.0 % ./confluent --url http://localhost:8080 flink catalog database list --catalog kcat                
       Creation Time       |     Name      | Catalog  
---------------------------+---------------+----------
  2026-03-25T14:08:11.397Z | free-kafka    | kcat     
  2026-03-26T06:16:54.494Z | test-database | kcat

Copilot

Pull request overview

Copilot reviewed 46 out of 46 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/flink/command_catalog_database_update.go

test/flink_onprem_test.go

sonarqube-confluent · 2026-04-03T07:36:39Z

Quality Gate passed

Issues
9 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
89.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

Add flink catalog database create command

0e30b78

Paras Negi added 5 commits March 23, 2026 17:37

Add golden test files for flink catalog database command

96a12c9

Add integration tests and fix golden files for flink catalog database…

33e3b89

… command

Fix flink_onprem_handler.go

36c006d

Add flink catalog database list command

d86fb7e

Fix build

2c09071

Paras Negi (paras-negi-flink) requested a review from Copilot March 30, 2026 13:48

Copilot started reviewing on behalf of Paras Negi (paras-negi-flink) March 30, 2026 13:48 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

test/test-server/flink_onprem_handler.go Outdated Show resolved Hide resolved

Paras Negi (paras-negi-flink) added 6 commits March 31, 2026 08:48

Merge branch 'main' into CF-1870

4e19e4f

Fix ListDatabases()

f85825b

Added Describe/GET database cli command

02dfaf2

Fix the golden files

3271eec

Added the update database cli command

8f3a1e1

Add flink catalog database update command

25d8693

Paras Negi (paras-negi-flink) requested a review from Copilot April 2, 2026 03:36

Copilot started reviewing on behalf of Paras Negi (paras-negi-flink) April 2, 2026 03:37 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

Copilot suggested fixes

c95ac55

Paras Negi (paras-negi-flink) requested a review from Copilot April 2, 2026 06:35

Copilot started reviewing on behalf of Paras Negi (paras-negi-flink) April 2, 2026 06:36 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

internal/flink/command_catalog_database_delete.go Show resolved Hide resolved

Add claude suggested fixes

021cf01

Paras Negi (paras-negi-flink) requested a review from Copilot April 3, 2026 03:56

Paras Negi (paras-negi-flink) marked this pull request as ready for review April 3, 2026 03:56

Paras Negi (paras-negi-flink) requested a review from a team as a code owner April 3, 2026 03:56

Copilot started reviewing on behalf of Paras Negi (paras-negi-flink) April 3, 2026 03:57 View session

Copilot AI reviewed Apr 3, 2026

View reviewed changes

internal/flink/command_catalog_database_update.go Show resolved Hide resolved

test/flink_onprem_test.go Show resolved Hide resolved

test/flink_onprem_test.go Show resolved Hide resolved

Fix the update method

977c3c9

Paras Negi (paras-negi-flink) requested review from Kumar Mallikarjuna (kumar-mallikarjuna) and Robert Metzger (rmetzger) April 3, 2026 07:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CF-1870 : Manage SQL Catalog databases through CLI#3287

CF-1870 : Manage SQL Catalog databases through CLI#3287
Paras Negi (paras-negi-flink) wants to merge 15 commits intomainfrom
CF-1870

Paras Negi (paras-negi-flink) commented Mar 22, 2026 •

edited

Loading

Uh oh!

confluent-cla-assistant bot commented Mar 22, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Paras Negi (paras-negi-flink) commented Apr 3, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqube-confluent bot commented Apr 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Paras Negi (paras-negi-flink) commented Mar 22, 2026 • 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 Mar 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Paras Negi (paras-negi-flink) commented Apr 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqube-confluent bot commented Apr 3, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Paras Negi (paras-negi-flink) commented Mar 22, 2026 •

edited

Loading