org.apache.hudi.avro.model

Class HoodieMetadataRecord

java.lang.Object

org.apache.avro.specific.SpecificRecordBase

org.apache.hudi.avro.model.HoodieMetadataRecord

All Implemented Interfaces:

Externalizable, Serializable, Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericRecord, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord

public class HoodieMetadataRecord
extends org.apache.avro.specific.SpecificRecordBase
implements org.apache.avro.specific.SpecificRecord

A record saved within the Metadata Table

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HoodieMetadataRecord.Builder RecordBuilder for HoodieMetadataRecord instances.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.avro.Schema	SCHEMA$

Constructor Summary

Constructors

Constructor and Description
HoodieMetadataRecord() Default constructor.
HoodieMetadataRecord(String key, Integer type, Map<String,HoodieMetadataFileInfo> filesystemMetadata, HoodieMetadataBloomFilter BloomFilterMetadata, HoodieMetadataColumnStats ColumnStatsMetadata) All-args constructor.

Method Summary

Modifier and Type	Method and Description
static org.apache.avro.message.BinaryMessageDecoder<HoodieMetadataRecord>	createDecoder(org.apache.avro.message.SchemaStore resolver) Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.
static HoodieMetadataRecord	fromByteBuffer(ByteBuffer b) Deserializes a HoodieMetadataRecord from a ByteBuffer.
Object	get(int field$)
HoodieMetadataBloomFilter	getBloomFilterMetadata() Gets the value of the 'BloomFilterMetadata' field.
static org.apache.avro.Schema	getClassSchema()
HoodieMetadataColumnStats	getColumnStatsMetadata() Gets the value of the 'ColumnStatsMetadata' field.
static org.apache.avro.message.BinaryMessageDecoder<HoodieMetadataRecord>	getDecoder() Return the BinaryMessageDecoder instance used by this class.
static org.apache.avro.message.BinaryMessageEncoder<HoodieMetadataRecord>	getEncoder() Return the BinaryMessageEncoder instance used by this class.
Map<String,HoodieMetadataFileInfo>	getFilesystemMetadata() Gets the value of the 'filesystemMetadata' field.
String	getKey() Gets the value of the 'key' field.
org.apache.avro.Schema	getSchema()
org.apache.avro.specific.SpecificData	getSpecificData()
int	getType() Gets the value of the 'type' field.
static HoodieMetadataRecord.Builder	newBuilder() Creates a new HoodieMetadataRecord RecordBuilder.
static HoodieMetadataRecord.Builder	newBuilder(HoodieMetadataRecord.Builder other) Creates a new HoodieMetadataRecord RecordBuilder by copying an existing Builder.
static HoodieMetadataRecord.Builder	newBuilder(HoodieMetadataRecord other) Creates a new HoodieMetadataRecord RecordBuilder by copying an existing HoodieMetadataRecord instance.
void	put(int field$, Object value$)
void	readExternal(ObjectInput in)
void	setBloomFilterMetadata(HoodieMetadataBloomFilter value) Sets the value of the 'BloomFilterMetadata' field.
void	setColumnStatsMetadata(HoodieMetadataColumnStats value) Sets the value of the 'ColumnStatsMetadata' field.
void	setFilesystemMetadata(Map<String,HoodieMetadataFileInfo> value) Sets the value of the 'filesystemMetadata' field.
void	setKey(String value) Sets the value of the 'key' field.
void	setType(int value) Sets the value of the 'type' field.
ByteBuffer	toByteBuffer() Serializes this HoodieMetadataRecord to a ByteBuffer.
void	writeExternal(ObjectOutput out)

Methods inherited from class org.apache.avro.specific.SpecificRecordBase

compareTo, customDecode, customEncode, equals, get, getConversion, getConversion, hasCustomCoders, hashCode, put, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.avro.generic.GenericRecord

hasField

Field Detail

SCHEMA$

public static final org.apache.avro.Schema SCHEMA$

Constructor Detail

HoodieMetadataRecord

public HoodieMetadataRecord()

Default constructor. Note that this does not initialize fields to their default values from the schema. If that is desired then one should use newBuilder().

HoodieMetadataRecord

public HoodieMetadataRecord(String key,
                            Integer type,
                            Map<String,HoodieMetadataFileInfo> filesystemMetadata,
                            HoodieMetadataBloomFilter BloomFilterMetadata,
                            HoodieMetadataColumnStats ColumnStatsMetadata)

All-args constructor.

Parameters:

key - The new value for key

type - Type of the metadata record

filesystemMetadata - Contains information about partitions and files within the dataset

BloomFilterMetadata - Metadata Index of bloom filters for all data files in the user table

ColumnStatsMetadata - Metadata Index of column statistics for all data files in the user table

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

getEncoder

