alluxio.job.plan.transform.format

Interface TableWriter

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CsvWriter, ParquetWriter, TablesWriter

public interface TableWriter
extends Closeable

A writer for writing rows to a table.

Method Summary

Modifier and Type	Method and Description
void	close() Closes a writer, which means the table is complete now.
static TableWriter	create(TableSchema schema, AlluxioURI uri)
static TableWriter	create(TableSchema schema, AlluxioURI uri, PartitionInfo partitionInfo)
long	getBytes() Note that the bytes written should take compression and encoding into consideration.
int	getRows()
void	write(TableRow row) Writes a row.

Method Detail

create

static TableWriter create(TableSchema schema,
                          AlluxioURI uri)
                   throws IOException

Parameters:

schema - the table schema

uri - the URI to the output

Returns:

the writer for the output

Throws:

IOException

create

static TableWriter create(TableSchema schema,
                          AlluxioURI uri,
                          @Nullable
                          PartitionInfo partitionInfo)
                   throws IOException

Parameters:

schema - the table schema

uri - the URI to the output

partitionInfo - the partition info (default configuration is used if null)

Returns:

the writer for the output

Throws:

IOException

write

void write(TableRow row)
    throws IOException

Writes a row.

Parameters:

row - a row

Throws:

IOException - when write fails

close

void close()
    throws IOException

Closes a writer, which means the table is complete now.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - when failing to close the underlying output stream

getRows

int getRows()

Returns:

the number of rows that have been written

getBytes

long getBytes()

Note that the bytes written should take compression and encoding into consideration. If the writer writes to a file, the bytes written should be an estimate of the actual bytes written to the file.

Returns:

the number of bytes that have been written