-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
types.go
391 lines (339 loc) · 12.3 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package parquet
import (
"encoding/binary"
"io"
"reflect"
"strings"
"time"
"unsafe"
"github.com/apache/arrow/go/v12/arrow"
format "github.com/apache/arrow/go/v12/parquet/internal/gen-go/parquet"
)
const (
julianUnixEpoch int64 = 2440588
nanosPerDay int64 = 3600 * 24 * 1000 * 1000 * 1000
// Int96SizeBytes is the number of bytes that make up an Int96
Int96SizeBytes int = 12
)
var (
// Int96Traits provides information about the Int96 type
Int96Traits int96Traits
// ByteArrayTraits provides information about the ByteArray type, which is just an []byte
ByteArrayTraits byteArrayTraits
// FixedLenByteArrayTraits provides information about the FixedLenByteArray type which is just an []byte
FixedLenByteArrayTraits fixedLenByteArrayTraits
// ByteArraySizeBytes is the number of bytes returned by reflect.TypeOf(ByteArray{}).Size()
ByteArraySizeBytes int = int(reflect.TypeOf(ByteArray{}).Size())
// FixedLenByteArraySizeBytes is the number of bytes returned by reflect.TypeOf(FixedLenByteArray{}).Size()
FixedLenByteArraySizeBytes int = int(reflect.TypeOf(FixedLenByteArray{}).Size())
)
// ReaderAtSeeker is a combination of the ReaderAt and ReadSeeker interfaces
// from the io package defining the only functionality that is required
// in order for a parquet file to be read by the file functions. We just need
// to be able to call ReadAt, Read, and Seek
type ReaderAtSeeker interface {
io.ReaderAt
io.Seeker
}
// NewInt96 creates a new Int96 from the given 3 uint32 values.
func NewInt96(v [3]uint32) (out Int96) {
binary.LittleEndian.PutUint32(out[0:], v[0])
binary.LittleEndian.PutUint32(out[4:], v[1])
binary.LittleEndian.PutUint32(out[8:], v[2])
return
}
// Int96 is a 12 byte integer value utilized for representing timestamps as a 64 bit integer and a 32 bit
// integer.
type Int96 [12]byte
// SetNanoSeconds sets the Nanosecond field of the Int96 timestamp to the provided value
func (i96 *Int96) SetNanoSeconds(nanos int64) {
binary.LittleEndian.PutUint64(i96[:8], uint64(nanos))
}
// String provides the string representation as a timestamp via converting to a time.Time
// and then calling String
func (i96 Int96) String() string {
return i96.ToTime().String()
}
// ToTime returns a go time.Time object that represents the same time instant as the given Int96 value
func (i96 Int96) ToTime() time.Time {
nanos := binary.LittleEndian.Uint64(i96[:8])
jdays := binary.LittleEndian.Uint32(i96[8:])
nanos = (uint64(jdays)-uint64(julianUnixEpoch))*uint64(nanosPerDay) + nanos
t := time.Unix(0, int64(nanos))
return t.UTC()
}
type int96Traits struct{}
func (int96Traits) BytesRequired(n int) int { return Int96SizeBytes * n }
func (int96Traits) CastFromBytes(b []byte) []Int96 {
h := (*reflect.SliceHeader)(unsafe.Pointer(&b))
var res []Int96
s := (*reflect.SliceHeader)(unsafe.Pointer(&res))
s.Data = h.Data
s.Len = h.Len / Int96SizeBytes
s.Cap = h.Cap / Int96SizeBytes
return res
}
func (int96Traits) CastToBytes(b []Int96) []byte {
h := (*reflect.SliceHeader)(unsafe.Pointer(&b))
var res []byte
s := (*reflect.SliceHeader)(unsafe.Pointer(&res))
s.Data = h.Data
s.Len = h.Len * Int96SizeBytes
s.Cap = h.Cap * Int96SizeBytes
return res
}
// ByteArray is a type to be utilized for representing the Parquet ByteArray physical type, represented as a byte slice
type ByteArray []byte
// Len returns the current length of the ByteArray, equivalent to len(bytearray)
func (b ByteArray) Len() int {
return len(b)
}
// String returns a string representation of the ByteArray
func (b ByteArray) String() string {
return *(*string)(unsafe.Pointer(&b))
}
type byteArrayTraits struct{}
func (byteArrayTraits) BytesRequired(n int) int {
return ByteArraySizeBytes * n
}
func (byteArrayTraits) CastFromBytes(b []byte) []ByteArray {
h := (*reflect.SliceHeader)(unsafe.Pointer(&b))
var res []ByteArray
s := (*reflect.SliceHeader)(unsafe.Pointer(&res))
s.Data = h.Data
s.Len = h.Len / ByteArraySizeBytes
s.Cap = h.Cap / ByteArraySizeBytes
return res
}
// FixedLenByteArray is a go type to represent a FixedLengthByteArray as a byte slice
type FixedLenByteArray []byte
// Len returns the current length of this FixedLengthByteArray, equivalent to len(fixedlenbytearray)
func (b FixedLenByteArray) Len() int {
return len(b)
}
// String returns a string representation of the FixedLenByteArray
func (b FixedLenByteArray) String() string {
return *(*string)(unsafe.Pointer(&b))
}
type fixedLenByteArrayTraits struct{}
func (fixedLenByteArrayTraits) BytesRequired(n int) int {
return FixedLenByteArraySizeBytes * n
}
func (fixedLenByteArrayTraits) CastFromBytes(b []byte) []FixedLenByteArray {
h := (*reflect.SliceHeader)(unsafe.Pointer(&b))
var res []FixedLenByteArray
s := (*reflect.SliceHeader)(unsafe.Pointer(&res))
s.Data = h.Data
s.Len = h.Len / FixedLenByteArraySizeBytes
s.Cap = h.Cap / FixedLenByteArraySizeBytes
return res
}
// Creating our own enums allows avoiding the transitive dependency on the
// compiled thrift definitions in the public API, allowing us to not export
// the entire Thrift definitions, while making everything a simple cast between.
//
// It also let's us add special values like NONE to distinguish between values
// that are set or not set
type (
// Type is the physical type as in parquet.thrift
Type format.Type
// Cipher is the parquet Cipher Algorithms
Cipher int
// ColumnOrder is the Column Order from the parquet.thrift
ColumnOrder *format.ColumnOrder
// Version is the parquet version type
Version int8
// DataPageVersion is the version of the Parquet Data Pages
DataPageVersion int8
// Encoding is the parquet Encoding type
Encoding format.Encoding
// Repetition is the underlying parquet field repetition type as in parquet.thrift
Repetition format.FieldRepetitionType
// ColumnPath is the path from the root of the schema to a given column
ColumnPath []string
)
func (c ColumnPath) String() string {
if c == nil {
return ""
}
return strings.Join(c, ".")
}
// Extend creates a new ColumnPath from an existing one, with the new ColumnPath having s appended to the end.
func (c ColumnPath) Extend(s string) ColumnPath {
p := make([]string, len(c), len(c)+1)
copy(p, c)
return append(p, s)
}
// ColumnPathFromString constructs a ColumnPath from a dot separated string
func ColumnPathFromString(s string) ColumnPath {
return strings.Split(s, ".")
}
// constants for choosing the Aes Algorithm to use for encryption/decryption
const (
AesGcm Cipher = iota
AesCtr
)
// Constants for the parquet Version which governs which data types are allowed
// and how they are represented. For example, uint32 data will be written differently
// depending on this value (as INT64 for V1_0, as UINT32 for other versions).
//
// However, some features - such as compression algorithms, encryption,
// or the improved v2 data page format must be enabled separately in writer
// properties.
const (
// Enable only pre-2.2 parquet format features when writing.
//
// This is useful for maximum compatibility with legacy readers.
// Note that logical types may still be emitted, as long as they have
// a corresponding converted type.
V1_0 Version = iota // v1.0
// Enable parquet format 2.4 and earlier features when writing.
//
// This enables uint32 as well as logical types which don't have a
// corresponding converted type.
//
// Note: Parquet format 2.4.0 was released in October 2017
V2_4 // v2.4
// Enable Parquet format 2.6 and earlier features when writing.
//
// This enables the nanos time unit in addition to the V2_4 features.
//
// Note: Parquet format 2.6.0 was released in September 2018
V2_6 // v2.6
// Enable the latest parquet format 2.x features.
//
// This is equal to the greatest 2.x version supported by this library.
V2_LATEST = V2_6
)
// constants for the parquet DataPage Version to use
const (
DataPageV1 DataPageVersion = iota
DataPageV2
)
func (e Encoding) String() string {
return format.Encoding(e).String()
}
var (
// Types contains constants for the Physical Types that are used in the Parquet Spec
//
// They can be specified when needed as such: `parquet.Types.Int32` etc. The values
// all correspond to the values in parquet.thrift
Types = struct {
Boolean Type
Int32 Type
Int64 Type
Int96 Type
Float Type
Double Type
ByteArray Type
FixedLenByteArray Type
// this only exists as a convienence so we can denote it when necessary
// nearly all functions that take a parquet.Type will error/panic if given
// Undefined
Undefined Type
}{
Boolean: Type(format.Type_BOOLEAN),
Int32: Type(format.Type_INT32),
Int64: Type(format.Type_INT64),
Int96: Type(format.Type_INT96),
Float: Type(format.Type_FLOAT),
Double: Type(format.Type_DOUBLE),
ByteArray: Type(format.Type_BYTE_ARRAY),
FixedLenByteArray: Type(format.Type_FIXED_LEN_BYTE_ARRAY),
Undefined: Type(format.Type_FIXED_LEN_BYTE_ARRAY + 1),
}
// Encodings contains constants for the encoding types of the column data
//
// The values used all correspond to the values in parquet.thrift for the
// corresponding encoding type.
Encodings = struct {
Plain Encoding
PlainDict Encoding
RLE Encoding
RLEDict Encoding
BitPacked Encoding // deprecated, not implemented
DeltaByteArray Encoding
DeltaBinaryPacked Encoding
DeltaLengthByteArray Encoding
}{
Plain: Encoding(format.Encoding_PLAIN),
PlainDict: Encoding(format.Encoding_PLAIN_DICTIONARY),
RLE: Encoding(format.Encoding_RLE),
RLEDict: Encoding(format.Encoding_RLE_DICTIONARY),
BitPacked: Encoding(format.Encoding_BIT_PACKED),
DeltaByteArray: Encoding(format.Encoding_DELTA_BYTE_ARRAY),
DeltaBinaryPacked: Encoding(format.Encoding_DELTA_BINARY_PACKED),
DeltaLengthByteArray: Encoding(format.Encoding_DELTA_LENGTH_BYTE_ARRAY),
}
// ColumnOrders contains constants for the Column Ordering fields
ColumnOrders = struct {
Undefined ColumnOrder
TypeDefinedOrder ColumnOrder
}{
Undefined: format.NewColumnOrder(),
TypeDefinedOrder: &format.ColumnOrder{TYPE_ORDER: format.NewTypeDefinedOrder()},
}
// DefaultColumnOrder is to use TypeDefinedOrder
DefaultColumnOrder = ColumnOrders.TypeDefinedOrder
// Repetitions contains the constants for Field Repetition Types
Repetitions = struct {
Required Repetition
Optional Repetition
Repeated Repetition
Undefined Repetition // convenience value
}{
Required: Repetition(format.FieldRepetitionType_REQUIRED),
Optional: Repetition(format.FieldRepetitionType_OPTIONAL),
Repeated: Repetition(format.FieldRepetitionType_REPEATED),
Undefined: Repetition(format.FieldRepetitionType_REPEATED + 1),
}
)
func (t Type) String() string {
switch t {
case Types.Undefined:
return "UNDEFINED"
default:
return format.Type(t).String()
}
}
func (r Repetition) String() string {
return strings.ToLower(format.FieldRepetitionType(r).String())
}
// ByteSize returns the number of bytes required to store a single value of
// the given parquet.Type in memory.
func (t Type) ByteSize() int {
switch t {
case Types.Boolean:
return 1
case Types.Int32:
return arrow.Int32SizeBytes
case Types.Int64:
return arrow.Int64SizeBytes
case Types.Int96:
return Int96SizeBytes
case Types.Float:
return arrow.Float32SizeBytes
case Types.Double:
return arrow.Float64SizeBytes
case Types.ByteArray:
return ByteArraySizeBytes
case Types.FixedLenByteArray:
return FixedLenByteArraySizeBytes
}
panic("no bytesize info for type")
}