mix f3.inspect (F3 v0.1.0)

Prints metadata for one F3 file.

mix f3.inspect test/fixtures/small.f3
mix f3.inspect test/fixtures/small.f3 --detail
mix f3.inspect test/fixtures/small.f3 --json

The output is F3.inspect/2. It does not read row data.

--detail adds row groups. --json prints the metadata map. --max-metadata-bytes N overrides the footer cap. No path, or an unknown flag, raises Mix.Error. A missing file raises Mix.Error with the F3.Error message.

Summary

Functions

run(args)

Runs the task.

Functions

run(args)

Runs the task.

args is the command-line list. A successful run prints the inspection and returns :ok. An empty list raises Mix.Error.

Examples

iex> Mix.Tasks.F3.Inspect.run([])
** (Mix.Error) usage: mix f3.inspect FILE [--detail] [--json] [--max-metadata-bytes N]