Skip to content

Commit

Permalink
Fix document for migrate-locations command (#1017)
Browse files Browse the repository at this point in the history
## Changes
<!-- Summary of your changes that are easy to understand. Add
screenshots when necessary -->

### Linked issues
<!-- DOC: Link issue with a keyword: close, closes, closed, fix, fixes,
fixed, resolve, resolves, resolved. See
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
-->

#100 
#1006 
#1009 

### Functionality 

- [ ] added relevant user documentation
- [ ] added new CLI command
- [ ] modified existing command: `databricks labs ucx ...`
- [ ] added a new workflow
- [ ] modified existing workflow: `...`
- [ ] added a new table
- [ ] modified existing table: `...`

### Tests
<!-- How is this tested? Please see the checklist below and also
describe any other relevant tests -->

- [ ] manually tested
- [ ] added unit tests
- [ ] added integration tests
- [ ] verified on staging environment (screenshot attached)
  • Loading branch information
qziyuan authored Mar 6, 2024
1 parent 6075fec commit e442d63
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
* [`create-uber-principal` command](#create-uber-principal-command)
* [`migrate-credentials` command](#migrate-credentials-command)
* [`validate-external-locations` command](#validate-external-locations-command)
* [`migrate-locations` command](#migrate-locations-command)
* [`create-table-mapping` command](#create-table-mapping-command)
* [`skip` command](#skip-command)
* [`revert-migrated-tables` command](#revert-migrated-tables-command)
Expand Down Expand Up @@ -489,9 +490,9 @@ This command validates and provides mapping to external tables to external locat
databricks labs ucx migrate-locations
```

Once the [`assessment` workflow](#assessment-workflow) finished successfully, and [storage credentials](#migrate-credentials-command) are configured,
Once the [`assessment` workflow](#assessment-workflow) finished successfully, and [storage credentials](#migrate-credentials-command) are configured,
run this command to have Unity Catalog external locations created. The candidate locations to be created are extracted from guess_external_locations
task in the assessment job. You can run `validate_external_locations` command to check the candidate locations.
task in the assessment job. You can run [validate_external_locations](#validate-external-locations-command) command to check the candidate locations.

[[back to top](#databricks-labs-ucx)]

Expand Down
2 changes: 1 addition & 1 deletion labs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -134,5 +134,5 @@ commands:
- name: workspace_ids
description: List of workspace IDs to create account groups from.

- name: migrate_locations
- name: migrate-locations
description: Create UC external locations based on the output of guess_external_locations assessment task.

0 comments on commit e442d63

Please sign in to comment.