lamin get functionality -- UI should show Get / Load on Artifact detail page

[ap--]

Hi Lamins,

Should the "query metadata about an entity" be removed from here? It's the first thing you see and I expected just a json blob or so with metadata. But instead lamin loads the entire file.

❯ lamin --help
                                                                                             
 Usage: lamin [OPTIONS] COMMAND [ARGS]...                                                    
                                                                                             
 Configure LaminDB and perform simple actions.                                               
                                                                                             
[...]

╭─ Read & write data ───────────────────────────────────────────────────────────────────────╮
│ load      Load a file or folder.                                                          │
│ save      Save a file or folder.                                                          │
│ get       Query metadata about an entity.                                                 │
│ delete    Delete an entity.                                                               │
╰───────────────────────────────────────────────────────────────────────────────────────────╯

[...]

[user@computer]$ lamin get --help
                                                                                             
 Usage: lamin get [OPTIONS] ENTITY                                                           
                                                                                             
 Query metadata about an entity.                                                             
 Currently only works for artifact & transform and behaves like `lamin load`.                
                                                                                             
╭─ Options ─────────────────────────────────────────────────────────────────────────────────╮
│ --uid         TEXT  The uid for the entity.                                               │
│ --key         TEXT  The key for the entity.                                               │
│ --with-env          Also return the environment for a tranform.                           │
│ --help              Show this message and exit.                                           │
╰───────────────────────────────────────────────────────────────────────────────────────────╯

typer has a concept of command aliases, I bet click has too. maybe get could be made an alias of load? Which one is considered the canonical command?

The CLI suggests load

[user@computer]$ lamin get https://lamin.ai/laminlabs/cellxgene/artifact/adAPL1SLZEi2pmJJ
! to load a file or folder, please use: lamin load https://lamin.ai/laminlabs/cellxgene/artifact/adAPL1SLZEi2pmJJ
→ connected lamindb: laminlabs/cellxgene
→ artifact is here: /Users/andreaspoehlmann/Library/Caches/lamindb/srg-main-laminlabs-us-west-2-shared-resources/models/scgen_state_dict.pt

But the UI suggests get:

[falexwolf]

lamin get was renamed to lamin load back when we refactored the CLI: https://docs.lamin.ai/changelog/2024#db-0-76-10

For backward compatibility it continues to work put prints these hints that you should use load instead. The plan is to have nice metadata output similar to what you get when you call get() in the Python API (matching your intuition).

The UI should show Load just like it does for transforms. Will fix this.

[falexwolf]

The change that we want in the UI should go slightly further.

In the Python API, the primary way of accessing an artifact is .get().

You then follow with .cache(), .load() or .open(), depending on how you want to access data.

On the CLI, lamin get could start by printing .describe(); later on it can return a to-be-decided json format (all joins performed or not).

[ap--]

On the CLI, lamin get could start by printing .describe(); later on it can return a to-be-decided json format (all joins performed or not).

That would be great.

Ideally I can pipe this to jq for scripting at some point.

I.e. something like

lamin get --json abcd1234567890ef0001 | jq .ulabels 

[falexwolf]

Yes, makes sense!