Skip to content

ExternalTable support FS #14629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
joshkang97 wants to merge 3 commits into from
+8 −4
Closed

ExternalTable support FS #14629

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
143af65
commit
joshkang97 Apr 17, 2026
b21901b
remove stats access
joshkang97 Apr 28, 2026
09e096c
Merge remote-tracking branch 'upstream/main' into external_table_addi…
joshkang97 May 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions include/rocksdb/external_table.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#include "rocksdb/file_system.h"
#include "rocksdb/iterator_base.h"
#include "rocksdb/options.h"
#include "rocksdb/statistics.h"
#include "rocksdb/status.h"

namespace ROCKSDB_NAMESPACE {
Expand Down Expand Up @@ -215,15 +216,17 @@ struct ExternalTableOptions {
const Comparator* comparator;
const std::shared_ptr<FileSystem>& fs;
const FileOptions& file_options;
Statistics* statistics;

ExternalTableOptions(
const std::shared_ptr<const SliceTransform>& _prefix_extractor,
const Comparator* _comparator, const std::shared_ptr<FileSystem>& _fs,
const FileOptions& _file_options)
const FileOptions& _file_options, Statistics* _statistics)
: prefix_extractor(_prefix_extractor),
comparator(_comparator),
fs(_fs),
file_options(_file_options) {}
file_options(_file_options),
statistics(_statistics) {}
};

struct ExternalTableBuilderOptions {
Expand All @@ -235,18 +238,23 @@ struct ExternalTableBuilderOptions {
const std::string db_id;
const std::string db_session_id;
const TableFileCreationReason reason;
const std::shared_ptr<FileSystem>& fs;
Statistics* statistics;

ExternalTableBuilderOptions(
const ReadOptions& _read_options, const WriteOptions& _write_options,
const std::shared_ptr<const SliceTransform>& _prefix_extractor,
const Comparator* _comparator, const std::string& _column_family_name,
const TableFileCreationReason _reason)
const TableFileCreationReason _reason,
const std::shared_ptr<FileSystem>& _fs, Statistics* _statistics)
: read_options(_read_options),
write_options(_write_options),
prefix_extractor(_prefix_extractor),
comparator(_comparator),
column_family_name(_column_family_name),
reason(_reason) {}
reason(_reason),
fs(_fs),
statistics(_statistics) {}
};

