CF-1870 : Manage SQL Catalog databases through CLI #3287
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| package flink | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "gopkg.in/yaml.v3" | ||
|
|
||
| cmfsdk "github.com/confluentinc/cmf-sdk-go/v1" | ||
|
|
||
| pcmd "github.com/confluentinc/cli/v4/pkg/cmd" | ||
| "github.com/confluentinc/cli/v4/pkg/errors" | ||
| "github.com/confluentinc/cli/v4/pkg/output" | ||
| ) | ||
|
|
||
| type databaseOut struct { | ||
| CreationTime string `human:"Creation Time" serialized:"creation_time"` | ||
| Name string `human:"Name" serialized:"name"` | ||
| Catalog string `human:"Catalog" serialized:"catalog"` | ||
| } | ||
|
|
||
| func (c *command) newCatalogDatabaseCommand() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "database", | ||
| Short: "Manage Flink databases in Confluent Platform.", | ||
| Annotations: map[string]string{pcmd.RunRequirement: pcmd.RequireCloudLogout}, | ||
| } | ||
|
|
||
|
paras-negi-flink marked this conversation as resolved.
|
||
| cmd.AddCommand(c.newCatalogDatabaseCreateCommand()) | ||
| cmd.AddCommand(c.newCatalogDatabaseDeleteCommand()) | ||
| cmd.AddCommand(c.newCatalogDatabaseDescribeCommand()) | ||
| cmd.AddCommand(c.newCatalogDatabaseListCommand()) | ||
| cmd.AddCommand(c.newCatalogDatabaseUpdateCommand()) | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func printDatabaseOutput(cmd *cobra.Command, sdkDatabase cmfsdk.KafkaDatabase, catalogName string) error { | ||
| if output.GetFormat(cmd) == output.Human { | ||
| table := output.NewTable(cmd) | ||
| var creationTime string | ||
| if sdkDatabase.GetMetadata().CreationTimestamp != nil { | ||
| creationTime = *sdkDatabase.GetMetadata().CreationTimestamp | ||
| } | ||
| table.Add(&databaseOut{ | ||
| CreationTime: creationTime, | ||
| Name: sdkDatabase.GetMetadata().Name, | ||
| Catalog: catalogName, | ||
| }) | ||
|
Comment on lines
+48
to
+52
Contributor
There was a problem hiding this comment. Will it be a concern if human mode has such a difference compared to json or yml mode through
Contributor
There was a problem hiding this comment. This comment is not responded yet, the concern here is, is it ok for customers to see different set of fields in json, yaml and human mode?
Contributor
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment. Intentional and matches every CMF on-prem command in - |
||
| return table.Print() | ||
| } | ||
|
|
||
| localDatabase := convertSdkDatabaseToLocalDatabase(sdkDatabase) | ||
| return output.SerializedOutput(cmd, localDatabase) | ||
| } | ||
|
|
||
| func readDatabaseResourceFile(resourceFilePath string) (cmfsdk.KafkaDatabase, error) { | ||
| data, err := os.ReadFile(resourceFilePath) | ||
| if err != nil { | ||
| return cmfsdk.KafkaDatabase{}, fmt.Errorf("failed to read file: %w", err) | ||
| } | ||
|
|
||
| var genericData map[string]interface{} | ||
| ext := filepath.Ext(resourceFilePath) | ||
| switch ext { | ||
| case ".json": | ||
| err = json.Unmarshal(data, &genericData) | ||
| case ".yaml", ".yml": | ||
| err = yaml.Unmarshal(data, &genericData) | ||
| default: | ||
| return cmfsdk.KafkaDatabase{}, errors.NewErrorWithSuggestions(fmt.Sprintf("unsupported file format: %s", ext), "Supported file formats are .json, .yaml, and .yml.") | ||
| } | ||
| if err != nil { | ||
| return cmfsdk.KafkaDatabase{}, fmt.Errorf("failed to parse input file: %w", err) | ||
| } | ||
|
|
||
| jsonBytes, err := json.Marshal(genericData) | ||
| if err != nil { | ||
| return cmfsdk.KafkaDatabase{}, fmt.Errorf("failed to marshal intermediate data: %w", err) | ||
| } | ||
|
|
||
| var sdkDatabase cmfsdk.KafkaDatabase | ||
| if err = json.Unmarshal(jsonBytes, &sdkDatabase); err != nil { | ||
| return cmfsdk.KafkaDatabase{}, fmt.Errorf("failed to bind data to KafkaDatabase model: %w", err) | ||
| } | ||
|
|
||
| return sdkDatabase, nil | ||
| } | ||
|
|
||
| func convertSdkDatabaseToLocalDatabase(sdkDatabase cmfsdk.KafkaDatabase) LocalKafkaDatabase { | ||
| return LocalKafkaDatabase{ | ||
| ApiVersion: sdkDatabase.ApiVersion, | ||
| Kind: sdkDatabase.Kind, | ||
| Metadata: LocalDatabaseMetadata{ | ||
| Name: sdkDatabase.Metadata.Name, | ||
| CreationTimestamp: sdkDatabase.Metadata.CreationTimestamp, | ||
| UpdateTimestamp: sdkDatabase.Metadata.UpdateTimestamp, | ||
| Uid: sdkDatabase.Metadata.Uid, | ||
| Labels: sdkDatabase.Metadata.Labels, | ||
| Annotations: sdkDatabase.Metadata.Annotations, | ||
| }, | ||
| Spec: LocalKafkaDatabaseSpec{ | ||
| KafkaCluster: LocalKafkaDatabaseSpecKafkaCluster{ | ||
| ConnectionConfig: sdkDatabase.Spec.KafkaCluster.ConnectionConfig, | ||
| ConnectionSecretId: sdkDatabase.Spec.KafkaCluster.ConnectionSecretId, | ||
| }, | ||
| DdlEnvironments: sdkDatabase.Spec.DdlEnvironments, | ||
| }, | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| package flink | ||
|
|
||
| import ( | ||
| "github.com/spf13/cobra" | ||
|
|
||
| pcmd "github.com/confluentinc/cli/v4/pkg/cmd" | ||
| ) | ||
|
|
||
| func (c *command) newCatalogDatabaseCreateCommand() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "create <resourceFilePath>", | ||
| Short: "Create a Flink database.", | ||
|
channingdong marked this conversation as resolved.
|
||
| Long: "Create a Flink database in a catalog in Confluent Platform.", | ||
| Args: cobra.ExactArgs(1), | ||
| RunE: c.catalogDatabaseCreate, | ||
| } | ||
|
|
||
| cmd.Flags().String("catalog", "", "Name of the catalog.") | ||
| cobra.CheckErr(cmd.MarkFlagRequired("catalog")) | ||
| addCmfFlagSet(cmd) | ||
| pcmd.AddOutputFlag(cmd) | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func (c *command) catalogDatabaseCreate(cmd *cobra.Command, args []string) error { | ||
| resourceFilePath := args[0] | ||
|
|
||
| catalogName, err := cmd.Flags().GetString("catalog") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| client, err := c.GetCmfClient(cmd) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| sdkDatabase, err := readDatabaseResourceFile(resourceFilePath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| sdkOutputDatabase, err := client.CreateDatabase(c.createContext(), catalogName, sdkDatabase) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return printDatabaseOutput(cmd, sdkOutputDatabase, catalogName) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| package flink | ||
|
|
||
| import ( | ||
| "github.com/spf13/cobra" | ||
|
|
||
| pcmd "github.com/confluentinc/cli/v4/pkg/cmd" | ||
| "github.com/confluentinc/cli/v4/pkg/deletion" | ||
| "github.com/confluentinc/cli/v4/pkg/errors" | ||
| "github.com/confluentinc/cli/v4/pkg/resource" | ||
| ) | ||
|
|
||
| func (c *command) newCatalogDatabaseDeleteCommand() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "delete <name>", | ||
| Short: "Delete a Flink database in Confluent Platform.", | ||
| Args: cobra.ExactArgs(1), | ||
| RunE: c.catalogDatabaseDelete, | ||
| } | ||
|
|
||
| cmd.Flags().String("catalog", "", "Name of the catalog.") | ||
| cobra.CheckErr(cmd.MarkFlagRequired("catalog")) | ||
| addCmfFlagSet(cmd) | ||
| pcmd.AddForceFlag(cmd) | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func (c *command) catalogDatabaseDelete(cmd *cobra.Command, args []string) error { | ||
| catalogName, err := cmd.Flags().GetString("catalog") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| client, err := c.GetCmfClient(cmd) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| existenceFunc := func(name string) bool { | ||
| _, err := client.DescribeDatabase(c.createContext(), catalogName, name) | ||
| return err == nil | ||
| } | ||
|
|
||
| if err := deletion.ValidateAndConfirm(cmd, args, existenceFunc, resource.FlinkDatabase); err != nil { | ||
| // We are validating only the existence of the resources (there is no prefix validation). | ||
| // Thus, we can add some extra context for the error. | ||
| suggestions := "List available Flink databases with `confluent flink catalog database list`." | ||
|
paras-negi-flink marked this conversation as resolved.
channingdong marked this conversation as resolved.
|
||
| suggestions += "\nCheck that CMF is running and accessible." | ||
| return errors.NewErrorWithSuggestions(err.Error(), suggestions) | ||
| } | ||
|
paras-negi-flink marked this conversation as resolved.
|
||
|
|
||
| deleteFunc := func(name string) error { | ||
| return client.DeleteDatabase(c.createContext(), catalogName, name) | ||
| } | ||
|
|
||
| _, err = deletion.Delete(cmd, args, deleteFunc, resource.FlinkDatabase) | ||
| return err | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| package flink | ||
|
|
||
| import ( | ||
| "github.com/spf13/cobra" | ||
|
|
||
| pcmd "github.com/confluentinc/cli/v4/pkg/cmd" | ||
| ) | ||
|
|
||
| func (c *command) newCatalogDatabaseDescribeCommand() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "describe <name>", | ||
| Short: "Describe a Flink database in Confluent Platform.", | ||
| Args: cobra.ExactArgs(1), | ||
| RunE: c.catalogDatabaseDescribe, | ||
| } | ||
|
|
||
| cmd.Flags().String("catalog", "", "Name of the catalog.") | ||
| cobra.CheckErr(cmd.MarkFlagRequired("catalog")) | ||
| addCmfFlagSet(cmd) | ||
| pcmd.AddOutputFlag(cmd) | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func (c *command) catalogDatabaseDescribe(cmd *cobra.Command, args []string) error { | ||
| name := args[0] | ||
|
|
||
| catalogName, err := cmd.Flags().GetString("catalog") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| client, err := c.GetCmfClient(cmd) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| sdkOutputDatabase, err := client.DescribeDatabase(c.createContext(), catalogName, name) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return printDatabaseOutput(cmd, sdkOutputDatabase, catalogName) | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.