docs(cli): correct the relationship path form and note the TOM name - #391
Closed
MariaJoseFF wants to merge 1 commit into
Closed
docs(cli): correct the relationship path form and note the TOM name#391MariaJoseFF wants to merge 1 commit into
MariaJoseFF wants to merge 1 commit into
Conversation
The Containers and keywords section documented relationship paths as
Relationships/{guid}. Braces are reserved characters in CLI paths as of
0.7.0, so that form is rejected by the path parser rather than resolved.
Correct it to Relationships/"{guid}" and note that --paths-only prints the
relationship's TOM name, which is not always a GUID: the GUID in Power BI
models, a display-style name such as Relationships/Relationship 1 in
SSAS-sourced models.
Work item 7269.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes work item 7269.
Targets
user-pg/cli-0.7.0(the branch behind #386), notmain- these are 0.7.0 docs and must not go live before the CLI ships.The problem
The Containers and keywords section documented relationship paths as
Relationships/{guid}. As of 0.7.0,{and}are reserved characters in CLI object and filter paths ([Breaking] Braces asterisks and question marks in object names must be quoted in paths), so that form is refused by the path parser rather than resolved:The single-quoted form is refused too, because a single-quoted segment must reference a table. Double quotes and brackets both resolve.
Two rules in the same release contradicted each other.
The change
One paragraph in
content/features/te-cli/te-cli-commands.md:Relationships/{guid}->Relationships/"{guid}"--paths-onlyprints the relationship's TOM name, which is not always a GUID: the GUID in Power BI models, a display-style name such asRelationships/Relationship 1in SSAS-sourced models.