mirror of https://github.com/databricks/cli.git
b65ce75c1f
## Changes Currently, when the CLI run a list API call (like list jobs), it uses the `List*All` methods from the SDK, which list all resources in the collection. This is very slow for large collections: if you need to list all jobs from a workspace that has 10,000+ jobs, you'll be waiting for at least 100 RPCs to complete before seeing any output. Instead of using List*All() methods, the SDK recently added an iterator data structure that allows traversing the collection without needing to completely list it first. New pages are fetched lazily if the next requested item belongs to the next page. Using the List() methods that return these iterators, the CLI can proactively print out some of the response before the complete collection has been fetched. This involves a pretty major rewrite of the rendering logic in `cmdio`. The idea there is to define custom rendering logic based on the type of the provided resource. There are three renderer interfaces: 1. textRenderer: supports printing something in a textual format (i.e. not JSON, and not templated). 2. jsonRenderer: supports printing something in a pretty-printed JSON format. 3. templateRenderer: supports printing something using a text template. There are also three renderer implementations: 1. readerRenderer: supports printing a reader. This only implements the textRenderer interface. 2. iteratorRenderer: supports printing a `listing.Iterator` from the Go SDK. This implements jsonRenderer and templateRenderer, buffering 20 resources at a time before writing them to the output. 3. defaultRenderer: supports printing arbitrary resources (the previous implementation). Callers will either use `cmdio.Render()` for rendering individual resources or `io.Reader` or `cmdio.RenderIterator()` for rendering an iterator. This separate method is needed to safely be able to match on the type of the iterator, since Go does not allow runtime type matches on generic types with an existential type parameter. One other change that needs to happen is to split the templates used for text representation of list resources into a header template and a row template. The template is now executed multiple times for List API calls, but the header should only be printed once. To support this, I have added `headerTemplate` to `cmdIO`, and I have also changed `RenderWithTemplate` to include a `headerTemplate` parameter everywhere. ## Tests - [x] Unit tests for text rendering logic - [x] Unit test for reflection-based iterator construction. --------- Co-authored-by: Andrew Nester <andrew.nester@databricks.com> |
||
|---|---|---|
| .. | ||
| alerts | ||
| apps | ||
| artifact-allowlists | ||
| catalogs | ||
| clean-rooms | ||
| cluster-policies | ||
| clusters | ||
| connections | ||
| credentials-manager | ||
| current-user | ||
| dashboard-widgets | ||
| dashboards | ||
| data-sources | ||
| experiments | ||
| external-locations | ||
| functions | ||
| git-credentials | ||
| global-init-scripts | ||
| grants | ||
| groups | ||
| instance-pools | ||
| instance-profiles | ||
| ip-access-lists | ||
| jobs | ||
| lakehouse-monitors | ||
| lakeview | ||
| libraries | ||
| metastores | ||
| model-registry | ||
| model-versions | ||
| online-tables | ||
| permissions | ||
| pipelines | ||
| policy-families | ||
| providers | ||
| queries | ||
| query-history | ||
| query-visualizations | ||
| recipient-activation | ||
| recipients | ||
| registered-models | ||
| repos | ||
| schemas | ||
| secrets | ||
| service-principals | ||
| serving-endpoints | ||
| settings | ||
| shares | ||
| storage-credentials | ||
| system-schemas | ||
| table-constraints | ||
| tables | ||
| token-management | ||
| tokens | ||
| users | ||
| vector-search-endpoints | ||
| vector-search-indexes | ||
| volumes | ||
| warehouses | ||
| workspace | ||
| workspace-bindings | ||
| workspace-conf | ||
| cmd.go | ||
| groups.go | ||