public static org.apache.avro.message.BinaryMessageEncoder<HoodieMetadataRecord> getEncoder()

Return the BinaryMessageEncoder instance used by this class.

Returns:

the message encoder used by this class

getDecoder

public static org.apache.avro.message.BinaryMessageDecoder<HoodieMetadataRecord> getDecoder()

Return the BinaryMessageDecoder instance used by this class.

Returns:

the message decoder used by this class

createDecoder

public static org.apache.avro.message.BinaryMessageDecoder<HoodieMetadataRecord> createDecoder(org.apache.avro.message.SchemaStore resolver)

Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.

Parameters:

resolver - a SchemaStore used to find schemas by fingerprint

Returns:

a BinaryMessageDecoder instance for this class backed by the given SchemaStore

toByteBuffer

public ByteBuffer toByteBuffer()
                        throws IOException

Serializes this HoodieMetadataRecord to a ByteBuffer.

Returns:

a buffer holding the serialized data for this instance

Throws:

IOException - if this instance could not be serialized

fromByteBuffer

public static HoodieMetadataRecord fromByteBuffer(ByteBuffer b)
                                           throws IOException

Deserializes a HoodieMetadataRecord from a ByteBuffer.

Parameters:

b - a byte buffer holding serialized data for an instance of this class

Returns:

a HoodieMetadataRecord instance decoded from the given buffer

Throws:

IOException - if the given bytes could not be deserialized into an instance of this class

getSpecificData

public org.apache.avro.specific.SpecificData getSpecificData()

Overrides:

getSpecificData in class org.apache.avro.specific.SpecificRecordBase

getSchema

public org.apache.avro.Schema getSchema()

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Specified by:

getSchema in class org.apache.avro.specific.SpecificRecordBase

get

public Object get(int field$)

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Specified by:

get in class org.apache.avro.specific.SpecificRecordBase

put

public void put(int field$,
                Object value$)

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Specified by:

put in class org.apache.avro.specific.SpecificRecordBase

getKey

public String getKey()

Gets the value of the 'key' field.

Returns:

The value of the 'key' field.

setKey

public void setKey(String value)

Sets the value of the 'key' field.

Parameters:

value - the value to set.

getType

public int getType()

Gets the value of the 'type' field.

Returns:

Type of the metadata record

setType

public void setType(int value)

Sets the value of the 'type' field. Type of the metadata record

Parameters:

value - the value to set.

getFilesystemMetadata

public Map<String,HoodieMetadataFileInfo> getFilesystemMetadata()

Gets the value of the 'filesystemMetadata' field.

Returns:

Contains information about partitions and files within the dataset

setFilesystemMetadata

public void setFilesystemMetadata(Map<String,HoodieMetadataFileInfo> value)

Sets the value of the 'filesystemMetadata' field. Contains information about partitions and files within the dataset

Parameters:

value - the value to set.

getBloomFilterMetadata

public HoodieMetadataBloomFilter getBloomFilterMetadata()

Gets the value of the 'BloomFilterMetadata' field.

Returns:

Metadata Index of bloom filters for all data files in the user table

setBloomFilterMetadata

public void setBloomFilterMetadata(HoodieMetadataBloomFilter value)

Sets the value of the 'BloomFilterMetadata' field. Metadata Index of bloom filters for all data files in the user table

Parameters:

value - the value to set.

getColumnStatsMetadata

public HoodieMetadataColumnStats getColumnStatsMetadata()

Gets the value of the 'ColumnStatsMetadata' field.

Returns:

Metadata Index of column statistics for all data files in the user table

setColumnStatsMetadata

public void setColumnStatsMetadata(HoodieMetadataColumnStats value)

Sets the value of the 'ColumnStatsMetadata' field. Metadata Index of column statistics for all data files in the user table

Parameters:

value - the value to set.

newBuilder

public static HoodieMetadataRecord.Builder newBuilder()

Creates a new HoodieMetadataRecord RecordBuilder.

Returns:

A new HoodieMetadataRecord RecordBuilder

newBuilder

public static HoodieMetadataRecord.Builder newBuilder(HoodieMetadataRecord.Builder other)

Creates a new HoodieMetadataRecord RecordBuilder by copying an existing Builder.

Parameters:

other - The existing builder to copy.

Returns:

A new HoodieMetadataRecord RecordBuilder

newBuilder

public static HoodieMetadataRecord.Builder newBuilder(HoodieMetadataRecord other)

Creates a new HoodieMetadataRecord RecordBuilder by copying an existing HoodieMetadataRecord instance.

Parameters:

other - The existing instance to copy.

Returns:

A new HoodieMetadataRecord RecordBuilder

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class org.apache.avro.specific.SpecificRecordBase

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class org.apache.avro.specific.SpecificRecordBase

Throws:

IOException