search

brimdata / zed

A novel data lake based on super-structured data
https://zed.brimdata.io/
BSD 3-Clause "New" or "Revised" License
1.38k stars 67 forks source link

Document or hide/remove "-f lake" output option #5169

Closed philrz closed 1 month ago

philrz commented 3 months ago

At the time this issue is being opened, Zed is at commit f497079.

One of the -f output options of the Zed CLI commands is lake. I can see it was first added in #2577. There doesn't appear to be user-facing documentation for it, and in my first attempts as a user trying it out as a black box, I've only seen it produce the same output as -f zson.

I polled the team, and @mattnibs said the following:

Lake is used for formatting on stuff like commits and pool logs. Yeah I don't see why a user would ever want to use this unless of course they wanted to format commits from metadata.

I bumped into all this when I was updating the user-facing docs to better describe some of the other output options, so it got me to thinking that we should either document this one as well, or if we don't expect users to need to reach for it but we still need it for internal purposes, hide it from the command help. And if neither of these, perhaps we should just remove it.

philrz commented 1 month ago

This is now documented at https://zed.brimdata.io/docs/next/commands/zq#zed-lake-metadata-output.