3c327ac2d0
Summary: Closes https://github.com/facebook/rocksdb/pull/2589 Differential Revision: D5431502 Pulled By: siying fbshipit-source-id: 8ebf8c87883daa9daa54b2303d11ce01ab1f6f75
44 lines
1.6 KiB
C++
44 lines
1.6 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).
|
|
//
|
|
// A checkpoint is an openable snapshot of a database at a point in time.
|
|
|
|
#pragma once
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
#include <string>
|
|
#include "rocksdb/status.h"
|
|
|
|
namespace rocksdb {
|
|
|
|
class DB;
|
|
|
|
class Checkpoint {
|
|
public:
|
|
// Creates a Checkpoint object to be used for creating openable snapshots
|
|
static Status Create(DB* db, Checkpoint** checkpoint_ptr);
|
|
|
|
// Builds an openable snapshot of RocksDB on the same disk, which
|
|
// accepts an output directory on the same disk, and under the directory
|
|
// (1) hard-linked SST files pointing to existing live SST files
|
|
// SST files will be copied if output directory is on a different filesystem
|
|
// (2) a copied manifest files and other files
|
|
// The directory should not already exist and will be created by this API.
|
|
// The directory will be an absolute path
|
|
// log_size_for_flush: if the total log file size is equal or larger than
|
|
// this value, then a flush is triggered for all the column families. The
|
|
// default value is 0, which means flush is always triggered. If you move
|
|
// away from the default, the checkpoint may not contain up-to-date data
|
|
// if WAL writing is not always enabled.
|
|
// Flush will always trigger if it is 2PC.
|
|
virtual Status CreateCheckpoint(const std::string& checkpoint_dir,
|
|
uint64_t log_size_for_flush = 0);
|
|
|
|
virtual ~Checkpoint() {}
|
|
};
|
|
|
|
} // namespace rocksdb
|
|
#endif // !ROCKSDB_LITE
|