io.trino.orc.reader.TimestampColumnReader Maven / Gradle / Ivy
/*
* Licensed 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 io.trino.orc.reader;
import io.trino.memory.context.LocalMemoryContext;
import io.trino.orc.OrcColumn;
import io.trino.orc.OrcCorruptionException;
import io.trino.orc.metadata.ColumnEncoding;
import io.trino.orc.metadata.ColumnMetadata;
import io.trino.orc.metadata.OrcType.OrcTypeKind;
import io.trino.orc.stream.BooleanInputStream;
import io.trino.orc.stream.InputStreamSource;
import io.trino.orc.stream.InputStreamSources;
import io.trino.orc.stream.LongInputStream;
import io.trino.spi.block.Block;
import io.trino.spi.block.Fixed12Block;
import io.trino.spi.block.LongArrayBlock;
import io.trino.spi.block.RunLengthEncodedBlock;
import io.trino.spi.type.TimeZoneKey;
import io.trino.spi.type.Type;
import jakarta.annotation.Nullable;
import org.joda.time.DateTimeZone;
import java.io.IOException;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.time.ZoneOffset;
import java.time.ZonedDateTime;
import java.util.Optional;
import static com.google.common.base.MoreObjects.toStringHelper;
import static io.airlift.slice.SizeOf.instanceSize;
import static io.trino.orc.metadata.Stream.StreamKind.DATA;
import static io.trino.orc.metadata.Stream.StreamKind.PRESENT;
import static io.trino.orc.metadata.Stream.StreamKind.SECONDARY;
import static io.trino.orc.reader.ReaderUtils.invalidStreamType;
import static io.trino.orc.stream.MissingInputStreamSource.missingStreamSource;
import static io.trino.spi.block.Fixed12Block.encodeFixed12;
import static io.trino.spi.type.DateTimeEncoding.packDateTimeWithZone;
import static io.trino.spi.type.TimestampType.TIMESTAMP_MICROS;
import static io.trino.spi.type.TimestampType.TIMESTAMP_MILLIS;
import static io.trino.spi.type.TimestampType.TIMESTAMP_NANOS;
import static io.trino.spi.type.TimestampWithTimeZoneType.TIMESTAMP_TZ_MICROS;
import static io.trino.spi.type.TimestampWithTimeZoneType.TIMESTAMP_TZ_MILLIS;
import static io.trino.spi.type.TimestampWithTimeZoneType.TIMESTAMP_TZ_NANOS;
import static io.trino.spi.type.Timestamps.MICROSECONDS_PER_MILLISECOND;
import static io.trino.spi.type.Timestamps.MICROSECONDS_PER_SECOND;
import static io.trino.spi.type.Timestamps.NANOSECONDS_PER_MICROSECOND;
import static io.trino.spi.type.Timestamps.NANOSECONDS_PER_MILLISECOND;
import static io.trino.spi.type.Timestamps.PICOSECONDS_PER_MICROSECOND;
import static io.trino.spi.type.Timestamps.PICOSECONDS_PER_MILLISECOND;
import static io.trino.spi.type.Timestamps.PICOSECONDS_PER_NANOSECOND;
import static io.trino.spi.type.Timestamps.roundDiv;
import static java.lang.Math.floorDiv;
import static java.lang.Math.floorMod;
import static java.lang.Math.toIntExact;
import static java.util.Objects.requireNonNull;
import static org.joda.time.DateTimeConstants.MILLIS_PER_SECOND;
// see ORC encoding notes in TimestampColumnWriter
public class TimestampColumnReader
implements ColumnReader
{
private enum TimestampKind
{
TIMESTAMP_MILLIS,
TIMESTAMP_MICROS,
TIMESTAMP_NANOS,
INSTANT_MILLIS,
INSTANT_MICROS,
INSTANT_NANOS,
}
private static final int[] POWERS_OF_TEN = {
1,
10,
100,
1_000,
10_000,
100_000,
1_000_000,
10_000_000,
100_000_000,
};
private static final LocalDateTime ORC_EPOCH = LocalDateTime.of(2015, 1, 1, 0, 0, 0, 0);
private static final long BASE_INSTANT_IN_SECONDS = ORC_EPOCH.toEpochSecond(ZoneOffset.UTC);
private static final int INSTANCE_SIZE = instanceSize(TimestampColumnReader.class);
private final Type type;
private final OrcColumn column;
private final TimestampKind timestampKind;
private long baseTimestampInSeconds;
private DateTimeZone fileDateTimeZone;
private int readOffset;
private int nextBatchSize;
private InputStreamSource presentStreamSource = missingStreamSource(BooleanInputStream.class);
@Nullable
private BooleanInputStream presentStream;
private InputStreamSource secondsStreamSource = missingStreamSource(LongInputStream.class);
@Nullable
private LongInputStream secondsStream;
private InputStreamSource nanosStreamSource = missingStreamSource(LongInputStream.class);
@Nullable
private LongInputStream nanosStream;
private boolean rowGroupOpen;
private final LocalMemoryContext memoryContext;
public TimestampColumnReader(Type type, OrcColumn column, LocalMemoryContext memoryContext)
throws OrcCorruptionException
{
this.type = requireNonNull(type, "type is null");
this.column = requireNonNull(column, "column is null");
this.timestampKind = getTimestampKind(type, column);
this.memoryContext = requireNonNull(memoryContext, "memoryContext is null");
}
private static TimestampKind getTimestampKind(Type type, OrcColumn column)
throws OrcCorruptionException
{
OrcTypeKind orcTypeKind = column.getColumnType().getOrcTypeKind();
if (type.equals(TIMESTAMP_MILLIS) && (orcTypeKind == OrcTypeKind.TIMESTAMP)) {
return TimestampKind.TIMESTAMP_MILLIS;
}
if (type.equals(TIMESTAMP_MICROS) && (orcTypeKind == OrcTypeKind.TIMESTAMP)) {
return TimestampKind.TIMESTAMP_MICROS;
}
if (type.equals(TIMESTAMP_NANOS) && (orcTypeKind == OrcTypeKind.TIMESTAMP)) {
return TimestampKind.TIMESTAMP_NANOS;
}
if (type.equals(TIMESTAMP_TZ_MILLIS) && (orcTypeKind == OrcTypeKind.TIMESTAMP_INSTANT)) {
return TimestampKind.INSTANT_MILLIS;
}
if (type.equals(TIMESTAMP_TZ_MICROS) && (orcTypeKind == OrcTypeKind.TIMESTAMP_INSTANT)) {
return TimestampKind.INSTANT_MICROS;
}
if (type.equals(TIMESTAMP_TZ_NANOS) && (orcTypeKind == OrcTypeKind.TIMESTAMP_INSTANT)) {
return TimestampKind.INSTANT_NANOS;
}
throw invalidStreamType(column, type);
}
@Override
public void prepareNextRead(int batchSize)
{
readOffset += nextBatchSize;
nextBatchSize = batchSize;
}
@Override
public Block readBlock()
throws IOException
{
if (!rowGroupOpen) {
openRowGroup();
}
if (readOffset > 0) {
if (presentStream != null) {
// skip ahead the present bit reader, but count the set bits
// and use this as the skip size for the data reader
readOffset = presentStream.countBitsSet(readOffset);
}
if (readOffset > 0) {
verifyStreamsPresent();
secondsStream.skip(readOffset);
nanosStream.skip(readOffset);
}
}
Block block;
if (secondsStream == null && nanosStream == null) {
if (presentStream == null) {
throw new OrcCorruptionException(column.getOrcDataSourceId(), "Value is null but present stream is missing");
}
presentStream.skip(nextBatchSize);
block = RunLengthEncodedBlock.create(type, null, nextBatchSize);
}
else if (presentStream == null) {
block = readNonNullBlock();
}
else {
boolean[] isNull = new boolean[nextBatchSize];
int nullCount = presentStream.getUnsetBits(nextBatchSize, isNull);
if (nullCount == 0) {
block = readNonNullBlock();
}
else if (nullCount != nextBatchSize) {
block = readNullBlock(isNull);
}
else {
block = RunLengthEncodedBlock.create(type, null, nextBatchSize);
}
}
readOffset = 0;
nextBatchSize = 0;
return block;
}
private void verifyStreamsPresent()
throws OrcCorruptionException
{
if (secondsStream == null) {
throw new OrcCorruptionException(column.getOrcDataSourceId(), "Value is not null but seconds stream is missing");
}
if (nanosStream == null) {
throw new OrcCorruptionException(column.getOrcDataSourceId(), "Value is not null but nanos stream is missing");
}
}
private Block readNonNullBlock()
throws IOException
{
verifyStreamsPresent();
return switch (timestampKind) {
case TIMESTAMP_MILLIS -> readNonNullTimestampMillis();
case TIMESTAMP_MICROS -> readNonNullTimestampMicros();
case TIMESTAMP_NANOS -> readNonNullTimestampNanos();
case INSTANT_MILLIS -> readNonNullInstantMillis();
case INSTANT_MICROS -> readNonNullInstantMicros();
case INSTANT_NANOS -> readNonNullInstantNanos();
};
}
private Block readNullBlock(boolean[] isNull)
throws IOException
{
verifyStreamsPresent();
return switch (timestampKind) {
case TIMESTAMP_MILLIS -> readNullTimestampMillis(isNull);
case TIMESTAMP_MICROS -> readNullTimestampMicros(isNull);
case TIMESTAMP_NANOS -> readNullTimestampNanos(isNull);
case INSTANT_MILLIS -> readNullInstantMillis(isNull);
case INSTANT_MICROS -> readNullInstantMicros(isNull);
case INSTANT_NANOS -> readNullInstantNanos(isNull);
};
}
private void openRowGroup()
throws IOException
{
presentStream = presentStreamSource.openStream();
secondsStream = secondsStreamSource.openStream();
nanosStream = nanosStreamSource.openStream();
rowGroupOpen = true;
}
@Override
public void startStripe(ZoneId fileTimeZone, InputStreamSources dictionaryStreamSources, ColumnMetadata encoding)
{
baseTimestampInSeconds = ZonedDateTime.ofLocal(ORC_EPOCH, fileTimeZone, null).toEpochSecond();
fileDateTimeZone = DateTimeZone.forID(fileTimeZone.getId());
presentStreamSource = missingStreamSource(BooleanInputStream.class);
secondsStreamSource = missingStreamSource(LongInputStream.class);
nanosStreamSource = missingStreamSource(LongInputStream.class);
readOffset = 0;
nextBatchSize = 0;
presentStream = null;
secondsStream = null;
nanosStream = null;
rowGroupOpen = false;
}
@Override
public void startRowGroup(InputStreamSources dataStreamSources)
{
presentStreamSource = dataStreamSources.getInputStreamSource(column, PRESENT, BooleanInputStream.class);
secondsStreamSource = dataStreamSources.getInputStreamSource(column, DATA, LongInputStream.class);
nanosStreamSource = dataStreamSources.getInputStreamSource(column, SECONDARY, LongInputStream.class);
readOffset = 0;
nextBatchSize = 0;
presentStream = null;
secondsStream = null;
nanosStream = null;
rowGroupOpen = false;
}
@Override
public String toString()
{
return toStringHelper(this)
.addValue(column)
.toString();
}
@Override
public void close()
{
memoryContext.close();
}
@Override
public long getRetainedSizeInBytes()
{
return INSTANCE_SIZE;
}
@SuppressWarnings("ObjectEquality")
private boolean isFileUtc()
{
return fileDateTimeZone == DateTimeZone.UTC;
}
private int decodeNanos(long serialized)
throws IOException
{
// the last three bits encode the leading zeros removed minus one
int zeros = (int) (serialized & 0b111);
int nanos = (int) (serialized >>> 3);
if (zeros > 0) {
nanos *= POWERS_OF_TEN[zeros + 1];
}
if ((nanos < 0) || (nanos > 999_999_999)) {
throw new OrcCorruptionException(column.getOrcDataSourceId(), "Nanos field of timestamp is out of range: %s", nanos);
}
return nanos;
}
// TIMESTAMP MILLIS
private Block readNonNullTimestampMillis()
throws IOException
{
long[] millis = new long[nextBatchSize];
for (int i = 0; i < nextBatchSize; i++) {
millis[i] = readTimestampMillis();
}
return new LongArrayBlock(nextBatchSize, Optional.empty(), millis);
}
private Block readNullTimestampMillis(boolean[] isNull)
throws IOException
{
long[] millis = new long[isNull.length];
for (int i = 0; i < isNull.length; i++) {
if (!isNull[i]) {
millis[i] = readTimestampMillis();
}
}
return new LongArrayBlock(isNull.length, Optional.of(isNull), millis);
}
private long readTimestampMillis()
throws IOException
{
long seconds = secondsStream.next();
long serializedNanos = nanosStream.next();
long millis = (seconds + baseTimestampInSeconds) * MILLIS_PER_SECOND;
long nanos = decodeNanos(serializedNanos);
if (nanos != 0) {
// adjust for bad ORC rounding logic
if (millis < 0) {
millis -= MILLIS_PER_SECOND;
}
millis += roundDiv(nanos, NANOSECONDS_PER_MILLISECOND);
}
if (!isFileUtc()) {
millis = fileDateTimeZone.convertUTCToLocal(millis);
}
return millis * MICROSECONDS_PER_MILLISECOND;
}
// TIMESTAMP MICROS
private Block readNonNullTimestampMicros()
throws IOException
{
long[] micros = new long[nextBatchSize];
for (int i = 0; i < nextBatchSize; i++) {
micros[i] = readTimestampMicros();
}
return new LongArrayBlock(nextBatchSize, Optional.empty(), micros);
}
private Block readNullTimestampMicros(boolean[] isNull)
throws IOException
{
long[] micros = new long[nextBatchSize];
for (int i = 0; i < nextBatchSize; i++) {
if (!isNull[i]) {
micros[i] = readTimestampMicros();
}
}
return new LongArrayBlock(nextBatchSize, Optional.of(isNull), micros);
}
private long readTimestampMicros()
throws IOException
{
long seconds = secondsStream.next();
long serializedNanos = nanosStream.next();
long micros = (seconds + baseTimestampInSeconds) * MICROSECONDS_PER_SECOND;
long nanos = decodeNanos(serializedNanos);
if (nanos != 0) {
// adjust for bad ORC rounding logic
if (micros < 0) {
micros -= MICROSECONDS_PER_SECOND;
}
micros += roundDiv(nanos, NANOSECONDS_PER_MICROSECOND);
}
if (!isFileUtc()) {
long millis = floorDiv(micros, MICROSECONDS_PER_MILLISECOND);
int microsFraction = floorMod(micros, MICROSECONDS_PER_MILLISECOND);
millis = fileDateTimeZone.convertUTCToLocal(millis);
micros = (millis * MICROSECONDS_PER_MILLISECOND) + microsFraction;
}
return micros;
}
// TIMESTAMP NANOS
private Block readNonNullTimestampNanos()
throws IOException
{
int[] values = new int[nextBatchSize * 3];
for (int i = 0; i < nextBatchSize; i++) {
readTimestampNanos(i, values);
}
return new Fixed12Block(nextBatchSize, Optional.empty(), values);
}
private Block readNullTimestampNanos(boolean[] isNull)
throws IOException
{
int[] values = new int[nextBatchSize * 3];
for (int i = 0; i < nextBatchSize; i++) {
if (!isNull[i]) {
readTimestampNanos(i, values);
}
}
return new Fixed12Block(nextBatchSize, Optional.of(isNull), values);
}
private void readTimestampNanos(int i, int[] values)
throws IOException
{
long seconds = secondsStream.next();
long serializedNanos = nanosStream.next();
long micros = (seconds + baseTimestampInSeconds) * MICROSECONDS_PER_SECOND;
long nanos = decodeNanos(serializedNanos);
int picosFraction = 0;
if (nanos != 0) {
// adjust for bad ORC rounding logic
if (micros < 0) {
micros -= MICROSECONDS_PER_SECOND;
}
// move micros part out of nanos
micros += nanos / NANOSECONDS_PER_MICROSECOND;
nanos %= NANOSECONDS_PER_MICROSECOND;
picosFraction = toIntExact(nanos * PICOSECONDS_PER_NANOSECOND);
}
if (!isFileUtc()) {
long millis = floorDiv(micros, MICROSECONDS_PER_MILLISECOND);
int microsFraction = floorMod(micros, MICROSECONDS_PER_MILLISECOND);
millis = fileDateTimeZone.convertUTCToLocal(millis);
micros = (millis * MICROSECONDS_PER_MILLISECOND) + microsFraction;
}
encodeFixed12(micros, picosFraction, values, i);
}
// INSTANT MILLIS
private Block readNonNullInstantMillis()
throws IOException
{
long[] millis = new long[nextBatchSize];
for (int i = 0; i < nextBatchSize; i++) {
millis[i] = readInstantMillis();
}
return new LongArrayBlock(nextBatchSize, Optional.empty(), millis);
}
private Block readNullInstantMillis(boolean[] isNull)
throws IOException
{
long[] millis = new long[nextBatchSize];
for (int i = 0; i < nextBatchSize; i++) {
if (!isNull[i]) {
millis[i] = readInstantMillis();
}
}
return new LongArrayBlock(nextBatchSize, Optional.of(isNull), millis);
}
private long readInstantMillis()
throws IOException
{
long seconds = secondsStream.next();
long serializedNanos = nanosStream.next();
long millis = (seconds + BASE_INSTANT_IN_SECONDS) * MILLIS_PER_SECOND;
long nanos = decodeNanos(serializedNanos);
if (nanos != 0) {
// adjust for bad ORC rounding logic
if (millis < 0) {
millis -= MILLIS_PER_SECOND;
}
millis += roundDiv(nanos, NANOSECONDS_PER_MILLISECOND);
}
return packDateTimeWithZone(millis, TimeZoneKey.UTC_KEY);
}
// INSTANT MICROS
private Block readNonNullInstantMicros()
throws IOException
{
int[] values = new int[nextBatchSize * 3];
for (int i = 0; i < nextBatchSize; i++) {
readInstantMicros(i, values);
}
return new Fixed12Block(nextBatchSize, Optional.empty(), values);
}
private Block readNullInstantMicros(boolean[] isNull)
throws IOException
{
int[] values = new int[nextBatchSize * 3];
for (int i = 0; i < nextBatchSize; i++) {
if (!isNull[i]) {
readInstantMicros(i, values);
}
}
return new Fixed12Block(nextBatchSize, Optional.of(isNull), values);
}
private void readInstantMicros(int i, int[] values)
throws IOException
{
long seconds = secondsStream.next();
long serializedNanos = nanosStream.next();
long millis = (seconds + BASE_INSTANT_IN_SECONDS) * MILLIS_PER_SECOND;
long nanos = decodeNanos(serializedNanos);
int picosFraction = 0;
if (nanos != 0) {
// adjust for bad ORC rounding logic
if (millis < 0) {
millis -= MILLIS_PER_SECOND;
}
// move millis part out of nanos
millis += nanos / NANOSECONDS_PER_MILLISECOND;
nanos %= NANOSECONDS_PER_MILLISECOND;
// round nanos to micros and convert to picos
picosFraction = toIntExact(roundDiv(nanos, NANOSECONDS_PER_MICROSECOND)) * PICOSECONDS_PER_MICROSECOND;
if (picosFraction == PICOSECONDS_PER_MILLISECOND) {
picosFraction = 0;
millis++;
}
}
encodeFixed12(packDateTimeWithZone(millis, TimeZoneKey.UTC_KEY), picosFraction, values, i);
}
// INSTANT NANOS
private Block readNonNullInstantNanos()
throws IOException
{
int[] values = new int[nextBatchSize * 3];
for (int i = 0; i < nextBatchSize; i++) {
readInstantNanos(i, values);
}
return new Fixed12Block(nextBatchSize, Optional.empty(), values);
}
private Block readNullInstantNanos(boolean[] isNull)
throws IOException
{
int[] values = new int[nextBatchSize * 3];
for (int i = 0; i < nextBatchSize; i++) {
if (!isNull[i]) {
readInstantNanos(i, values);
}
}
return new Fixed12Block(nextBatchSize, Optional.of(isNull), values);
}
private void readInstantNanos(int i, int[] values)
throws IOException
{
long seconds = secondsStream.next();
long serializedNanos = nanosStream.next();
long millis = (seconds + BASE_INSTANT_IN_SECONDS) * MILLIS_PER_SECOND;
long nanos = decodeNanos(serializedNanos);
int picosFraction = 0;
if (nanos != 0) {
// adjust for bad ORC rounding logic
if (millis < 0) {
millis -= MILLIS_PER_SECOND;
}
// move millis part out of nanos
millis += nanos / NANOSECONDS_PER_MILLISECOND;
nanos %= NANOSECONDS_PER_MILLISECOND;
picosFraction = toIntExact(nanos * PICOSECONDS_PER_NANOSECOND);
}
encodeFixed12(packDateTimeWithZone(millis, TimeZoneKey.UTC_KEY), picosFraction, values, i);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy