fabric-cli

onelake examples

Checking if a shortcut exists

Verify if a shortcut exists.

fab:/ws1.Workspace/lh1.Lakehouse$ exists Files/scut.Shortcut
* true

fab:/ws1.Workspace/lh1.Lakehouse$ exists Tables/ext_table.Shortcut
* true

fab:/ws1.Workspace/lh1.Lakehouse$ exists Files/scut_.Shortcut
* false

Getting and querying shortcut details

Retrieve and query item details with -q (JMESPath query). Output to Local or Lakehouse with -o.

# get JSON properties
fab:/ws1.Workspace/lh1.Lakehouse$ get Files/scut.Shortcut
fab:/ws1.Workspace/lh1.Lakehouse$ get Tables/ext_table.Shortcut

# query using JMESPath
fab:/ws1.Workspace/lh1.Lakehouse$ get Files/scut.Shortcut -q target
fab:/ws1.Workspace/lh1.Lakehouse$ get Tables/ext_table.Shortcut -q .

# export query result
fab:/ws1.Workspace/lh1.Lakehouse$ get Files/scut.Shortcut -q target -o /tmp
fab:/ws1.Workspace/lh1.Lakehouse$ get Tables/ext_table.Shortcut -q . -o /tmp

Creating a shortcut

Create shortcuts in Lakehouse /Files or /Tables sections. Use -f to force (uses GenerateUniqueName).

Note that --target is for internal OneLake shortcuts; for external ones, use --type (adlsGen2, amazonS3, dataverse, googleCloudStorage, oneLake, s3Compatible) and input inline payload with -i.

# create an internal shortcut in the /Files section
fab:/ws1.Workspace/lh1.Lakehouse$ ln Files/scut.Shortcut --type oneLake --target ../../_wsfabcli.Workspace/lakehouse.lakehouse/Files

# create an external shortcut in the /Tables section
fab:/ws1.Workspace/lh1.Lakehouse$ ln Tables/ext_table.Shortcut --type adlsGen2 -i {"location": "https://<storage_name>.dfs.core.windows.net/", "subpath": "sampledata/covid", "connectionId": "40c6aa71-de09-48d3-bd8d-1afee62445bd"}

# create an external shortcut in the /Tables section (schema-enabled lakehouse)
fab:/ws1.Workspace/lh1.Lakehouse$ ln Tables/dbo/ext_table.Shortcut --type adlsGen2 -i {"location": "https://<storage_name>.dfs.core.windows.net/", "subpath": "sampledata/covid", "connectionId": "40c6aa71-de09-48d3-bd8d-1afee62445bd"}

Removing a shortcut

Remove a shortcut. Use -f to force.

fab:/ws1.Workspace/lh1.Lakehouse$ rm Files/scut.Shortcut
fab:/ws1.Workspace/lh1.Lakehouse$ rm Tables/ext_table.Shortcut -f

Renaming a shortcut

Rename a shortcut. Use -f to force.

# rename a shortcut in /Files section
fab:/ws1.Workspace/lh1.Lakehouse$ set Files/scutnew.Shortcut -q name -i scut

# rename a shortcut in /Tables section
fab:/ws1.Workspace/lh1.Lakehouse$ set Tables/ext_table.Shortcut -q name -i ext_table_ren -f

See all examples