MTBL_METADATA(3)

💖 MTBL_METADATA 💖

okay bestie, pull up a chair, because today we're talking about the mtbl_metadata page from the MTBL manual (section 3, library calls, iykyk) ✨

---

🌸 NAME 🌸

mtbl_metadata — get MTBL file metadata 🫶

---

✨ SYNOPSIS ✨

#include <mtbl.h>

mtbl_file_version
mtbl_metadata_file_version(const struct mtbl_metadata *m);

uint64_t
mtbl_metadata_index_block_offset(const struct mtbl_metadata *m);

uint64_t
mtbl_metadata_data_block_size(const struct mtbl_metadata *m);

mtbl_compression_type
mtbl_metadata_compression_algorithm(const struct mtbl_metadata *m);

uint64_t
mtbl_metadata_count_entries(const struct mtbl_metadata *m);

uint64_t
mtbl_metadata_count_data_blocks(const struct mtbl_metadata *m);

uint64_t
mtbl_metadata_bytes_data_blocks(const struct mtbl_metadata *m);

uint64_t
mtbl_metadata_bytes_index_block(const struct mtbl_metadata *m);

uint64_t
mtbl_metadata_bytes_keys(const struct mtbl_metadata *m);

uint64_t
mtbl_metadata_bytes_values(const struct mtbl_metadata *m);

---

💅 DESCRIPTION 💅

so here's the tea: you get yourself an mtbl_metadata object from an mtbl_reader(3). that's the source, that's the plug, that's where it comes from. and then all its little accessor functions spill the attributes and the file statistics that got recorded in the metadata block. it's giving receipts, honestly. every number you could possibly want about your file is just sitting there, waiting. obsessed 💖

---

🦋 RETURN VALUE 🦋

mtbl_metadata_file_version()

the file format version of the MTBL file, bestie. it's either MTBL_FORMAT_V1 or MTBL_FORMAT_V2. that's it, that's the whole vibe check. ✨

mtbl_metadata_index_block_offset()

the byte offset in the MTBL file where the index begins 👑

mtbl_metadata_data_block_size()

the maximum size of an uncompressed data block. and if you wanna know more about that, go look at mtbl_writer(3) fr fr.

mtbl_metadata_compression_algorithm()

one of the compression values that mtbl_writer(3) allows. literally just one of those. 🎀

mtbl_metadata_count_entries()

the total number of key-value entries. every single one. counted. periodt.

mtbl_metadata_count_data_blocks()

the total number of data blocks 🌈

mtbl_metadata_bytes_data_blocks()

the total number of bytes consumed by data blocks 🌸

mtbl_metadata_bytes_index_block()

the total number of bytes consumed by the index 💜

mtbl_metadata_bytes_keys()

the total number of bytes that all keys would occupy if they were stored end-to-end in a byte array with no delimiters. no commas, no nothing. just keys, shoulder to shoulder, iconic behavior honestly.

mtbl_metadata_bytes_values()

the total number of bytes that all values in the file would occupy if they were stored end-to-end in a byte array with no delimiters. same deal, different data. slay 💅

---

not a single option, flag, or caveat got left behind, bestie. we keep every detail around here, no cap. 🫶

---

that's the whole page!! mwah 💖

signing off — this was page MTBL_METADATA(3), dated 02/10/2017, and yes she ate. go forth and read your metadata, main character. 👑✨