dbz-cli

This crate provides a CLI tool dbz for converting the Databento Binary Encoding (DBZ) files to text formats. This tool is heavily inspired by the zstd CLI.

Usage

dbz currently supports CSV and JSON (technically newline-delimited JSON) as output formats. By default dbz outputs the result to standard output for ease of use with text-based command-line utilities. Running

dbz some.dbz --csv | head -n 5

will print the first the header row and 4 data rows in some.dbz in CSV format to the console. Similarly, running

dbz ohlcv-1d.dbz --json | jq '.high'

Will extract only the high prices from ohlcv-1d.dbz.

You can also save the results directly to another file by running

dbz some.dbz --json --output some.json

dbz will create a new file some.csv with the data from some.dbz formatted as JSON.

When the file name passed --output or -o ends in .json or .csv, you can omit the --json and --csv flags.

dbz another.dbz -o data.csv

This writes the contents of another.dbz to data.json in CSV format.

By default, dbz will not overwrite an existing file. To replace the contents of an existing file and allow overwriting files, pass the -f or --force flag.

Building

dbz is written in Rust, so you'll need to have Rust installed first.

To build, run the following commands:

git clone https://github.com/databento/dbz
cd dbz
cargo build --release
./target/release/dbz --help

Testing

Tests are run through cargo test. All integration tests are located in integration_tests.rs.

License

Distributed under the Apache 2.0 License.