construct/include/ircd/db/sst.h

// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.

#pragma once
#define HAVE_IRCD_DB_DATABASE_SST_H

struct ircd::db::database::sst
{
	struct info;
	struct dump;
	struct scan;

	[[deprecated]]
	static void tool(const vector_view<const string_view> &args);
};

/// Get info about an SST file.
///
struct ircd::db::database::sst::info
{
	struct vector;

	std::string name;
	std::string path;
	std::string column;
	std::string filter;
	std::string comparator;
	std::string merge_operator;
	std::string prefix_extractor;
	std::string compression;
	std::string checksum;
	std::string checksum_func;
	uint64_t id {0};
	uint64_t format {0};
	uint64_t cfid {0};
	uint64_t size {0};
	uint64_t head_size {0};         // index_size + filter_size
	uint64_t data_size {0};
	uint64_t file_size {0};         // head_size + data_size
	uint64_t meta_size {0};         // size - data_size (???)
	uint64_t index_root_size {0};
	uint64_t index_data_size {0};
	uint64_t index_size {0};        // index_root_size + index_data_size
	uint64_t filter_size {0};
	uint64_t keys_size {0};
	uint64_t values_size {0};
	uint64_t blocks_size {0};       // keys_size + values_size
	uint64_t index_parts {0};
	uint64_t data_blocks {0};
	uint64_t entries {0};
	uint64_t range_deletes {0};
	uint64_t fixed_key_len {0};
	uint64_t min_seq {0};
	uint64_t max_seq {0};
	std::string min_key;
	std::string max_key;
	uint64_t num_reads {0};
	int level {-1};
	bool compacting {false};
	int32_t version {-1};
	time_t created {0};
	time_t oldest_key {0};
	bool delta_encoding {false};
	float compression_pct {0.0};
	float index_compression_pct {0.0};
	float blocks_compression_pct {0.0};

	info(const database &, const string_view &filename);
	info() = default;

	info &operator=(rocksdb::SstFileMetaData &&);
	info &operator=(rocksdb::LiveFileMetaData &&);
	info &operator=(rocksdb::TableProperties &&);
};

struct ircd::db::database::sst::info::vector
:std::vector<info>
{
	vector() = default;
	explicit vector(const database &);
	explicit vector(const db::column &);
};

struct ircd::db::database::sst::dump
{
	using key_range = std::pair<string_view, string_view>;

	sst::info info;

	dump(db::column, const key_range & = {}, const string_view &path = {});
	dump(dump &&) = delete;
	dump(const dump &) = delete;
};

struct ircd::db::database::sst::scan
{
	using closure = std::function<bool (const string_view &, const string_view &)>;

	scan(db::database &, const string_view &path, const closure &);
	scan(db::database &, const string_view &path); // VerifyChecksum
};