Files
scylladb/tools/sstable_consumer.hh
Botond Dénes 8045751867 tools/sstable_consumer: more consistent method naming
Use `consume_` consistently across the entire interface, instead of having
some methods with `on_` and others with `consume_` prefixes.
2023-01-09 09:46:57 -05:00

49 lines
1.7 KiB
C++

/*
* Copyright (C) 2022-present ScyllaDB
*/
/*
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
#pragma once
#include "seastarx.hh"
#include <seastar/core/loop.hh>
namespace sstables {
class sstable;
}
class partition_start;
class static_row;
class clustering_row;
class range_tombstone_change;
class partition_end;
// stop_iteration::no -> continue consuming sstable content
class sstable_consumer {
public:
virtual ~sstable_consumer() = default;
// called at the very start
virtual future<> consume_stream_start() = 0;
// stop_iteration::yes -> consume_end_of_sstable() - skip sstable content
// sstable parameter is nullptr when merging multiple sstables
virtual future<stop_iteration> consume_sstable_start(const sstables::sstable* const) = 0;
// stop_iteration::yes -> consume(partition_end) - skip partition content
virtual future<stop_iteration> consume(partition_start&&) = 0;
// stop_iteration::yes -> consume(partition_end) - skip remaining partition content
virtual future<stop_iteration> consume(static_row&&) = 0;
// stop_iteration::yes -> consume(partition_end) - skip remaining partition content
virtual future<stop_iteration> consume(clustering_row&&) = 0;
// stop_iteration::yes -> consume(partition_end) - skip remaining partition content
virtual future<stop_iteration> consume(range_tombstone_change&&) = 0;
// stop_iteration::yes -> consume_end_of_sstable() - skip remaining partitions in sstable
virtual future<stop_iteration> consume(partition_end&&) = 0;
// stop_iteration::yes -> full stop - skip remaining sstables
virtual future<stop_iteration> consume_sstable_end() = 0;
// called at the very end
virtual future<> consume_stream_end() = 0;
};