Provides access to Avro data written using the DataFileWriter<T>. More...

Inheritance diagram for Avro.File.DataFileReader< T >:

Public Member Functions

delegate DatumReader< T > CreateDatumReader (Schema writerSchema, Schema readerSchema)

Defines the signature for a function that returns a new DatumReader<T> given a writer and reader schema.

Header GetHeader ()

Return the header for the input file or stream.

Returns: Parsed header from the file or stream.

Schema GetSchema ()

Return the schema as read from the file or stream.

Returns: Parse schema from the file or stream.

ICollection< string > GetMetaKeys ()

Return the list of keys in the metadata.

Returns: Metadata keys from the header of the data file.

byte[] GetMeta (string key)

Return the byte value of a metadata property.

Parameters

key	Key for the metadata entry.

Returns: Raw bytes of the value of the metadata entry.

Exceptions

KeyNotFoundException There is no metadata entry with the specified key .

long GetMetaLong (string key)

Return the long value of a metadata property.

Parameters

key	Key for the metadata entry.

Returns: Metadata value as a long.

Exceptions

KeyNotFoundException There is no metadata entry with the specified key .

string GetMetaString (string key)

Return the string value of a metadata property. This method assumes that the string is a UTF-8 encoded in the header.

Parameters

key	Key for the metadata entry.

Returns: Metadata value as a string.

Exceptions

KeyNotFoundException	There is no metadata entry with the specified key .
AvroRuntimeException	Encountered an exception while decoding the value as a UTF-8 string.

void Seek (long position)

Move to a specific, known synchronization point, one returned from IFileWriter<T>.Sync while writing.

Parameters

position Position to jump to.

void Sync (long position)

Move to the next synchronization point after a position.

Parameters

position Position in the stream to start.

bool PastSync (long position)

Return true if past the next synchronization point after a position.

Parameters

position Position to test.

Returns: True if path the next synchronization point after position , false otherwise.

long PreviousSync ()

Return the last synchronization point before our current position.

Returns: Position of the last synchronization point before our current position.

long Tell ()

Return the current position in the input.

Returns: Current position in the input.

bool HasNext ()

Returns true if more entries remain in this file.

Returns: True if more entries remain in this file, false otherwise.

void Reset ()

Resets this reader.

void Dispose ()

T Next ()

Read the next datum from the file.

Returns: Next deserialized data entry.

Static Public Member Functions
static IFileReader< T >	OpenReader (string path)
	Open a reader for a file using path.

static IFileReader< T >	OpenReader (string path, Schema readerSchema)
	Open a reader for a file using path and the reader's schema.

static IFileReader< T >	OpenReader (Stream inStream)
	Open a reader for a stream.

static IFileReader< T >	OpenReader (Stream inStream, bool leaveOpen)
	Open a reader for a stream.

static IFileReader< T >	OpenReader (Stream inStream, Schema readerSchema)
	Open a reader for a stream using the reader's schema.

static IFileReader< T >	OpenReader (Stream inStream, Schema readerSchema, bool leaveOpen)
	Open a reader for a stream using the reader's schema.

static IFileReader< T >	OpenReader (Stream inStream, Schema readerSchema, CreateDatumReader datumReaderFactory)
	Open a reader for a stream using the reader's schema and a custom DatumReader.

static IFileReader< T >	OpenReader (Stream inStream, Schema readerSchema, CreateDatumReader datumReaderFactory, bool leaveOpen)
	Open a reader for a stream using the reader's schema and a custom DatumReader.

Protected Member Functions
virtual void	Dispose (bool disposing)
	Releases resources associated with this DataFileReader<T>.

Properties
IEnumerable< T >	NextEntries `[get]`
	Return an enumeration of the remaining entries in the file. Returns An enumeration of the remaining entries in the file.

Properties inherited from Avro.File.IFileReader< T >

Detailed Description

Provides access to Avro data written using the DataFileWriter<T>.

Template Parameters

T	Type to deserialze data objects to.

See also: IFileReader<T>

Member Function Documentation

◆ CreateDatumReader()

