Skip to content

PARQUET-2261: Implement SizeStatistics #1177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
/*
* 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 org.apache.parquet.column.impl;

import java.util.OptionalDouble;
import java.util.OptionalLong;
import org.apache.parquet.column.ColumnDescriptor;
import org.apache.parquet.column.ParquetProperties;
import org.apache.parquet.column.statistics.SizeStatistics;
import org.apache.parquet.column.statistics.Statistics;
import org.apache.parquet.column.values.bloomfilter.AdaptiveBlockSplitBloomFilter;
import org.apache.parquet.column.values.bloomfilter.BlockSplitBloomFilter;
import org.apache.parquet.column.values.bloomfilter.BloomFilter;
import org.apache.parquet.column.values.bloomfilter.BloomFilterWriter;
import org.apache.parquet.io.api.Binary;

// An internal class to collect column values to build column statistics and bloom filter.
class ColumnValueCollector {

private final ColumnDescriptor path;
private final BloomFilterWriter bloomFilterWriter;
private final BloomFilter bloomFilter;
private Statistics<?> statistics;
private SizeStatistics.Builder sizeStatisticsBuilder;

ColumnValueCollector(ColumnDescriptor path, BloomFilterWriter bloomFilterWriter, ParquetProperties props) {
this.path = path;
resetPageStatistics();

this.bloomFilterWriter = bloomFilterWriter;
if (bloomFilterWriter == null) {
this.bloomFilter = null;
return;
}
int maxBloomFilterSize = props.getMaxBloomFilterBytes();

OptionalLong ndv = props.getBloomFilterNDV(path);
OptionalDouble fpp = props.getBloomFilterFPP(path);
// If user specify the column NDV, we construct Bloom filter from it.
if (ndv.isPresent()) {
int optimalNumOfBits = BlockSplitBloomFilter.optimalNumOfBits(ndv.getAsLong(), fpp.getAsDouble());
this.bloomFilter = new BlockSplitBloomFilter(optimalNumOfBits / 8, maxBloomFilterSize);
} else {
if (props.getAdaptiveBloomFilterEnabled(path)) {
int numCandidates = props.getBloomFilterCandidatesCount(path);
this.bloomFilter =
new AdaptiveBlockSplitBloomFilter(maxBloomFilterSize, numCandidates, fpp.getAsDouble(), path);
} else {
this.bloomFilter = new BlockSplitBloomFilter(maxBloomFilterSize, maxBloomFilterSize);
}
}
}

void resetPageStatistics() {
this.statistics = Statistics.createStats(path.getPrimitiveType());
this.sizeStatisticsBuilder = SizeStatistics.newBuilder(
path.getPrimitiveType(), path.getMaxRepetitionLevel(), path.getMaxDefinitionLevel());
}

void writeNull(int repetitionLevel, int definitionLevel) {
statistics.incrementNumNulls();
sizeStatisticsBuilder.add(repetitionLevel, definitionLevel);
}

void write(boolean value, int repetitionLevel, int definitionLevel) {
statistics.updateStats(value);
sizeStatisticsBuilder.add(repetitionLevel, definitionLevel);
}

void write(int value, int repetitionLevel, int definitionLevel) {
statistics.updateStats(value);
sizeStatisticsBuilder.add(repetitionLevel, definitionLevel);
if (bloomFilter != null) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about using a no-op BloomFilter implementation instead of a null-check? I am not sure if would perform better, though.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. Could you please review it again?

bloomFilter.insertHash(bloomFilter.hash(value));
}
}

void write(long value, int repetitionLevel, int definitionLevel) {
statistics.updateStats(value);
sizeStatisticsBuilder.add(repetitionLevel, definitionLevel);
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

void write(float value, int repetitionLevel, int definitionLevel) {
statistics.updateStats(value);
sizeStatisticsBuilder.add(repetitionLevel, definitionLevel);
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

void write(double value, int repetitionLevel, int definitionLevel) {
statistics.updateStats(value);
sizeStatisticsBuilder.add(repetitionLevel, definitionLevel);
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

void write(Binary value, int repetitionLevel, int definitionLevel) {
statistics.updateStats(value);
sizeStatisticsBuilder.add(repetitionLevel, definitionLevel, value);
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

void finalizeColumnChunk() {
if (bloomFilterWriter != null && bloomFilter != null) {
bloomFilterWriter.writeBloomFilter(bloomFilter);
}
}

Statistics<?> getStatistics() {
return statistics;
}

SizeStatistics getSizeStatistics() {
return sizeStatisticsBuilder.build();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,14 @@
package org.apache.parquet.column.impl;

import java.io.IOException;
import java.util.OptionalDouble;
import java.util.OptionalLong;
import org.apache.parquet.column.ColumnDescriptor;
import org.apache.parquet.column.ColumnWriter;
import org.apache.parquet.column.ParquetProperties;
import org.apache.parquet.column.page.DictionaryPage;
import org.apache.parquet.column.page.PageWriter;
import org.apache.parquet.column.statistics.SizeStatistics;
import org.apache.parquet.column.statistics.Statistics;
import org.apache.parquet.column.values.ValuesWriter;
import org.apache.parquet.column.values.bloomfilter.AdaptiveBlockSplitBloomFilter;
import org.apache.parquet.column.values.bloomfilter.BlockSplitBloomFilter;
import org.apache.parquet.column.values.bloomfilter.BloomFilter;
import org.apache.parquet.column.values.bloomfilter.BloomFilterWriter;
import org.apache.parquet.io.ParquetEncodingException;
import org.apache.parquet.io.api.Binary;
Expand All @@ -54,12 +50,10 @@ abstract class ColumnWriterBase implements ColumnWriter {
private ValuesWriter dataColumn;
private int valueCount;

private Statistics<?> statistics;
private long rowsWrittenSoFar = 0;
private int pageRowCount;

private final BloomFilterWriter bloomFilterWriter;
private final BloomFilter bloomFilter;
private final ColumnValueCollector collector;

ColumnWriterBase(ColumnDescriptor path, PageWriter pageWriter, ParquetProperties props) {
this(path, pageWriter, null, props);
Expand All @@ -72,34 +66,12 @@ abstract class ColumnWriterBase implements ColumnWriter {
ParquetProperties props) {
this.path = path;
this.pageWriter = pageWriter;
resetStatistics();

this.repetitionLevelColumn = createRLWriter(props, path);
this.definitionLevelColumn = createDLWriter(props, path);
this.dataColumn = props.newValuesWriter(path);

this.bloomFilterWriter = bloomFilterWriter;
if (bloomFilterWriter == null) {
this.bloomFilter = null;
return;
}
int maxBloomFilterSize = props.getMaxBloomFilterBytes();

OptionalLong ndv = props.getBloomFilterNDV(path);
OptionalDouble fpp = props.getBloomFilterFPP(path);
// If user specify the column NDV, we construct Bloom filter from it.
if (ndv.isPresent()) {
int optimalNumOfBits = BlockSplitBloomFilter.optimalNumOfBits(ndv.getAsLong(), fpp.getAsDouble());
this.bloomFilter = new BlockSplitBloomFilter(optimalNumOfBits / 8, maxBloomFilterSize);
} else {
if (props.getAdaptiveBloomFilterEnabled(path)) {
int numCandidates = props.getBloomFilterCandidatesCount(path);
this.bloomFilter =
new AdaptiveBlockSplitBloomFilter(maxBloomFilterSize, numCandidates, fpp.getAsDouble(), path);
} else {
this.bloomFilter = new BlockSplitBloomFilter(maxBloomFilterSize, maxBloomFilterSize);
}
}
this.collector = new ColumnValueCollector(path, bloomFilterWriter, props);
}

abstract ValuesWriter createRLWriter(ParquetProperties props, ColumnDescriptor path);
Expand All @@ -110,10 +82,6 @@ private void log(Object value, int r, int d) {
LOG.debug("{} {} r:{} d:{}", path, value, r, d);
}

private void resetStatistics() {
this.statistics = Statistics.createStats(path.getPrimitiveType());
}

private void definitionLevel(int definitionLevel) {
definitionLevelColumn.writeInteger(definitionLevel);
}
Expand All @@ -137,7 +105,7 @@ public void writeNull(int repetitionLevel, int definitionLevel) {
if (DEBUG) log(null, repetitionLevel, definitionLevel);
repetitionLevel(repetitionLevel);
definitionLevel(definitionLevel);
statistics.incrementNumNulls();
collector.writeNull(repetitionLevel, definitionLevel);
++valueCount;
}

Expand All @@ -157,36 +125,6 @@ public long getBufferedSizeInMemory() {
+ pageWriter.getMemSize();
}

private void updateBloomFilter(int value) {
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

private void updateBloomFilter(long value) {
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

private void updateBloomFilter(double value) {
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

private void updateBloomFilter(float value) {
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

private void updateBloomFilter(Binary value) {
if (bloomFilter != null) {
bloomFilter.insertHash(bloomFilter.hash(value));
}
}

/**
* Writes the current value
*
Expand All @@ -200,8 +138,7 @@ public void write(double value, int repetitionLevel, int definitionLevel) {
repetitionLevel(repetitionLevel);
definitionLevel(definitionLevel);
dataColumn.writeDouble(value);
statistics.updateStats(value);
updateBloomFilter(value);
collector.write(value, repetitionLevel, definitionLevel);
++valueCount;
}

Expand All @@ -218,8 +155,7 @@ public void write(float value, int repetitionLevel, int definitionLevel) {
repetitionLevel(repetitionLevel);
definitionLevel(definitionLevel);
dataColumn.writeFloat(value);
statistics.updateStats(value);
updateBloomFilter(value);
collector.write(value, repetitionLevel, definitionLevel);
++valueCount;
}

Expand All @@ -236,8 +172,7 @@ public void write(Binary value, int repetitionLevel, int definitionLevel) {
repetitionLevel(repetitionLevel);
definitionLevel(definitionLevel);
dataColumn.writeBytes(value);
statistics.updateStats(value);
updateBloomFilter(value);
collector.write(value, repetitionLevel, definitionLevel);
++valueCount;
}

Expand All @@ -254,7 +189,7 @@ public void write(boolean value, int repetitionLevel, int definitionLevel) {
repetitionLevel(repetitionLevel);
definitionLevel(definitionLevel);
dataColumn.writeBoolean(value);
statistics.updateStats(value);
collector.write(value, repetitionLevel, definitionLevel);
++valueCount;
}

Expand All @@ -271,8 +206,7 @@ public void write(int value, int repetitionLevel, int definitionLevel) {
repetitionLevel(repetitionLevel);
definitionLevel(definitionLevel);
dataColumn.writeInteger(value);
statistics.updateStats(value);
updateBloomFilter(value);
collector.write(value, repetitionLevel, definitionLevel);
++valueCount;
}

Expand All @@ -289,8 +223,7 @@ public void write(long value, int repetitionLevel, int definitionLevel) {
repetitionLevel(repetitionLevel);
definitionLevel(definitionLevel);
dataColumn.writeLong(value);
statistics.updateStats(value);
updateBloomFilter(value);
collector.write(value, repetitionLevel, definitionLevel);
++valueCount;
}

Expand All @@ -310,9 +243,7 @@ void finalizeColumnChunk() {
dataColumn.resetDictionary();
}

if (bloomFilterWriter != null && bloomFilter != null) {
bloomFilterWriter.writeBloomFilter(bloomFilter);
}
collector.finalizeColumnChunk();
}

/**
Expand Down Expand Up @@ -389,22 +320,30 @@ void writePage() {
this.rowsWrittenSoFar += pageRowCount;
if (DEBUG) LOG.debug("write page");
try {
writePage(pageRowCount, valueCount, statistics, repetitionLevelColumn, definitionLevelColumn, dataColumn);
writePage(
pageRowCount,
valueCount,
collector.getStatistics(),
collector.getSizeStatistics(),
repetitionLevelColumn,
definitionLevelColumn,
dataColumn);
} catch (IOException e) {
throw new ParquetEncodingException("could not write page for " + path, e);
}
repetitionLevelColumn.reset();
definitionLevelColumn.reset();
dataColumn.reset();
valueCount = 0;
resetStatistics();
collector.resetPageStatistics();
pageRowCount = 0;
}

abstract void writePage(
int rowCount,
int valueCount,
Statistics<?> statistics,
SizeStatistics sizeStatistics,
ValuesWriter repetitionLevels,
ValuesWriter definitionLevels,
ValuesWriter values)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.apache.parquet.column.ColumnDescriptor;
import org.apache.parquet.column.ParquetProperties;
import org.apache.parquet.column.page.PageWriter;
import org.apache.parquet.column.statistics.SizeStatistics;
import org.apache.parquet.column.statistics.Statistics;
import org.apache.parquet.column.values.ValuesWriter;
import org.apache.parquet.column.values.bloomfilter.BloomFilterWriter;
Expand Down Expand Up @@ -60,6 +61,7 @@ void writePage(
int rowCount,
int valueCount,
Statistics<?> statistics,
SizeStatistics sizeStatistics,
ValuesWriter repetitionLevels,
ValuesWriter definitionLevels,
ValuesWriter values)
Expand All @@ -69,6 +71,7 @@ void writePage(
valueCount,
rowCount,
statistics,
sizeStatistics,
repetitionLevels.getEncoding(),
definitionLevels.getEncoding(),
values.getEncoding());
Expand Down
Loading