YugabyteDB (2.13.0.0-b42, bfc6a6643e7399ac8a0e81d06a3ee6d6571b33ab)

//  Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.

//  This source code is licensed under the BSD-style license found in the

//  LICENSE file in the root directory of this source tree. An additional grant

//  of patent rights can be found in the PATENTS file in the same directory.

//

// The following only applies to changes made to this file as part of YugaByte development.

//

// Portions Copyright (c) YugaByte, Inc.

//

// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except

// in compliance with the License.  You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software distributed under the License

// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

// or implied.  See the License for the specific language governing permissions and limitations

// under the License.

//

#ifndef ROCKSDB_INCLUDE_ROCKSDB_SST_FILE_WRITER_H

#define ROCKSDB_INCLUDE_ROCKSDB_SST_FILE_WRITER_H

#include <string>

#include "yb/rocksdb/env.h"

#include "yb/rocksdb/immutable_options.h"

#include "yb/rocksdb/types.h"

namespace rocksdb {

class Comparator;

// Table Properties that are specific to tables created by SstFileWriter.

struct ExternalSstFilePropertyNames {

  // value of this property is a fixed int32 number.

  static const char kVersion[];

};

// 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,

                      uint64_t _base_file_size, bool _is_split_sst, 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),

        base_file_size(_base_file_size),

        is_split_sst(_is_split_sst),

        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;              // total file(s) size in bytes

  uint64_t base_file_size;         // base file size in bytes

  bool is_split_sst;               // is SST split into metadata and data file(s)

  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:

  SstFileWriter(const EnvOptions& env_options,

                const ImmutableCFOptions& ioptions,

                const Comparator* user_comparator);

  ~SstFileWriter();

  // Prepare SstFileWriter to write into file located at "file_path".

  Status Open(const std::string& file_path);

  // Add key, value to currently opened file

  // REQUIRES: key is after any previously added key according to comparator.

  Status Add(const Slice& user_key, const Slice& value);

  // 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);

 private:

  class SstFileWriterPropertiesCollectorFactory;

  class SstFileWriterPropertiesCollector;

  struct Rep;

  Rep* rep_;

};

}  // namespace rocksdb

#endif  // ROCKSDB_INCLUDE_ROCKSDB_SST_FILE_WRITER_H