delegate DatumReader< T > Avro.File.DataFileReader< T >.CreateDatumReader	(	Schema	writerSchema,
		Schema	readerSchema
	)

Defines the signature for a function that returns a new DatumReader<T> given a writer and reader schema.

Parameters

writerSchema	Schema used to write the datum.
readerSchema	Schema used to read the datum.

Returns: A datum reader.

◆ Dispose()

virtual void Avro.File.DataFileReader< T >.Dispose ( bool disposing )

inlineprotectedvirtual

Releases resources associated with this DataFileReader<T>.

Parameters

disposing True if called from Dispose(); false otherwise.

◆ GetHeader()

Header Avro.File.DataFileReader< T >.GetHeader ( )

inline

Return the header for the input file or stream.

Returns: Parsed header from the file or stream.

Implements Avro.File.IFileReader< T >.

◆ GetMeta()

byte[] Avro.File.DataFileReader< T >.GetMeta ( string key )

inline

Return the byte value of a metadata property.

Parameters

key	Key for the metadata entry.

Returns: Raw bytes of the value of the metadata entry.

Exceptions

KeyNotFoundException There is no metadata entry with the specified key .

Implements Avro.File.IFileReader< T >.

◆ GetMetaKeys()

ICollection< string > Avro.File.DataFileReader< T >.GetMetaKeys ( )

inline

Return the list of keys in the metadata.

Returns: Metadata keys from the header of the data file.

Implements Avro.File.IFileReader< T >.

◆ GetMetaLong()

long Avro.File.DataFileReader< T >.GetMetaLong ( string key )

inline

Return the long value of a metadata property.

Parameters

key	Key for the metadata entry.

Returns: Metadata value as a long.

Exceptions

KeyNotFoundException There is no metadata entry with the specified key .

Implements Avro.File.IFileReader< T >.

◆ GetMetaString()

string Avro.File.DataFileReader< T >.GetMetaString ( string key )

inline

Return the string value of a metadata property. This method assumes that the string is a UTF-8 encoded in the header.

Parameters

key	Key for the metadata entry.

Returns: Metadata value as a string.

Exceptions

KeyNotFoundException	There is no metadata entry with the specified key .
AvroRuntimeException	Encountered an exception while decoding the value as a UTF-8 string.

Implements Avro.File.IFileReader< T >.

◆ GetSchema()

Schema Avro.File.DataFileReader< T >.GetSchema ( )

inline

Return the schema as read from the file or stream.

Returns: Parse schema from the file or stream.

Implements Avro.File.IFileReader< T >.

◆ HasNext()

bool Avro.File.DataFileReader< T >.HasNext ( )

inline

Returns true if more entries remain in this file.

Returns: True if more entries remain in this file, false otherwise.

Implements Avro.File.IFileReader< T >.

◆ Next()

T Avro.File.DataFileReader< T >.Next ( )

inline

Read the next datum from the file.

Returns: Next deserialized data entry.

Implements Avro.File.IFileReader< T >.

◆ OpenReader() [1/8]

static IFileReader< T > Avro.File.DataFileReader< T >.OpenReader ( Stream inStream )

inlinestatic

Open a reader for a stream.

Parameters

inStream The in stream.

Returns: File Reader.

◆ OpenReader() [2/8]

static IFileReader< T > Avro.File.DataFileReader< T >.OpenReader	(	Stream	inStream,
		bool	leaveOpen
	)

inlinestatic

Open a reader for a stream.

Parameters

inStream	The in stream.
leaveOpen	Leave the stream open after disposing the object.

Returns: File Reader.

◆ OpenReader() [3/8]

static IFileReader< T > Avro.File.DataFileReader< T >.OpenReader	(	Stream	inStream,
		Schema	readerSchema
	)

inlinestatic

Open a reader for a stream using the reader's schema.

Parameters

inStream	Stream containing the file contents.
readerSchema	Schema used to read the file.

Returns: A new file reader.

◆ OpenReader() [4/8]

static IFileReader< T > Avro.File.DataFileReader< T >.OpenReader	(	Stream	inStream,
		Schema	readerSchema,
		bool	leaveOpen
	)

inlinestatic

Open a reader for a stream using the reader's schema.

