org.apache.flink.table.utils.print

Interface PrintStyle

All Known Implementing Classes:

RawContentStyle, TableauStyle

@Internal
public interface PrintStyle

A PrintStyle defines style and formatting to print a collection of RowData.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_COLUMN_WIDTH Default max column width.
static String	NULL_VALUE Value used to print null.

Method Summary

Modifier and Type	Method and Description
void	print(Iterator<RowData> it, PrintWriter printWriter) Displays the result.
static RawContentStyle	rawContent(RowDataToStringConverter converter) Create a raw content print style, which only print the result content as raw form.
static TableauStyle	tableauWithDataInferredColumnWidths(ResolvedSchema schema, RowDataToStringConverter converter) Like tableauWithDataInferredColumnWidths(ResolvedSchema, RowDataToStringConverter, int, boolean, boolean), but using default values.
static TableauStyle	tableauWithDataInferredColumnWidths(ResolvedSchema schema, RowDataToStringConverter converter, int maxColumnWidth, boolean printNullAsEmpty, boolean printRowKind) Like tableauWithTypeInferredColumnWidths(ResolvedSchema, RowDataToStringConverter, int, boolean, boolean), but uses the data to infer the column size.
static TableauStyle	tableauWithTypeInferredColumnWidths(ResolvedSchema schema, RowDataToStringConverter converter, int maxColumnWidth, boolean printNullAsEmpty, boolean printRowKind) Create a new TableauStyle using column widths computed from the type.

Field Detail

DEFAULT_MAX_COLUMN_WIDTH

static final int DEFAULT_MAX_COLUMN_WIDTH

Default max column width.

See Also:

Constant Field Values

NULL_VALUE

static final String NULL_VALUE

Value used to print null.

See Also:

Constant Field Values

Method Detail

print

void print(Iterator<RowData> it,
           PrintWriter printWriter)

Displays the result.

Parameters:

it - The iterator for the data to print

printWriter - The writer to write to

tableauWithTypeInferredColumnWidths

static TableauStyle tableauWithTypeInferredColumnWidths(ResolvedSchema schema,
                                                        RowDataToStringConverter converter,
                                                        int maxColumnWidth,
                                                        boolean printNullAsEmpty,
                                                        boolean printRowKind)

Create a new TableauStyle using column widths computed from the type.

Parameters:

schema - the schema of the data to print

converter - the converter to use to convert field values to string

maxColumnWidth - Max column width

printNullAsEmpty - A flag to indicate whether null should be printed as empty string more than <NULL>

printRowKind - A flag to indicate whether print row kind info.

tableauWithDataInferredColumnWidths

static TableauStyle tableauWithDataInferredColumnWidths(ResolvedSchema schema,
                                                        RowDataToStringConverter converter,
                                                        int maxColumnWidth,
                                                        boolean printNullAsEmpty,
                                                        boolean printRowKind)

Like tableauWithTypeInferredColumnWidths(ResolvedSchema, RowDataToStringConverter, int, boolean, boolean), but uses the data to infer the column size.

NOTE: please make sure the data to print is small enough to be stored in java heap memory.

tableauWithDataInferredColumnWidths

static TableauStyle tableauWithDataInferredColumnWidths(ResolvedSchema schema,
                                                        RowDataToStringConverter converter)

Like tableauWithDataInferredColumnWidths(ResolvedSchema, RowDataToStringConverter, int, boolean, boolean), but using default values.

NOTE: please make sure the data to print is small enough to be stored in java heap memory.

rawContent

static RawContentStyle rawContent(RowDataToStringConverter converter)

Create a raw content print style, which only print the result content as raw form. column delimiter is ",", row delimiter is "\n".