mirror of https://github.com/databricks/cli.git
477 lines
13 KiB
Go
Executable File
477 lines
13 KiB
Go
Executable File
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
|
||
|
||
package queries
|
||
|
||
import (
|
||
"fmt"
|
||
|
||
"github.com/databricks/cli/cmd/root"
|
||
"github.com/databricks/cli/libs/cmdio"
|
||
"github.com/databricks/cli/libs/flags"
|
||
"github.com/databricks/databricks-sdk-go/service/sql"
|
||
"github.com/spf13/cobra"
|
||
)
|
||
|
||
// Slice with functions to override default command behavior.
|
||
// Functions can be added from the `init()` function in manually curated files in this directory.
|
||
var cmdOverrides []func(*cobra.Command)
|
||
|
||
func New() *cobra.Command {
|
||
cmd := &cobra.Command{
|
||
Use: "queries",
|
||
Short: `The queries API can be used to perform CRUD operations on queries.`,
|
||
Long: `The queries API can be used to perform CRUD operations on queries. A query is
|
||
a Databricks SQL object that includes the target SQL warehouse, query text,
|
||
name, description, tags, and parameters. Queries can be scheduled using the
|
||
sql_task type of the Jobs API, e.g. :method:jobs/create.`,
|
||
GroupID: "sql",
|
||
Annotations: map[string]string{
|
||
"package": "sql",
|
||
},
|
||
}
|
||
|
||
// Add methods
|
||
cmd.AddCommand(newCreate())
|
||
cmd.AddCommand(newDelete())
|
||
cmd.AddCommand(newGet())
|
||
cmd.AddCommand(newList())
|
||
cmd.AddCommand(newListVisualizations())
|
||
cmd.AddCommand(newUpdate())
|
||
|
||
// Apply optional overrides to this command.
|
||
for _, fn := range cmdOverrides {
|
||
fn(cmd)
|
||
}
|
||
|
||
return cmd
|
||
}
|
||
|
||
// start create command
|
||
|
||
// Slice with functions to override default command behavior.
|
||
// Functions can be added from the `init()` function in manually curated files in this directory.
|
||
var createOverrides []func(
|
||
*cobra.Command,
|
||
*sql.CreateQueryRequest,
|
||
)
|
||
|
||
func newCreate() *cobra.Command {
|
||
cmd := &cobra.Command{}
|
||
|
||
var createReq sql.CreateQueryRequest
|
||
var createJson flags.JsonFlag
|
||
|
||
// TODO: short flags
|
||
cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`)
|
||
|
||
// TODO: complex arg: query
|
||
|
||
cmd.Use = "create"
|
||
cmd.Short = `Create a query.`
|
||
cmd.Long = `Create a query.
|
||
|
||
Creates a query.`
|
||
|
||
cmd.Annotations = make(map[string]string)
|
||
|
||
cmd.Args = func(cmd *cobra.Command, args []string) error {
|
||
check := root.ExactArgs(0)
|
||
return check(cmd, args)
|
||
}
|
||
|
||
cmd.PreRunE = root.MustWorkspaceClient
|
||
cmd.RunE = func(cmd *cobra.Command, args []string) (err error) {
|
||
ctx := cmd.Context()
|
||
w := root.WorkspaceClient(ctx)
|
||
|
||
if cmd.Flags().Changed("json") {
|
||
diags := createJson.Unmarshal(&createReq)
|
||
if diags.HasError() {
|
||
return diags.Error()
|
||
}
|
||
if len(diags) > 0 {
|
||
err := cmdio.RenderDiagnosticsToErrorOut(ctx, diags)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
}
|
||
}
|
||
|
||
response, err := w.Queries.Create(ctx, createReq)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
return cmdio.Render(ctx, response)
|
||
}
|
||
|
||
// Disable completions since they are not applicable.
|
||
// Can be overridden by manual implementation in `override.go`.
|
||
cmd.ValidArgsFunction = cobra.NoFileCompletions
|
||
|
||
// Apply optional overrides to this command.
|
||
for _, fn := range createOverrides {
|
||
fn(cmd, &createReq)
|
||
}
|
||
|
||
return cmd
|
||
}
|
||
|
||
// start delete command
|
||
|
||
// Slice with functions to override default command behavior.
|
||
// Functions can be added from the `init()` function in manually curated files in this directory.
|
||
var deleteOverrides []func(
|
||
*cobra.Command,
|
||
*sql.TrashQueryRequest,
|
||
)
|
||
|
||
func newDelete() *cobra.Command {
|
||
cmd := &cobra.Command{}
|
||
|
||
var deleteReq sql.TrashQueryRequest
|
||
|
||
// TODO: short flags
|
||
|
||
cmd.Use = "delete ID"
|
||
cmd.Short = `Delete a query.`
|
||
cmd.Long = `Delete a query.
|
||
|
||
Moves a query to the trash. Trashed queries immediately disappear from
|
||
searches and list views, and cannot be used for alerts. You can restore a
|
||
trashed query through the UI. A trashed query is permanently deleted after 30
|
||
days.`
|
||
|
||
cmd.Annotations = make(map[string]string)
|
||
|
||
cmd.PreRunE = root.MustWorkspaceClient
|
||
cmd.RunE = func(cmd *cobra.Command, args []string) (err error) {
|
||
ctx := cmd.Context()
|
||
w := root.WorkspaceClient(ctx)
|
||
|
||
if len(args) == 0 {
|
||
promptSpinner := cmdio.Spinner(ctx)
|
||
promptSpinner <- "No ID argument specified. Loading names for Queries drop-down."
|
||
names, err := w.Queries.ListQueryObjectsResponseQueryDisplayNameToIdMap(ctx, sql.ListQueriesRequest{})
|
||
close(promptSpinner)
|
||
if err != nil {
|
||
return fmt.Errorf("failed to load names for Queries drop-down. Please manually specify required arguments. Original error: %w", err)
|
||
}
|
||
id, err := cmdio.Select(ctx, names, "")
|
||
if err != nil {
|
||
return err
|
||
}
|
||
args = append(args, id)
|
||
}
|
||
if len(args) != 1 {
|
||
return fmt.Errorf("expected to have ")
|
||
}
|
||
deleteReq.Id = args[0]
|
||
|
||
err = w.Queries.Delete(ctx, deleteReq)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// Disable completions since they are not applicable.
|
||
// Can be overridden by manual implementation in `override.go`.
|
||
cmd.ValidArgsFunction = cobra.NoFileCompletions
|
||
|
||
// Apply optional overrides to this command.
|
||
for _, fn := range deleteOverrides {
|
||
fn(cmd, &deleteReq)
|
||
}
|
||
|
||
return cmd
|
||
}
|
||
|
||
// start get command
|
||
|
||
// Slice with functions to override default command behavior.
|
||
// Functions can be added from the `init()` function in manually curated files in this directory.
|
||
var getOverrides []func(
|
||
*cobra.Command,
|
||
*sql.GetQueryRequest,
|
||
)
|
||
|
||
func newGet() *cobra.Command {
|
||
cmd := &cobra.Command{}
|
||
|
||
var getReq sql.GetQueryRequest
|
||
|
||
// TODO: short flags
|
||
|
||
cmd.Use = "get ID"
|
||
cmd.Short = `Get a query.`
|
||
cmd.Long = `Get a query.
|
||
|
||
Gets a query.`
|
||
|
||
cmd.Annotations = make(map[string]string)
|
||
|
||
cmd.PreRunE = root.MustWorkspaceClient
|
||
cmd.RunE = func(cmd *cobra.Command, args []string) (err error) {
|
||
ctx := cmd.Context()
|
||
w := root.WorkspaceClient(ctx)
|
||
|
||
if len(args) == 0 {
|
||
promptSpinner := cmdio.Spinner(ctx)
|
||
promptSpinner <- "No ID argument specified. Loading names for Queries drop-down."
|
||
names, err := w.Queries.ListQueryObjectsResponseQueryDisplayNameToIdMap(ctx, sql.ListQueriesRequest{})
|
||
close(promptSpinner)
|
||
if err != nil {
|
||
return fmt.Errorf("failed to load names for Queries drop-down. Please manually specify required arguments. Original error: %w", err)
|
||
}
|
||
id, err := cmdio.Select(ctx, names, "")
|
||
if err != nil {
|
||
return err
|
||
}
|
||
args = append(args, id)
|
||
}
|
||
if len(args) != 1 {
|
||
return fmt.Errorf("expected to have ")
|
||
}
|
||
getReq.Id = args[0]
|
||
|
||
response, err := w.Queries.Get(ctx, getReq)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
return cmdio.Render(ctx, response)
|
||
}
|
||
|
||
// Disable completions since they are not applicable.
|
||
// Can be overridden by manual implementation in `override.go`.
|
||
cmd.ValidArgsFunction = cobra.NoFileCompletions
|
||
|
||
// Apply optional overrides to this command.
|
||
for _, fn := range getOverrides {
|
||
fn(cmd, &getReq)
|
||
}
|
||
|
||
return cmd
|
||
}
|
||
|
||
// start list command
|
||
|
||
// Slice with functions to override default command behavior.
|
||
// Functions can be added from the `init()` function in manually curated files in this directory.
|
||
var listOverrides []func(
|
||
*cobra.Command,
|
||
*sql.ListQueriesRequest,
|
||
)
|
||
|
||
func newList() *cobra.Command {
|
||
cmd := &cobra.Command{}
|
||
|
||
var listReq sql.ListQueriesRequest
|
||
|
||
// TODO: short flags
|
||
|
||
cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``)
|
||
cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``)
|
||
|
||
cmd.Use = "list"
|
||
cmd.Short = `List queries.`
|
||
cmd.Long = `List queries.
|
||
|
||
Gets a list of queries accessible to the user, ordered by creation time.
|
||
**Warning:** Calling this API concurrently 10 or more times could result in
|
||
throttling, service degradation, or a temporary ban.`
|
||
|
||
cmd.Annotations = make(map[string]string)
|
||
|
||
cmd.Args = func(cmd *cobra.Command, args []string) error {
|
||
check := root.ExactArgs(0)
|
||
return check(cmd, args)
|
||
}
|
||
|
||
cmd.PreRunE = root.MustWorkspaceClient
|
||
cmd.RunE = func(cmd *cobra.Command, args []string) (err error) {
|
||
ctx := cmd.Context()
|
||
w := root.WorkspaceClient(ctx)
|
||
|
||
response := w.Queries.List(ctx, listReq)
|
||
return cmdio.RenderIterator(ctx, response)
|
||
}
|
||
|
||
// Disable completions since they are not applicable.
|
||
// Can be overridden by manual implementation in `override.go`.
|
||
cmd.ValidArgsFunction = cobra.NoFileCompletions
|
||
|
||
// Apply optional overrides to this command.
|
||
for _, fn := range listOverrides {
|
||
fn(cmd, &listReq)
|
||
}
|
||
|
||
return cmd
|
||
}
|
||
|
||
// start list-visualizations command
|
||
|
||
// Slice with functions to override default command behavior.
|
||
// Functions can be added from the `init()` function in manually curated files in this directory.
|
||
var listVisualizationsOverrides []func(
|
||
*cobra.Command,
|
||
*sql.ListVisualizationsForQueryRequest,
|
||
)
|
||
|
||
func newListVisualizations() *cobra.Command {
|
||
cmd := &cobra.Command{}
|
||
|
||
var listVisualizationsReq sql.ListVisualizationsForQueryRequest
|
||
|
||
// TODO: short flags
|
||
|
||
cmd.Flags().IntVar(&listVisualizationsReq.PageSize, "page-size", listVisualizationsReq.PageSize, ``)
|
||
cmd.Flags().StringVar(&listVisualizationsReq.PageToken, "page-token", listVisualizationsReq.PageToken, ``)
|
||
|
||
cmd.Use = "list-visualizations ID"
|
||
cmd.Short = `List visualizations on a query.`
|
||
cmd.Long = `List visualizations on a query.
|
||
|
||
Gets a list of visualizations on a query.`
|
||
|
||
// This command is being previewed; hide from help output.
|
||
cmd.Hidden = true
|
||
|
||
cmd.Annotations = make(map[string]string)
|
||
|
||
cmd.PreRunE = root.MustWorkspaceClient
|
||
cmd.RunE = func(cmd *cobra.Command, args []string) (err error) {
|
||
ctx := cmd.Context()
|
||
w := root.WorkspaceClient(ctx)
|
||
|
||
if len(args) == 0 {
|
||
promptSpinner := cmdio.Spinner(ctx)
|
||
promptSpinner <- "No ID argument specified. Loading names for Queries drop-down."
|
||
names, err := w.Queries.ListQueryObjectsResponseQueryDisplayNameToIdMap(ctx, sql.ListQueriesRequest{})
|
||
close(promptSpinner)
|
||
if err != nil {
|
||
return fmt.Errorf("failed to load names for Queries drop-down. Please manually specify required arguments. Original error: %w", err)
|
||
}
|
||
id, err := cmdio.Select(ctx, names, "")
|
||
if err != nil {
|
||
return err
|
||
}
|
||
args = append(args, id)
|
||
}
|
||
if len(args) != 1 {
|
||
return fmt.Errorf("expected to have ")
|
||
}
|
||
listVisualizationsReq.Id = args[0]
|
||
|
||
response := w.Queries.ListVisualizations(ctx, listVisualizationsReq)
|
||
return cmdio.RenderIterator(ctx, response)
|
||
}
|
||
|
||
// Disable completions since they are not applicable.
|
||
// Can be overridden by manual implementation in `override.go`.
|
||
cmd.ValidArgsFunction = cobra.NoFileCompletions
|
||
|
||
// Apply optional overrides to this command.
|
||
for _, fn := range listVisualizationsOverrides {
|
||
fn(cmd, &listVisualizationsReq)
|
||
}
|
||
|
||
return cmd
|
||
}
|
||
|
||
// start update command
|
||
|
||
// Slice with functions to override default command behavior.
|
||
// Functions can be added from the `init()` function in manually curated files in this directory.
|
||
var updateOverrides []func(
|
||
*cobra.Command,
|
||
*sql.UpdateQueryRequest,
|
||
)
|
||
|
||
func newUpdate() *cobra.Command {
|
||
cmd := &cobra.Command{}
|
||
|
||
var updateReq sql.UpdateQueryRequest
|
||
var updateJson flags.JsonFlag
|
||
|
||
// TODO: short flags
|
||
cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`)
|
||
|
||
// TODO: complex arg: query
|
||
|
||
cmd.Use = "update ID UPDATE_MASK"
|
||
cmd.Short = `Update a query.`
|
||
cmd.Long = `Update a query.
|
||
|
||
Updates a query.
|
||
|
||
Arguments:
|
||
ID:
|
||
UPDATE_MASK: The field mask must be a single string, with multiple fields separated by
|
||
commas (no spaces). The field path is relative to the resource object,
|
||
using a dot (.) to navigate sub-fields (e.g., author.given_name).
|
||
Specification of elements in sequence or map fields is not allowed, as
|
||
only the entire collection field can be specified. Field names must
|
||
exactly match the resource field names.
|
||
|
||
A field mask of * indicates full replacement. It’s recommended to
|
||
always explicitly list the fields being updated and avoid using *
|
||
wildcards, as it can lead to unintended results if the API changes in the
|
||
future.`
|
||
|
||
cmd.Annotations = make(map[string]string)
|
||
|
||
cmd.Args = func(cmd *cobra.Command, args []string) error {
|
||
if cmd.Flags().Changed("json") {
|
||
err := root.ExactArgs(1)(cmd, args)
|
||
if err != nil {
|
||
return fmt.Errorf("when --json flag is specified, provide only ID as positional arguments. Provide 'update_mask' in your JSON input")
|
||
}
|
||
return nil
|
||
}
|
||
check := root.ExactArgs(2)
|
||
return check(cmd, args)
|
||
}
|
||
|
||
cmd.PreRunE = root.MustWorkspaceClient
|
||
cmd.RunE = func(cmd *cobra.Command, args []string) (err error) {
|
||
ctx := cmd.Context()
|
||
w := root.WorkspaceClient(ctx)
|
||
|
||
if cmd.Flags().Changed("json") {
|
||
diags := updateJson.Unmarshal(&updateReq)
|
||
if diags.HasError() {
|
||
return diags.Error()
|
||
}
|
||
if len(diags) > 0 {
|
||
err := cmdio.RenderDiagnosticsToErrorOut(ctx, diags)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
}
|
||
}
|
||
updateReq.Id = args[0]
|
||
if !cmd.Flags().Changed("json") {
|
||
updateReq.UpdateMask = args[1]
|
||
}
|
||
|
||
response, err := w.Queries.Update(ctx, updateReq)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
return cmdio.Render(ctx, response)
|
||
}
|
||
|
||
// Disable completions since they are not applicable.
|
||
// Can be overridden by manual implementation in `override.go`.
|
||
cmd.ValidArgsFunction = cobra.NoFileCompletions
|
||
|
||
// Apply optional overrides to this command.
|
||
for _, fn := range updateOverrides {
|
||
fn(cmd, &updateReq)
|
||
}
|
||
|
||
return cmd
|
||
}
|
||
|
||
// end service Queries
|