3c327ac2d0
Summary: Closes https://github.com/facebook/rocksdb/pull/2589 Differential Revision: D5431502 Pulled By: siying fbshipit-source-id: 8ebf8c87883daa9daa54b2303d11ce01ab1f6f75
116 lines
4.4 KiB
C++
116 lines
4.4 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).
|
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "rocksdb/env.h"
|
|
#include "rocksdb/options.h"
|
|
#include "rocksdb/table_properties.h"
|
|
#include "rocksdb/types.h"
|
|
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
#define ROCKSDB_DEPRECATED_FUNC __attribute__((__deprecated__))
|
|
#elif _WIN32
|
|
#define ROCKSDB_DEPRECATED_FUNC __declspec(deprecated)
|
|
#endif
|
|
|
|
namespace rocksdb {
|
|
|
|
class Comparator;
|
|
|
|
// ExternalSstFileInfo include information about sst files created
|
|
// using SstFileWriter.
|
|
struct ExternalSstFileInfo {
|
|
ExternalSstFileInfo() {}
|
|
ExternalSstFileInfo(const std::string& _file_path,
|
|
const std::string& _smallest_key,
|
|
const std::string& _largest_key,
|
|
SequenceNumber _sequence_number, uint64_t _file_size,
|
|
int32_t _num_entries, int32_t _version)
|
|
: file_path(_file_path),
|
|
smallest_key(_smallest_key),
|
|
largest_key(_largest_key),
|
|
sequence_number(_sequence_number),
|
|
file_size(_file_size),
|
|
num_entries(_num_entries),
|
|
version(_version) {}
|
|
|
|
std::string file_path; // external sst file path
|
|
std::string smallest_key; // smallest user key in file
|
|
std::string largest_key; // largest user key in file
|
|
SequenceNumber sequence_number; // sequence number of all keys in file
|
|
uint64_t file_size; // file size in bytes
|
|
uint64_t num_entries; // number of entries in file
|
|
int32_t version; // file version
|
|
};
|
|
|
|
// SstFileWriter is used to create sst files that can be added to database later
|
|
// All keys in files generated by SstFileWriter will have sequence number = 0.
|
|
class SstFileWriter {
|
|
public:
|
|
// User can pass `column_family` to specify that the generated file will
|
|
// be ingested into this column_family, note that passing nullptr means that
|
|
// the column_family is unknown.
|
|
// If invalidate_page_cache is set to true, SstFileWriter will give the OS a
|
|
// hint that this file pages is not needed everytime we write 1MB to the file.
|
|
// To use the rate limiter an io_priority smaller than IO_TOTAL can be passed.
|
|
SstFileWriter(const EnvOptions& env_options, const Options& options,
|
|
ColumnFamilyHandle* column_family = nullptr,
|
|
bool invalidate_page_cache = true,
|
|
Env::IOPriority io_priority = Env::IOPriority::IO_TOTAL)
|
|
: SstFileWriter(env_options, options, options.comparator, column_family,
|
|
invalidate_page_cache, io_priority) {}
|
|
|
|
// Deprecated API
|
|
SstFileWriter(const EnvOptions& env_options, const Options& options,
|
|
const Comparator* user_comparator,
|
|
ColumnFamilyHandle* column_family = nullptr,
|
|
bool invalidate_page_cache = true,
|
|
Env::IOPriority io_priority = Env::IOPriority::IO_TOTAL);
|
|
|
|
~SstFileWriter();
|
|
|
|
// Prepare SstFileWriter to write into file located at "file_path".
|
|
Status Open(const std::string& file_path);
|
|
|
|
// Add a Put key with value to currently opened file (deprecated)
|
|
// REQUIRES: key is after any previously added key according to comparator.
|
|
ROCKSDB_DEPRECATED_FUNC Status Add(const Slice& user_key, const Slice& value);
|
|
|
|
// Add a Put key with value to currently opened file
|
|
// REQUIRES: key is after any previously added key according to comparator.
|
|
Status Put(const Slice& user_key, const Slice& value);
|
|
|
|
// Add a Merge key with value to currently opened file
|
|
// REQUIRES: key is after any previously added key according to comparator.
|
|
Status Merge(const Slice& user_key, const Slice& value);
|
|
|
|
// Add a deletion key to currently opened file
|
|
// REQUIRES: key is after any previously added key according to comparator.
|
|
Status Delete(const Slice& user_key);
|
|
|
|
// Finalize writing to sst file and close file.
|
|
//
|
|
// An optional ExternalSstFileInfo pointer can be passed to the function
|
|
// which will be populated with information about the created sst file.
|
|
Status Finish(ExternalSstFileInfo* file_info = nullptr);
|
|
|
|
// Return the current file size.
|
|
uint64_t FileSize();
|
|
|
|
private:
|
|
void InvalidatePageCache(bool closing);
|
|
struct Rep;
|
|
std::unique_ptr<Rep> rep_;
|
|
};
|
|
} // namespace rocksdb
|
|
|
|
#endif // !ROCKSDB_LITE
|