Add volume_path to the output for the volume object

Open
#3,220 1 comment 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
go
Domain
cli

Research direction

Start with the databricks volumes list abc_catalog abc_schema entry point and locate the volume object output or serialization code. Check how the existing catalog, schema, and name fields are produced; done means the output also includes the expected /Volumes/{catalog}/{schema}/{name} path.

Written by the indexing model from the issue text.

Description

Enhancement No Autoclose Stale
Describe the issue

Add volume_path to the output of the volume object:

{
  "catalog_name": "abc_catalog",
  "schema_name": "abc_schema",
  "name": "abc_volume",
  "volume_path": "/Volumes/abc_catalog/abc_schema/abc_volume"
}

Once this is done, DABs can be changed to use it like this:

parameters: 
  - name: abc_volume_path
     default: ${resources.volumes.abc_volume_defn.volume_path}

Instead of:

default: /Volumes/${resources.volumes.abc_volume_defn.catalog_name}/${resources.volumes.abc_volume_defn.schema_name}/${resources.volumes.abc_volume_defn.name}
Steps to reproduce the behavior

Please list the steps required to reproduce the issue, for example:

  1. Run databricks volumes list abc_catalog abc_schema
  2. Manually build the volume_path from the current output -- tedious.
Expected Behavior

Show the volume_path along with the other volume outputs

Actual Behavior

No volume_path provided, must be manually constructed from parts of the volume object.

With this provided in the output, DABs can then be updated to use something like this:

OS and CLI version

CLI: v0.255.0, any OS

Is this a regression?

No

Dominant language
Go
Stars
427
Forks
267
Avg merge
2d 1h
Merged PRs (30d)
233

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from databricks/cli

All issues in databricks/cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.