org.apache.paimon.fileindex

Class FileIndexFormat

java.lang.Object

org.apache.paimon.fileindex.FileIndexFormat

public final class FileIndexFormat
extends Object

File index file format. Put all column and offset in the header.

   _____________________________________    _____________________
 ｜     magic    ｜version｜head length ｜
 ｜-------------------------------------｜
 ｜            column number            ｜
 ｜-------------------------------------｜
 ｜   column 1        ｜ index number   ｜
 ｜-------------------------------------｜
 ｜  index name 1 ｜start pos ｜length  ｜
 ｜-------------------------------------｜
 ｜  index name 2 ｜start pos ｜length  ｜
 ｜-------------------------------------｜
 ｜  index name 3 ｜start pos ｜length  ｜
 ｜-------------------------------------｜            HEAD
 ｜   column 2        ｜ index number   ｜
 ｜-------------------------------------｜
 ｜  index name 1 ｜start pos ｜length  ｜
 ｜-------------------------------------｜
 ｜  index name 2 ｜start pos ｜length  ｜
 ｜-------------------------------------｜
 ｜  index name 3 ｜start pos ｜length  ｜
 ｜-------------------------------------｜
 ｜                 ...                 ｜
 ｜-------------------------------------｜
 ｜                 ...                 ｜
 ｜-------------------------------------｜
 ｜  redundant length ｜redundant bytes ｜
 ｜-------------------------------------｜    ---------------------
 ｜                BODY                 ｜
 ｜                BODY                 ｜
 ｜                BODY                 ｜             BODY
 ｜                BODY                 ｜
 ｜_____________________________________｜    _____________________

 magic:                            8 bytes long
 version:                          4 bytes int
 head length:                      4 bytes int
 column number:                    4 bytes int
 column x:                         var bytes utf (length + bytes)
 index number:                     4 bytes int (how many column items below)
 index name x:                     var bytes utf
 start pos:                        4 bytes int
 length:                           4 bytes int
 redundant length:                 4 bytes int (for compatibility with later versions, in this version, content is zero)
 redundant bytes:                  var bytes (for compatibility with later version, in this version, is empty)
 BODY:                             column index bytes + column index bytes + column index bytes + .......

 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileIndexFormat.Reader Reader for file index file.
static class	FileIndexFormat.Writer Writer for file index file.

Constructor Summary

Constructors

Constructor and Description
FileIndexFormat()

Method Summary

Modifier and Type	Method and Description
static FileIndexFormat.Reader	createReader(SeekableInputStream inputStream, RowType fileRowType)
static FileIndexFormat.Writer	createWriter(OutputStream outputStream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileIndexFormat

public FileIndexFormat()

Method Detail

createWriter

public static FileIndexFormat.Writer createWriter(OutputStream outputStream)

createReader

public static FileIndexFormat.Reader createReader(SeekableInputStream inputStream,
                                                  RowType fileRowType)