summaryrefslogtreecommitdiff
path: root/opendc-trace/opendc-trace-parquet/src/main/kotlin/org/opendc/trace/util/parquet/LocalParquetReader.kt
blob: b503254e688bc2a56d3e8d206eee89b0a8c69981 (plain)
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
/*
 * Copyright (c) 2021 AtLarge Research
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.opendc.trace.util.parquet

import org.apache.parquet.hadoop.ParquetReader
import org.apache.parquet.hadoop.api.ReadSupport
import org.apache.parquet.io.InputFile
import java.io.File
import java.io.IOException
import java.nio.file.Files
import java.nio.file.Path
import kotlin.io.path.isDirectory

/**
 * A helper class to read Parquet files from the filesystem.
 *
 * This class wraps a [ParquetReader] in order to support reading partitioned Parquet datasets.
 *
 * @param path The path to the Parquet file or directory to read.
 * @param readSupport Helper class to perform conversion from Parquet to [T].
 * @param strictTyping A flag to disable strict typing of primitive types.
 */
public class LocalParquetReader<out T>(
    path: Path,
    private val readSupport: ReadSupport<T>,
    private val strictTyping: Boolean = true,
) : AutoCloseable {
    /**
     * The input files to process.
     */
    private val filesIterator =
        if (path.isDirectory()) {
            Files.list(path)
                .filter { !it.isDirectory() }
                .sorted()
                .map { LocalInputFile(it) }
                .iterator()
        } else {
            listOf(LocalInputFile(path)).iterator()
        }

    /**
     * The Parquet reader to use.
     */
    private var reader: ParquetReader<T>? = null

    /**
     * Construct a [LocalParquetReader] for the specified [file].
     */
    public constructor(file: File, readSupport: ReadSupport<T>) : this(file.toPath(), readSupport)

    /**
     * Read a single entry in the Parquet file.
     */
    public fun read(): T? {
        return try {
            val next = reader?.read()
            if (next != null) {
                next
            } else {
                initReader()

                if (reader == null) {
                    null
                } else {
                    read()
                }
            }
        } catch (e: InterruptedException) {
            throw IOException(e)
        }
    }

    /**
     * Close the Parquet reader.
     */
    override fun close() {
        reader?.close()
    }

    /**
     * Initialize the next reader.
     */
    private fun initReader() {
        reader?.close()

        try {
            this.reader =
                if (filesIterator.hasNext()) {
                    createReader(filesIterator.next())
                } else {
                    null
                }
        } catch (e: Throwable) {
            this.reader = null
            throw e
        }
    }

    /**
     * Construct a [ParquetReader] for the specified [input] with a custom [ReadSupport].
     */
    private fun createReader(input: InputFile): ParquetReader<T> {
        return object : ParquetReader.Builder<T>(input) {
            override fun getReadSupport(): ReadSupport<@UnsafeVariance T> = this@LocalParquetReader.readSupport
        }
            .set("parquet.strict.typing", strictTyping.toString())
            .build()
    }
}