package orc.proto

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: ColumnStatistics

• optional sint64 sum = 1

  sum will store the total binary blob length in a stripe

Used in: BitmapIndex

• optional bytes val = 1

• optional bytes bitmap = 2

• repeated BitmapColumn bitMapIndex = 1

Used in: BloomFilterIndex

• optional uint32 numHashFunctions = 1

• repeated fixed64 bitset = 2

• optional bytes utf8bitset = 3

• repeated BloomFilter bloomFilter = 1

Used in: ColumnStatistics

• repeated uint64 count = 1

Used in: Footer

• UNKNOWN_CALENDAR = 0

• JULIAN_GREGORIAN = 1

  A hybrid Julian/Gregorian calendar with a cutover point in October 1582.

• PROLEPTIC_GREGORIAN = 2

  A calendar that extends the Gregorian calendar back forever.

Statistics for list and map

Used in: ColumnStatistics

• optional uint64 minChildren = 1

• optional uint64 maxChildren = 2

• optional uint64 totalChildren = 3

Used in: StripeEncryptionVariant, StripeFooter

• optional ColumnEncoding.Kind kind = 1

• optional uint32 dictionarySize = 2

• optional uint32 bloomEncoding = 3

  The encoding of the bloom filters for this column: 0 or missing = none or original 1 = ORC-135 (utc for timestamps)

Used in: ColumnEncoding

• DIRECT = 0

• DICTIONARY = 1

• DIRECT_V2 = 2

• DICTIONARY_V2 = 3

Used in: ColumnarStripeStatistics, FileStatistics, Footer, RowIndexEntry, StripeStatistics

• optional uint64 numberOfValues = 1

• optional IntegerStatistics intStatistics = 2

• optional DoubleStatistics doubleStatistics = 3

• optional StringStatistics stringStatistics = 4

• optional BucketStatistics bucketStatistics = 5

• optional DecimalStatistics decimalStatistics = 6

• optional DateStatistics dateStatistics = 7

• optional BinaryStatistics binaryStatistics = 8

• optional TimestampStatistics timestampStatistics = 9

• optional bool hasNull = 10

• optional uint64 bytesOnDisk = 11

• optional CollectionStatistics collectionStatistics = 12

In ORC v2 (and for encrypted columns in v1), each column has their column statistics written separately.

• repeated ColumnStatistics colStats = 1

  one value for each stripe in the file

Used in: PostScript

• NONE = 0

• ZLIB = 1

• SNAPPY = 2

• LZO = 3

• LZ4 = 4

• ZSTD = 5

How was the data masked? This isn't necessary for reading the file, but is documentation about how the file was written.

Used in: Encryption

• optional string name = 1

  the kind of masking, which may include third party masks

• repeated string maskParameters = 2

  parameters for the mask

• repeated uint32 columns = 3

  the unencrypted column roots this mask was applied to

Used in: ColumnStatistics

• optional sint32 minimum = 1

  min,max values saved as days since epoch

• optional sint32 maximum = 2

• optional sint32 first = 3

• optional sint32 latest = 4

Used in: ColumnStatistics

• optional string minimum = 1

• optional string maximum = 2

• optional string sum = 3

Used in: ColumnStatistics

• optional double minimum = 1

• optional double maximum = 2

• optional double sum = 3

• optional double first = 4

• optional double latest = 5

Used in: Footer

• repeated DataMask mask = 1

  all of the masks used in this file

• repeated EncryptionKey key = 2

  all of the keys used in this file

• repeated EncryptionVariant variants = 3

  The encrypted variants. Readers should prefer the first variant that the user has access to the corresponding key. If they don't have access to any of the keys, they should get the unencrypted masked data.

• optional KeyProviderKind keyProvider = 4

  How are the local keys encrypted?

Used in: EncryptionKey

• UNKNOWN_ENCRYPTION = 0

  used for detecting future algorithms

• AES_CTR_128 = 1

• AES_CTR_256 = 2

Information about the encryption keys.

Used in: Encryption

• optional string keyName = 1

• optional uint32 keyVersion = 2