class ExternalTableFactory : public Customizable {
Expand Down
9 changes: 5 additions & 4 deletions table/external_table.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,9 +421,9 @@ class ExternalTableFactoryAdapter : public TableFactory {
}
std::unique_ptr<ExternalTableReader> reader;
FileOptions fopts(topts.env_options);
ExternalTableOptions ext_topts(topts.prefix_extractor,
topts.ioptions.user_comparator,
topts.ioptions.fs, fopts);
ExternalTableOptions ext_topts(
topts.prefix_extractor, topts.ioptions.user_comparator,
topts.ioptions.fs, fopts, topts.ioptions.stats);
auto status =
inner_->NewTableReader(ro, file->file_name(), ext_topts, &reader);
if (!status.ok()) {
Expand All @@ -442,7 +442,8 @@ class ExternalTableFactoryAdapter : public TableFactory {
ExternalTableBuilderOptions ext_topts(
topts.read_options, topts.write_options,
topts.moptions.prefix_extractor, topts.ioptions.user_comparator,
topts.column_family_name, topts.reason);
topts.column_family_name, topts.reason, topts.ioptions.fs,
topts.ioptions.stats);
auto file_wrapper =
std::make_unique<ExternalTableWritableFileWrapper>(file);
builder.reset(inner_->NewTableBuilder(ext_topts, file->file_name(),
Expand Down
37 changes: 25 additions & 12 deletions table/table_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7030,9 +7030,11 @@ class ExternalTableTest : public DBTestBase {
class DummyExternalTableReader : public ExternalTableReader {
public:
explicit DummyExternalTableReader(const std::string& file_path,
bool support_property_block)
bool support_property_block,
Statistics* stats = nullptr)
: file_(file_path, /*file=*/nullptr),
support_property_block_(support_property_block) {
support_property_block_(support_property_block),
stats_(stats) {
Status s = file_.Deserialize(kv_map_);
EXPECT_OK(s);
}
Expand All @@ -7046,6 +7048,7 @@ class ExternalTableTest : public DBTestBase {
Status Get(const ReadOptions& /*read_options*/, const Slice& key,
const SliceTransform* /*prefix_extractor*/,
PinnableSlice* value) override {
RecordTick(stats_, NUMBER_KEYS_READ);
auto iter = kv_map_.find(key.ToString());
if (iter != kv_map_.end()) {
value->PinSelf(iter->second);
Expand Down Expand Up @@ -7089,6 +7092,7 @@ class ExternalTableTest : public DBTestBase {
std::map<std::string, std::string> kv_map_;
DummyExternalTableFile file_;
bool support_property_block_;
Statistics* stats_;
};

// A reader that pins values from its internal buffer, exercising the
Expand Down Expand Up @@ -7127,14 +7131,17 @@ class ExternalTableTest : public DBTestBase {
public:
explicit DummyExternalTableBuilder(const std::string& file_path,
FSWritableFile* file,
bool support_property_block)
bool support_property_block,
Statistics* stats = nullptr)
: file_(file_path, file),
support_property_block_(support_property_block) {}
support_property_block_(support_property_block),
stats_(stats) {}

void Add(const Slice& key, const Slice& value) override {
if (!kv_vec_.empty()) {
ASSERT_LT(BytewiseComparator()->Compare(kv_vec_.back().first, key), 0);
}
RecordTick(stats_, NUMBER_KEYS_WRITTEN);
kv_vec_.emplace_back(key.ToString(), value.ToString());
}

Expand Down Expand Up @@ -7165,6 +7172,7 @@ class ExternalTableTest : public DBTestBase {
DummyExternalTableFile file_;
Status status_;
bool support_property_block_;
Statistics* stats_;
};

class DummyExternalTableFactory : public ExternalTableFactory {
Expand All @@ -7180,16 +7188,16 @@ class ExternalTableTest : public DBTestBase {
// Sanity check some options
EXPECT_EQ(topts.file_options.handoff_checksum_type,
ChecksumType::kCRC32c);
table_reader->reset(
new DummyExternalTableReader(file_path, support_property_block_));
table_reader->reset(new DummyExternalTableReader(
file_path, support_property_block_, topts.statistics));
return Status::OK();
}

ExternalTableBuilder* NewTableBuilder(
const ExternalTableBuilderOptions& /*opts*/,
const std::string& file_path, FSWritableFile* file) const override {
return new DummyExternalTableBuilder(file_path, file,
support_property_block_);
const ExternalTableBuilderOptions& opts, const std::string& file_path,
FSWritableFile* file) const override {
return new DummyExternalTableBuilder(
file_path, file, support_property_block_, opts.statistics);
}

private:
Expand Down Expand Up @@ -7232,6 +7240,8 @@ TEST_F(ExternalTableTest, BasicTest) {
std::shared_ptr<ExternalTableFactory> factory =
std::make_shared<DummyExternalTableFactory>(
/*support_property_block=*/false);
std::shared_ptr<Statistics> builder_stats = CreateDBStatistics();
std::shared_ptr<Statistics> reader_stats = CreateDBStatistics();

std::string file_path = test::PerThreadDBPath("external_table");
{
Expand All @@ -7240,18 +7250,20 @@ TEST_F(ExternalTableTest, BasicTest) {
ExternalTableBuilderOptions(ReadOptions(), WriteOptions(),
std::shared_ptr<const SliceTransform>(),
BytewiseComparator(), "default",
TableFileCreationReason::kMisc),
TableFileCreationReason::kMisc,
/*fs=*/nullptr, builder_stats.get()),
file_path, /*file=*/nullptr));
builder->Add("foo", "bar");
ASSERT_OK(builder->Finish());
}
ASSERT_EQ(builder_stats->getTickerCount(NUMBER_KEYS_WRITTEN), 1);

std::unique_ptr<ExternalTableReader> reader;
std::shared_ptr<SliceTransform> prefix_extractor;
ASSERT_OK(factory->NewTableReader(
{}, file_path,
ExternalTableOptions(prefix_extractor, /*comparator=*/nullptr,
/*fs=*/nullptr, FileOptions()),
/*fs=*/nullptr, FileOptions(), reader_stats.get()),
&reader));

ReadOptions ro;
Expand All @@ -7275,6 +7287,7 @@ TEST_F(ExternalTableTest, BasicTest) {
ASSERT_EQ(vals[0], "bar");
ASSERT_EQ(statuses[0], Status::OK());
ASSERT_EQ(statuses[1], Status::NotFound());
ASSERT_EQ(reader_stats->getTickerCount(NUMBER_KEYS_READ), 3);
}

TEST_F(ExternalTableTest, SstReaderTest) {
Expand Down
Loading