mirror of
https://github.com/facebook/rocksdb.git
synced 2024-12-03 05:54:17 +00:00
5e72bc113a
Summary: A user friendly sst file reader is useful when we want to access sst files outside of RocksDB. For example, we can generate an sst file with SstFileWriter and send it to other places, then use SstFileReader to read the file and process the entries in other ways. Also rename the original SstFileReader to SstFileDumper because of name conflict, and seems SstFileDumper is more appropriate for tools. TODO: there is only a very simple test now, because I want to get some feedback first. If the changes look good, I will add more tests soon. Pull Request resolved: https://github.com/facebook/rocksdb/pull/4717 Differential Revision: D13212686 Pulled By: ajkr fbshipit-source-id: 737593383264c954b79e63edaf44aaae0d947e56
85 lines
2.8 KiB
C++
85 lines
2.8 KiB
C++
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
// (found in the LICENSE.Apache file in the root directory).
|
|
#pragma once
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
#include "rocksdb/sst_dump_tool.h"
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include "db/dbformat.h"
|
|
#include "options/cf_options.h"
|
|
#include "util/file_reader_writer.h"
|
|
|
|
namespace rocksdb {
|
|
|
|
class SstFileDumper {
|
|
public:
|
|
explicit SstFileDumper(const std::string& file_name, bool verify_checksum,
|
|
bool output_hex);
|
|
|
|
Status ReadSequential(bool print_kv, uint64_t read_num, bool has_from,
|
|
const std::string& from_key, bool has_to,
|
|
const std::string& to_key,
|
|
bool use_from_as_prefix = false);
|
|
|
|
Status ReadTableProperties(
|
|
std::shared_ptr<const TableProperties>* table_properties);
|
|
uint64_t GetReadNumber() { return read_num_; }
|
|
TableProperties* GetInitTableProperties() { return table_properties_.get(); }
|
|
|
|
Status VerifyChecksum();
|
|
Status DumpTable(const std::string& out_filename);
|
|
Status getStatus() { return init_result_; }
|
|
|
|
int ShowAllCompressionSizes(
|
|
size_t block_size,
|
|
const std::vector<std::pair<CompressionType, const char*>>&
|
|
compression_types);
|
|
|
|
private:
|
|
// Get the TableReader implementation for the sst file
|
|
Status GetTableReader(const std::string& file_path);
|
|
Status ReadTableProperties(uint64_t table_magic_number,
|
|
RandomAccessFileReader* file, uint64_t file_size);
|
|
|
|
uint64_t CalculateCompressedTableSize(const TableBuilderOptions& tb_options,
|
|
size_t block_size);
|
|
|
|
Status SetTableOptionsByMagicNumber(uint64_t table_magic_number);
|
|
Status SetOldTableOptions();
|
|
|
|
// Helper function to call the factory with settings specific to the
|
|
// factory implementation
|
|
Status NewTableReader(const ImmutableCFOptions& ioptions,
|
|
const EnvOptions& soptions,
|
|
const InternalKeyComparator& internal_comparator,
|
|
uint64_t file_size,
|
|
std::unique_ptr<TableReader>* table_reader);
|
|
|
|
std::string file_name_;
|
|
uint64_t read_num_;
|
|
bool verify_checksum_;
|
|
bool output_hex_;
|
|
EnvOptions soptions_;
|
|
|
|
// options_ and internal_comparator_ will also be used in
|
|
// ReadSequential internally (specifically, seek-related operations)
|
|
Options options_;
|
|
|
|
Status init_result_;
|
|
std::unique_ptr<TableReader> table_reader_;
|
|
std::unique_ptr<RandomAccessFileReader> file_;
|
|
|
|
const ImmutableCFOptions ioptions_;
|
|
const MutableCFOptions moptions_;
|
|
InternalKeyComparator internal_comparator_;
|
|
std::unique_ptr<TableProperties> table_properties_;
|
|
};
|
|
|
|
} // namespace rocksdb
|
|
|
|
#endif // ROCKSDB_LITE
|