Package org.apache.iceberg

Class Metrics

java.lang.Object

org.apache.iceberg.Metrics

All Implemented Interfaces:

Serializable

public class Metrics
extends Object
implements Serializable

Iceberg file format metrics.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Metrics()
Metrics(Long rowCount, Map<Integer,Long> columnSizes, Map<Integer,Long> valueCounts, Map<Integer,Long> nullValueCounts, Map<Integer,Long> nanValueCounts)
Metrics(Long rowCount, Map<Integer,Long> columnSizes, Map<Integer,Long> valueCounts, Map<Integer,Long> nullValueCounts, Map<Integer,Long> nanValueCounts, Map<Integer,ByteBuffer> lowerBounds, Map<Integer,ByteBuffer> upperBounds)

Method Summary

Modifier and Type	Method	Description
Map<Integer,Long>	columnSizes()	Get the number of bytes for all fields in a file.
Map<Integer,ByteBuffer>	lowerBounds()	Get the non-null lower bound values for all fields in a file.
Map<Integer,Long>	nanValueCounts()	Get the number of NaN values for all float and double fields in a file.
Map<Integer,Long>	nullValueCounts()	Get the number of null values for all fields in a file.
Long	recordCount()	Get the number of records (rows) in file.
Map<Integer,ByteBuffer>	upperBounds()	Get the non-null upper bound values for all fields in a file.
Map<Integer,Long>	valueCounts()	Get the number of all values, including nulls, NaN and repeated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Metrics

public Metrics()

Metrics

public Metrics(Long rowCount,
 Map<Integer,Long> columnSizes,
 Map<Integer,Long> valueCounts,
 Map<Integer,Long> nullValueCounts,
 Map<Integer,Long> nanValueCounts)

Metrics

public Metrics(Long rowCount,
 Map<Integer,Long> columnSizes,
 Map<Integer,Long> valueCounts,
 Map<Integer,Long> nullValueCounts,
 Map<Integer,Long> nanValueCounts,
 Map<Integer,ByteBuffer> lowerBounds,
 Map<Integer,ByteBuffer> upperBounds)

Method Details

recordCount

public Long recordCount()

Get the number of records (rows) in file.

Returns:

the count of records (rows) in the file as a long

columnSizes

public Map<Integer,Long> columnSizes()

Get the number of bytes for all fields in a file.

Returns:

a Map of fieldId to the size in bytes

valueCounts

public Map<Integer,Long> valueCounts()

Get the number of all values, including nulls, NaN and repeated.

Returns:

a Map of fieldId to the number of all values including nulls, NaN and repeated

nullValueCounts

public Map<Integer,Long> nullValueCounts()

Get the number of null values for all fields in a file.

Returns:

a Map of fieldId to the number of nulls

nanValueCounts

public Map<Integer,Long> nanValueCounts()

Get the number of NaN values for all float and double fields in a file.

Returns:

a Map of fieldId to the number of NaN counts

lowerBounds

public Map<Integer,ByteBuffer> lowerBounds()

Get the non-null lower bound values for all fields in a file.

To convert the ByteBuffer back to a value, use Conversions.fromByteBuffer(org.apache.iceberg.types.Type, java.nio.ByteBuffer).

Returns:

a Map of fieldId to the lower bound value as a ByteBuffer

See Also:

• Iceberg Spec - Appendix D: Single-value serialization

upperBounds

public Map<Integer,ByteBuffer> upperBounds()

Get the non-null upper bound values for all fields in a file.

Returns:

a Map of fieldId to the upper bound value as a ByteBuffer