Parameters

inStream	Stream containing the file contents.
readerSchema	Schema used to read the file.
leaveOpen	Leave the stream open after disposing the object.

Returns: A new file reader.

◆ OpenReader() [5/8]

static IFileReader< T > Avro.File.DataFileReader< T >.OpenReader	(	Stream	inStream,
		Schema	readerSchema,
		CreateDatumReader	datumReaderFactory
	)

inlinestatic

Open a reader for a stream using the reader's schema and a custom DatumReader.

Parameters

inStream	Stream of file contents.
readerSchema	Schema used to read the file.
datumReaderFactory	Factory to create datum readers given a reader an writer schema.

Returns: A new file reader.

◆ OpenReader() [6/8]

static IFileReader< T > Avro.File.DataFileReader< T >.OpenReader	(	Stream	inStream,
		Schema	readerSchema,
		CreateDatumReader	datumReaderFactory,
		bool	leaveOpen
	)

inlinestatic

Open a reader for a stream using the reader's schema and a custom DatumReader.

Parameters

inStream	Stream of file contents.
readerSchema	Schema used to read the file.
datumReaderFactory	Factory to create datum readers given a reader an writer schema.
leaveOpen	Leave the stream open after disposing the object.

Returns: A new file reader.

◆ OpenReader() [7/8]

static IFileReader< T > Avro.File.DataFileReader< T >.OpenReader ( string path )

inlinestatic

Open a reader for a file using path.

Parameters

path The path.

Returns: File Reader.

◆ OpenReader() [8/8]

static IFileReader< T > Avro.File.DataFileReader< T >.OpenReader	(	string	path,
		Schema	readerSchema
	)

inlinestatic

Open a reader for a file using path and the reader's schema.

Parameters

path	Path to the file.
readerSchema	Schema used to read data from the file.

Returns: A new file reader.

◆ PastSync()

bool Avro.File.DataFileReader< T >.PastSync ( long position )

inline

Return true if past the next synchronization point after a position.

Parameters

position Position to test.

Returns: True if path the next synchronization point after position , false otherwise.

Implements Avro.File.IFileReader< T >.

◆ PreviousSync()

long Avro.File.DataFileReader< T >.PreviousSync ( )

inline

Return the last synchronization point before our current position.

Returns: Position of the last synchronization point before our current position.

Implements Avro.File.IFileReader< T >.

◆ Seek()

void Avro.File.DataFileReader< T >.Seek ( long position )

inline

Move to a specific, known synchronization point, one returned from IFileWriter<T>.Sync while writing.

Parameters

position Position to jump to.

Implements Avro.File.IFileReader< T >.

◆ Sync()

void Avro.File.DataFileReader< T >.Sync ( long position )

inline

Move to the next synchronization point after a position.

Parameters

position Position in the stream to start.

Implements Avro.File.IFileReader< T >.

◆ Tell()

long Avro.File.DataFileReader< T >.Tell ( )

inline

Return the current position in the input.

Returns: Current position in the input.

Implements Avro.File.IFileReader< T >.

Property Documentation

◆ NextEntries

IEnumerable<T> Avro.File.DataFileReader< T >.NextEntries

get

Return an enumeration of the remaining entries in the file.

Returns: An enumeration of the remaining entries in the file.

Implements Avro.File.IFileReader< T >.

The documentation for this class was generated from the following file:

src/apache/main/File/DataFileReader.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CreateDatumReader()

◆ Dispose()

◆ GetHeader()

◆ GetMeta()

◆ GetMetaKeys()

◆ GetMetaLong()

◆ GetMetaString()

◆ GetSchema()

◆ HasNext()

◆ Next()

◆ OpenReader() [1/8]

◆ OpenReader() [2/8]

◆ OpenReader() [3/8]

◆ OpenReader() [4/8]

◆ OpenReader() [5/8]

◆ OpenReader() [6/8]

◆ OpenReader() [7/8]

◆ OpenReader() [8/8]

◆ PastSync()

◆ PreviousSync()

◆ Seek()

◆ Sync()

◆ Tell()

Property Documentation

◆ NextEntries