org.apache.druid.sql.http

Interface ResultFormat.Writer

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ArrayLinesWriter, ArrayWriter, CsvWriter, ObjectLinesWriter, ObjectWriter

Enclosing class:

ResultFormat

public static interface ResultFormat.Writer
extends Closeable

Method Summary

Modifier and Type	Method and Description
void	writeHeader(org.apache.calcite.rel.type.RelDataType rowType, boolean includeTypes, boolean includeSqlTypes)
void	writeResponseEnd() End of the response.
void	writeResponseStart() Start of the response, called once per writer.
void	writeRowEnd() End of each result row.
void	writeRowField(String name, Object value) Field within a row.
void	writeRowStart() Start of each result row.

Methods inherited from interface java.io.Closeable

close

Method Detail

writeResponseStart

void writeResponseStart()
                 throws IOException

Start of the response, called once per writer.

Throws:

IOException

writeHeader

void writeHeader(org.apache.calcite.rel.type.RelDataType rowType,
                 boolean includeTypes,
                 boolean includeSqlTypes)
          throws IOException

Throws:

IOException

writeRowStart

void writeRowStart()
            throws IOException

Start of each result row.

Throws:

IOException

writeRowField

void writeRowField(String name,
                   @Nullable
                   Object value)
            throws IOException

Field within a row.

Throws:

IOException

writeRowEnd

void writeRowEnd()
          throws IOException

End of each result row.

Throws:

IOException

writeResponseEnd

void writeResponseEnd()
               throws IOException

End of the response. Must allow the user to know that they have read all data successfully.

Throws:

IOException