• optional EncryptionAlgorithm algorithm = 3

The description of an encryption variant. Each variant is a single subtype that is encrypted with a single key.

Used in: Encryption

• optional uint32 root = 1

  the column id of the root

• optional uint32 key = 2

  The master key that was used to encrypt the local key, referenced as an index into the Encryption.key list.

• optional bytes encryptedKey = 3

  the encrypted key for the file footer

• repeated Stream stripeStatistics = 4

  the stripe statistics for this variant

• optional bytes fileStatistics = 5

  encrypted file statistics as a FileStatistics

• repeated ColumnStatistics column = 1

The contents of the file tail that must be serialized. This gets serialized as part of OrcSplit, also used by footer cache.

• optional PostScript postscript = 1

• optional Footer footer = 2

• optional uint64 fileLength = 3

• optional uint64 postscriptLength = 4

Used in: FileTail

• optional uint64 headerLength = 1

• optional uint64 contentLength = 2

• repeated StripeInformation stripes = 3

• repeated Type types = 4

• repeated UserMetadataItem metadata = 5

• optional uint64 numberOfRows = 6

• repeated ColumnStatistics statistics = 7

• optional uint32 rowIndexStride = 8

• optional uint32 writer = 9

  Each implementation that writes ORC files should register for a code 0 = ORC Java 1 = ORC C++ 2 = Presto 3 = Scritchley Go from https://github.com/scritchley/orc

• optional Encryption encryption = 10

  information about the encryption in this file

• optional CalendarKind calendar = 11

Used in: ColumnStatistics

• optional sint64 minimum = 1

• optional sint64 maximum = 2

• optional sint64 sum = 3

• optional sint64 first = 4

• optional sint64 latest = 5

Which KeyProvider encrypted the local keys.

Used in: Encryption

• UNKNOWN = 0

• HADOOP = 1

• AWS = 2

• GCP = 3

• AZURE = 4

This message type is only used in ORC v0 and v1.

• repeated StripeStatistics stripeStats = 1

Serialized length must be less that 255 bytes

Used in: FileTail

• optional uint64 footerLength = 1

• optional CompressionKind compression = 2

• optional uint64 compressionBlockSize = 3

• repeated uint32 version = 4

  the version of the file format [0, 11] = Hive 0.11 [0, 12] = Hive 0.12

• optional uint64 metadataLength = 5

• optional uint32 writerVersion = 6

  The version of the writer that wrote the file. This number is updated when we make fixes or large changes to the writer so that readers can detect whether a given bug is present in the data. Only the Java ORC writer may use values under 6 (or missing) so that readers that predate ORC-202 treat the new writers correctly. Each writer should assign their own sequence of versions starting from 6. Version of the ORC Java writer: 0 = original 1 = HIVE-8732 fixed (fixed stripe/file maximum statistics & string statistics use utf8 for min/max) 2 = HIVE-4243 fixed (use real column names from Hive tables) 3 = HIVE-12055 added (vectorized writer implementation) 4 = HIVE-13083 fixed (decimals write present stream correctly) 5 = ORC-101 fixed (bloom filters use utf8 consistently) 6 = ORC-135 fixed (timestamp statistics use utc) 7 = ORC-517 fixed (decimal64 min/max incorrect) 8 = ORC-203 added (trim very long string statistics) 9 = ORC-14 added (column encryption) Version of the ORC C++ writer: 6 = original Version of the Presto writer: 6 = original Version of the Scritchley Go writer: 6 = original Version of the Trino writer: 6 = original

• optional uint64 stripeStatisticsLength = 7

  the number of bytes in the encrypted stripe statistics

• optional string magic = 8000

  Leave this last in the record

• repeated RowIndexEntry entry = 1

Used in: RowIndex

• repeated uint64 positions = 1

• optional ColumnStatistics statistics = 2

Used in: EncryptionVariant, StripeEncryptionVariant, StripeFooter

• optional Stream.Kind kind = 1

• optional uint32 column = 2

• optional uint64 length = 3

if you add new index stream kinds, you need to make sure to update StreamName to ensure it is added to the stripe in the right area

