databricks/databricks-cli

databricks libraries help incorrect for --cluster-name

coreyabs-db opened this issue · 0 comments

The databricks libraries commands list and cluster-status (possibly others), supports specifying --cluster-id or --cluster-name, and either appears to work fine. However, the help text for --cluster-name appears to simply duplicate the help text for --cluster-id as shown below:

$ databricks libraries list -h                                 
Usage: databricks libraries list [OPTIONS]

  Get the statuses of all libraries for all clusters or for a specified
  cluster. If the option --cluster-id is provided, then all libraries on that
  cluster will be listed, (cluster-status). If the option --cluster-id is
  omitted, then all libraries on all clusters will be listed (all-cluster-
  statuses).

Options:
  --cluster-id CLUSTER_ID    Can be found in the URL at https://*.cloud.databr
                             icks.com/#/setting/clusters/$CLUSTER_ID/configura
                             tion.
  --cluster-name CLUSTER_ID  Can be found in the URL at https://*.cloud.databr
                             icks.com/#/setting/clusters/$CLUSTER_ID/configura
                             tion.
  --debug                    Debug Mode. Shows full stack trace on error.
  --profile TEXT             CLI connection profile to use. The default
                             profile is "DEFAULT".
  -h, --help                 Show this message and exit.

As you can see, the --cluster-name attribute lists CLUSTER_ID instead of perhaps CLUSTER_NAME, and the description for the option tells people to get the $CLUSTER_ID from the URL which is not correct.

After I noticed this, I tried upgrading via pip, so as far as I know I'm on the latest version:

$ databricks --version
Version 0.17.4

And looking through the code for the command I think I can see why it's doing it so I think the problem is still there. I only checked for those two options within this subcommand. It may well be there in other subcommands that offer a --cluster-name option.