vlink::BagWriter::Config Struct Reference

Configuration for recording behaviour, splitting, compression, and limits. More...

#include <bag_writer.h>

Collaboration diagram for vlink::BagWriter::Config:

Public Member Functions
	Config ()

Public Attributes
std::string	tag_name
	Optional tag name stored in the bag header.
CompressType	compress {CompressType::kCompressNone}
	Compression algorithm.
bool	wal_mode {false}
	Enable SQLite WAL mode for crash resilience.
bool	enable_limit {false}
	Enable max_row_count / max_bytes_size limits.
bool	split_name_by_time {false}
	Append timestamp to split file names.
bool	sync_mode {false}
	Enable synchronous writes to disk.
bool	optimize_on_exit {false}
	Run VACUUM/optimise on file close.
int64_t	max_row_count {5'000'000'000LL}
	Max rows before splitting (if enable_limit).
int64_t	max_bytes_size {1024LL * 1024LL * 1024LL * 512LL}
	Max file bytes before splitting (if enable_limit).
int64_t	split_by_size {1024LL * 1024LL * 1024LL * 1LL}
	Split file when it reaches this size (bytes).
int64_t	split_by_time {0}
	Split file every N milliseconds. 0 = disabled.
int64_t	begin_time {0}
	Recording start timestamp (ms). 0 = now.
int64_t	cache_size {1024LL * 1024LL * 4}
	SQLite page cache size (bytes).
int64_t	compress_start_size {128}
	Minimum payload size (bytes) to compress.
int64_t	compress_level {3}
	Compression level (codec-specific).
int64_t	max_task_depth {20000}
	Max pending write tasks in the queue.
int64_t	max_memory_size {1024LL * 1024LL * 1024LL * 2LL}
	Max in-memory cache size (bytes).
int64_t	start_timestamp {0}
	Override the bag start timestamp (ms since epoch).
std::unordered_set< std::string >	ignore_compress_urls
	URLs whose payloads are never compressed.

Detailed Description

Configuration for recording behaviour, splitting, compression, and limits.

All size fields are in bytes; all time fields are in milliseconds unless noted otherwise.

Constructor & Destructor Documentation

Config()

vlink::BagWriter::Config::Config ( )

inline

Member Data Documentation

begin_time

int64_t vlink::BagWriter::Config::begin_time {0}

Recording start timestamp (ms). 0 = now.

cache_size

int64_t vlink::BagWriter::Config::cache_size {1024LL * 1024LL * 4}

SQLite page cache size (bytes).

compress

CompressType vlink::BagWriter::Config::compress {CompressType::kCompressNone}

Compression algorithm.

compress_level

int64_t vlink::BagWriter::Config::compress_level {3}

Compression level (codec-specific).

compress_start_size

int64_t vlink::BagWriter::Config::compress_start_size {128}

Minimum payload size (bytes) to compress.

enable_limit

bool vlink::BagWriter::Config::enable_limit {false}

Enable max_row_count / max_bytes_size limits.

ignore_compress_urls

std::unordered_set<std::string> vlink::BagWriter::Config::ignore_compress_urls

URLs whose payloads are never compressed.

max_bytes_size

int64_t vlink::BagWriter::Config::max_bytes_size {1024LL * 1024LL * 1024LL * 512LL}

Max file bytes before splitting (if enable_limit).

max_memory_size

int64_t vlink::BagWriter::Config::max_memory_size {1024LL * 1024LL * 1024LL * 2LL}

Max in-memory cache size (bytes).

max_row_count

int64_t vlink::BagWriter::Config::max_row_count {5'000'000'000LL}

Max rows before splitting (if enable_limit).

max_task_depth

int64_t vlink::BagWriter::Config::max_task_depth {20000}

Max pending write tasks in the queue.

optimize_on_exit

bool vlink::BagWriter::Config::optimize_on_exit {false}

Run VACUUM/optimise on file close.

split_by_size

int64_t vlink::BagWriter::Config::split_by_size {1024LL * 1024LL * 1024LL * 1LL}

Split file when it reaches this size (bytes).

split_by_time

int64_t vlink::BagWriter::Config::split_by_time {0}

Split file every N milliseconds. 0 = disabled.

split_name_by_time

bool vlink::BagWriter::Config::split_name_by_time {false}

Append timestamp to split file names.

start_timestamp

int64_t vlink::BagWriter::Config::start_timestamp {0}

Override the bag start timestamp (ms since epoch).

sync_mode

bool vlink::BagWriter::Config::sync_mode {false}

Enable synchronous writes to disk.

tag_name

std::string vlink::BagWriter::Config::tag_name

Optional tag name stored in the bag header.

wal_mode

bool vlink::BagWriter::Config::wal_mode {false}

Enable SQLite WAL mode for crash resilience.

---

The documentation for this struct was generated from the following file:

• include/vlink/extension/bag_writer.h