add native file format docs #3190
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eldenmoon
force-pushed
the
native-doc
branch
from
804cb1b to
d9e3d6a
Compare
eldenmoon
added a commit
to apache/doris
that referenced
this pull request
Dec 18, 2025
support export doris native format file ``` // Doris Native format file-level constants. // // File layout (byte stream): // // +-------------------------------+---------------------------+---------------------------+ ... // | File header | Data block #0 | Data block #1 | ... // +-------------------------------+---------------------------+---------------------------+ ... // // File header (12 bytes total): // - [0..7] : magic bytes "DORISN1\0" (DORIS_NATIVE_MAGIC) // - [8..11] : uint32_t format_version (DORIS_NATIVE_FORMAT_VERSION, little-endian) // // Each data block i: // - uint64_t block_size : length in bytes of serialized PBlock (little-endian) // - uint8_t[block_size] : PBlock protobuf payload produced by Block::serialize() // // NativeReader: // - Detects the optional file header by checking the first 8 bytes against DORIS_NATIVE_MAGIC. // - If the header is present, it skips 12 bytes and then starts reading blocks as // [uint64_t block_size][PBlock bytes]... // - If the header is absent (legacy files), it starts reading blocks from offset 0. // // VNativeTransformer: // - Writes the header once in open(), then appends each block in write() as // [uint64_t block_size][PBlock bytes]... // // These constants are shared between writer, reader and tests to keep the on-disk // format definition in a single place. // Header layout: // [magic bytes "DORISN1\0"][uint32_t format_version] ``` docs: apache/doris-website#3190
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Versions
Languages
Docs Checklist