Kinetica   C#   API  Version 7.2.3.0
Public Member Functions | Static Public Member Functions | List of all members
Avro.File.DataFileWriter< T > Class Template Reference
+ Inheritance diagram for Avro.File.DataFileWriter< T >:
+ Collaboration diagram for Avro.File.DataFileWriter< T >:

Public Member Functions

bool IsReservedMeta (string key)
 Returns true if parameter is a reserved Avro meta data value. More...
 
void SetMeta (String key, byte[] value)
 Set meta data pair More...
 
void SetMeta (String key, long value)
 Set meta data pair (long value) More...
 
void SetMeta (String key, string value)
 Set meta data pair (string value) More...
 
void SetSyncInterval (int syncInterval)
 Set the synchronization interval for this file / stream, in bytes. More...
 
void Append (T datum)
 Append datum to a file / stream More...
 
void Flush ()
 Flush out any buffered data More...
 
long Sync ()
 Forces the end of the current block, emitting a synchronization marker More...
 
void Close ()
 Closes the file / stream More...
 
void Dispose ()
 

Static Public Member Functions

static IFileWriter< T > OpenWriter (DatumWriter< T > writer, string path)
 Open a new writer instance to write More...
 
static IFileWriter< T > OpenWriter (DatumWriter< T > writer, Stream outStream)
 Open a new writer instance to write More...
 
static IFileWriter< T > OpenWriter (DatumWriter< T > writer, string path, Codec codec)
 Open a new writer instance to write More...
 
static IFileWriter< T > OpenWriter (DatumWriter< T > writer, Stream outStream, Codec codec)
 Open a new writer instance to write to an output stream with a specified codec More...
 

Detailed Description

Definition at line 27 of file DataFileWriter.cs.

Member Function Documentation

◆ Append()

void Avro.File.DataFileWriter< T >.Append ( T  datum)
inline

Append datum to a file / stream

Parameters
datum

Implements Avro.File.IFileWriter< T >.

Definition at line 146 of file DataFileWriter.cs.

◆ Close()

void Avro.File.DataFileWriter< T >.Close ( )
inline

Closes the file / stream

Implements Avro.File.IFileWriter< T >.

Definition at line 188 of file DataFileWriter.cs.

◆ Dispose()

void Avro.File.DataFileWriter< T >.Dispose ( )
inline

Definition at line 310 of file DataFileWriter.cs.

◆ Flush()

void Avro.File.DataFileWriter< T >.Flush ( )
inline

Flush out any buffered data

Implements Avro.File.IFileWriter< T >.

Definition at line 175 of file DataFileWriter.cs.

◆ IsReservedMeta()

bool Avro.File.DataFileWriter< T >.IsReservedMeta ( string  key)
inline

Returns true if parameter is a reserved Avro meta data value.

Parameters
key
Returns

Implements Avro.File.IFileWriter< T >.

Definition at line 99 of file DataFileWriter.cs.

◆ OpenWriter() [1/4]

static IFileWriter<T> Avro.File.DataFileWriter< T >.OpenWriter ( DatumWriter< T >  writer,
string  path 
)
inlinestatic

Open a new writer instance to write

to a file path, using a Null codec

Parameters
writer
path
Returns

Definition at line 50 of file DataFileWriter.cs.

◆ OpenWriter() [2/4]

static IFileWriter<T> Avro.File.DataFileWriter< T >.OpenWriter ( DatumWriter< T >  writer,
Stream  outStream 
)
inlinestatic

Open a new writer instance to write

to an output stream, using a Null codec

Parameters
writer
outStream
Returns

Definition at line 62 of file DataFileWriter.cs.

◆ OpenWriter() [3/4]

static IFileWriter<T> Avro.File.DataFileWriter< T >.OpenWriter ( DatumWriter< T >  writer,
string  path,
Codec  codec 
)
inlinestatic

Open a new writer instance to write

to a file path with a specified codec

Parameters
writer
path
codec
Returns

Definition at line 75 of file DataFileWriter.cs.

◆ OpenWriter() [4/4]

static IFileWriter<T> Avro.File.DataFileWriter< T >.OpenWriter ( DatumWriter< T >  writer,
Stream  outStream,
Codec  codec 
)
inlinestatic

Open a new writer instance to write to an output stream with a specified codec

Parameters
writer
outStream
codec
Returns

Definition at line 88 of file DataFileWriter.cs.

◆ SetMeta() [1/3]

void Avro.File.DataFileWriter< T >.SetMeta ( String  key,
byte []  value 
)
inline

Set meta data pair

Parameters
key
value

Implements Avro.File.IFileWriter< T >.

Definition at line 104 of file DataFileWriter.cs.

◆ SetMeta() [2/3]

void Avro.File.DataFileWriter< T >.SetMeta ( String  key,
long  value 
)
inline

Set meta data pair (long value)

Parameters
key
value

Implements Avro.File.IFileWriter< T >.

Definition at line 113 of file DataFileWriter.cs.

◆ SetMeta() [3/3]

void Avro.File.DataFileWriter< T >.SetMeta ( String  key,
string  value 
)
inline

Set meta data pair (string value)

Parameters
key
value

Implements Avro.File.IFileWriter< T >.

Definition at line 125 of file DataFileWriter.cs.

◆ SetSyncInterval()

void Avro.File.DataFileWriter< T >.SetSyncInterval ( int  syncInterval)
inline

Set the synchronization interval for this file / stream, in bytes.

Valid values range from 32 to 2^30. Suggested values are between 2K and 2M

Parameters
syncInterval
Returns

Implements Avro.File.IFileWriter< T >.

Definition at line 137 of file DataFileWriter.cs.

◆ Sync()

long Avro.File.DataFileWriter< T >.Sync ( )
inline

Forces the end of the current block, emitting a synchronization marker

Returns

Implements Avro.File.IFileWriter< T >.

Definition at line 181 of file DataFileWriter.cs.

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