Used in: Stream

• PRESENT = 0

• DATA = 1

• LENGTH = 2

• DICTIONARY_DATA = 3

• DICTIONARY_COUNT = 4

• SECONDARY = 5

• ROW_INDEX = 6

• BLOOM_FILTER = 7

• BLOOM_FILTER_UTF8 = 8

• ENCRYPTED_INDEX = 9

  Virtual stream kinds to allocate space for encrypted index and data.

• ENCRYPTED_DATA = 10

• BITMAP_INDEX = 11

• STRIPE_STATISTICS = 100

  stripe statistics streams

• FILE_STATISTICS = 101

  A virtual stream kind that is used for setting the encryption IV.

Used in: Type

• optional string key = 1

• optional string value = 2

Used in: ColumnStatistics

• optional string minimum = 1

• optional string maximum = 2

• optional sint64 sum = 3

  sum will store the total length of all strings in a stripe

• optional string lowerBound = 4

  If the minimum or maximum value was longer than 1024 bytes, store a lower or upper bound instead of the minimum or maximum values above.

• optional string upperBound = 5

• optional string first = 6

• optional string latest = 7

• optional string firstBound = 8

  If the first or latest value was longer than 1024 bytes, store a lower or upper bound instead of the first or latest values above.

• optional string latestBound = 9

Used in: StripeFooter

• repeated Stream streams = 1

• repeated ColumnEncoding encoding = 2

• repeated Stream streams = 1

• repeated ColumnEncoding columns = 2

• optional string writerTimezone = 3

• repeated StripeEncryptionVariant encryption = 4

  one for each column encryption variant

Used in: Footer

• optional uint64 offset = 1

  the global file offset of the start of the stripe

• optional uint64 indexLength = 2

  the number of bytes of index

• optional uint64 dataLength = 3

  the number of bytes of data

• optional uint64 footerLength = 4

  the number of bytes in the stripe footer

• optional uint64 numberOfRows = 5

  the number of rows in this stripe

• optional uint64 encryptStripeId = 6

  If this is present, the reader should use this value for the encryption stripe id for setting the encryption IV. Otherwise, the reader should use one larger than the previous stripe's encryptStripeId. For unmerged ORC files, the first stripe will use 1 and the rest of the stripes won't have it set. For merged files, the stripe information will be copied from their original files and thus the first stripe of each of the input files will reset it to 1. Note that 1 was choosen, because protobuf v3 doesn't serialize primitive types that are the default (eg. 0).

• repeated bytes encryptedLocalKeys = 7

  For each encryption variant, the new encrypted local key to use until we find a replacement.

StripeStatistics (1 per a stripe), which each contain the ColumnStatistics for each column. This message type is only used in ORC v0 and v1.

Used in: Metadata

• repeated ColumnStatistics colStats = 1

Used in: ColumnStatistics

• optional sint64 minimum = 1

  min,max values saved as milliseconds since epoch

• optional sint64 maximum = 2

• optional sint64 minimumUtc = 3

• optional sint64 maximumUtc = 4

• optional int32 minimumNanos = 5

  store the lower 6 TS digits for min/max to achieve nanosecond precision

• optional int32 maximumNanos = 6

Used in: Footer

• optional Type.Kind kind = 1

• repeated uint32 subtypes = 2

• repeated string fieldNames = 3

• optional uint32 maximumLength = 4

• optional uint32 precision = 5

• optional uint32 scale = 6

• repeated StringPair attributes = 7

Used in: Type

• BOOLEAN = 0

• BYTE = 1

• SHORT = 2

• INT = 3

• LONG = 4

• FLOAT = 5

• DOUBLE = 6

• STRING = 7

• BINARY = 8

• TIMESTAMP = 9

• LIST = 10

• MAP = 11

• STRUCT = 12

• UNION = 13

• DECIMAL = 14

• DATE = 15

• VARCHAR = 16

• CHAR = 17

• TIMESTAMP_INSTANT = 18

Used in: Footer

• optional string name = 1

• optional bytes value = 2