Skip to content

feat: expose BlobDescriptor as public API #377

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

Merged
lxy-9602 merged 2 commits into from
Sep 21, 2026
Merged

feat: expose BlobDescriptor as public API #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f403fd2
feat: expose BlobDescriptor as public API
Smith-Cruise Sep 21, 2026
5c718d8
refactor: hide BlobDescriptor implementation constants
Smith-Cruise Sep 21, 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
4 changes: 1 addition & 3 deletions src/paimon/common/data/blob_descriptor.h → include/paimon/data/blob_descriptor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#include "paimon/memory/bytes.h"
#include "paimon/memory/memory_pool.h"
#include "paimon/result.h"
#include "paimon/visibility.h"

namespace paimon {
/// Blob descriptor to describe a blob reference.
Expand Down Expand Up @@ -78,9 +79,6 @@ class PAIMON_EXPORT BlobDescriptor {
: version_(version), uri_(uri), offset_(offset), length_(length) {}

private:
static constexpr int64_t kMagic = 0x424C4F4244455343l;
/// one byte for version, eight bytes for magic number.
static constexpr uint64_t kMinDescriptorLength = 9;
static constexpr int8_t kCurrentVersion = 2;

const int8_t version_ = kCurrentVersion;
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/common/data/blob.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
#include <utility>

#include "arrow/c/bridge.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/blob_utils.h"
#include "paimon/common/io/offset_input_stream.h"
#include "paimon/common/utils/arrow/status_utils.h"
#include "paimon/common/utils/path_util.h"
#include "paimon/common/utils/stream_utils.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/memory/bytes.h"
#include "paimon/status.h"

Expand Down
9 changes: 8 additions & 1 deletion src/paimon/common/data/blob_descriptor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

#include "paimon/common/data/blob_descriptor.h"
#include "paimon/data/blob_descriptor.h"

#include <utility>

Expand All @@ -31,6 +31,13 @@
#include "paimon/status.h"

namespace paimon {
namespace {
Comment thread
lxy-9602 marked this conversation as resolved.

constexpr int64_t kMagic = 0x424C4F4244455343l;
// One byte for version, eight bytes for magic number.
constexpr uint64_t kMinDescriptorLength = 9;

} // namespace

Result<std::unique_ptr<BlobDescriptor>> BlobDescriptor::Create(const std::string& uri,
int64_t offset, int64_t length) {
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/common/data/blob_descriptor_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

#include "paimon/common/data/blob_descriptor.h"
#include "paimon/data/blob_descriptor.h"

#include <memory>
#include <vector>
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/common/data/blob_utils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@
#include "arrow/type.h"
#include "fmt/format.h"
#include "paimon/common/data/blob_defs.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/blob_view_struct.h"
#include "paimon/common/types/data_field.h"
#include "paimon/common/utils/arrow/status_utils.h"
#include "paimon/common/utils/checked_cast.h"
#include "paimon/common/utils/string_utils.h"
#include "paimon/data/blob_descriptor.h"
namespace arrow {
class Array;
}
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/common/data/blob_utils_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
#include "gtest/gtest.h"
#include "paimon/catalog/identifier.h"
#include "paimon/common/data/blob_defs.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/blob_view_struct.h"
#include "paimon/common/types/data_field.h"
#include "paimon/common/utils/checked_cast.h"
#include "paimon/data/blob.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/memory/memory_pool.h"
#include "paimon/testing/utils/testharness.h"

Expand Down
2 changes: 1 addition & 1 deletion src/paimon/common/reader/blob_view_resolving_batch_reader_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@
#include "arrow/c/bridge.h"
#include "gtest/gtest.h"
#include "paimon/catalog/identifier.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/blob_utils.h"
#include "paimon/common/data/blob_view_struct.h"
#include "paimon/common/metrics/metrics_impl.h"
#include "paimon/common/utils/arrow/mem_utils.h"
#include "paimon/common/utils/arrow/status_utils.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/memory/bytes.h"
#include "paimon/memory/memory_pool.h"
#include "paimon/reader/batch_reader.h"
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/core/append/append_only_writer_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
#include "arrow/type.h"
#include "arrow/util/key_value_metadata.h"
#include "gtest/gtest.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/blob_utils.h"
#include "paimon/common/data/blob_view_struct.h"
#include "paimon/common/data/shredding/map_shared_shredding_utils.h"
Expand All @@ -55,6 +54,7 @@
#include "paimon/core/manifest/file_source.h"
#include "paimon/core/stats/simple_stats.h"
#include "paimon/core/utils/commit_increment.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/defs.h"
#include "paimon/file_index/file_index_format.h"
#include "paimon/format/file_format_factory.h"
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/core/utils/blob_view_lookup.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@
#include "arrow/c/bridge.h"
#include "fmt/format.h"
#include "paimon/catalog/catalog.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/executor/future.h"
#include "paimon/common/table/special_fields.h"
#include "paimon/common/utils/arrow/status_utils.h"
#include "paimon/common/utils/checked_cast.h"
#include "paimon/common/utils/path_util.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/defs.h"
#include "paimon/executor.h"
#include "paimon/global_index/bitmap_global_index_result.h"
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/format/blob/blob_format_writer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@
#include "arrow/api.h"
#include "arrow/c/bridge.h"
#include "paimon/common/data/blob_defs.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/blob_utils.h"
#include "paimon/common/memory/memory_segment_utils.h"
#include "paimon/common/metrics/metrics_impl.h"
#include "paimon/common/utils/arrow/status_utils.h"
#include "paimon/common/utils/checked_cast.h"
#include "paimon/common/utils/delta_varint_compressor.h"
#include "paimon/data/blob.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/fs/file_system.h"
#include "paimon/io/byte_array_input_stream.h"
#include "paimon/logging.h"
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/format/blob/blob_format_writer_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@

#include "arrow/c/bridge.h"
#include "gtest/gtest.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/utils/arrow/mem_utils.h"
#include "paimon/common/utils/arrow/status_utils.h"
#include "paimon/common/utils/checked_cast.h"
#include "paimon/common/utils/stream_utils.h"
#include "paimon/data/blob.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/format/blob/blob_file_batch_reader.h"
#include "paimon/fs/local/local_file_system.h"
#include "paimon/testing/utils/read_result_collector.h"
Expand Down
2 changes: 1 addition & 1 deletion src/paimon/testing/utils/test_helper.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
#include "paimon/api.h"
#include "paimon/catalog/catalog.h"
#include "paimon/commit_context.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/blob_utils.h"
#include "paimon/common/types/data_field.h"
#include "paimon/common/utils/arrow/status_utils.h"
Expand All @@ -47,6 +46,7 @@
#include "paimon/core/utils/file_store_path_factory.h"
#include "paimon/core/utils/snapshot_manager.h"
#include "paimon/data/blob.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/file_store_commit.h"
#include "paimon/file_store_write.h"
#include "paimon/fs/file_system_factory.h"
Expand Down
2 changes: 1 addition & 1 deletion test/inte/blob_table_inte_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
#include "paimon/common/data/binary_row.h"
#include "paimon/common/data/binary_row_writer.h"
#include "paimon/common/data/blob_defs.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/blob_utils.h"
#include "paimon/common/data/blob_view_struct.h"
#include "paimon/common/factories/io_hook.h"
Expand All @@ -61,6 +60,7 @@
#include "paimon/core/utils/file_utils.h"
#include "paimon/core/utils/snapshot_manager.h"
#include "paimon/data/blob.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/defs.h"
#include "paimon/file_store_write.h"
#include "paimon/format/mosaic/mosaic_format_defs.h"
Expand Down
2 changes: 1 addition & 1 deletion test/inte/paimon_read_compat_inte_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
#include "arrow/api.h"
#include "arrow/ipc/json_simple.h"
#include "gtest/gtest.h"
#include "paimon/common/data/blob_descriptor.h"
#include "paimon/common/data/variant/generic_variant.h"
#include "paimon/data/blob_descriptor.h"
#include "paimon/defs.h"
#include "paimon/read_context.h"
#include "paimon/reader/batch_reader.h"
Expand Down
Loading