Module io.xpipe.core

Package io.xpipe.core.source

Interface TableReadConnection

All Superinterfaces:

AutoCloseable, DataSourceConnection, DataSourceReadConnection

All Known Implementing Classes:

BufferedTableReadConnection, LimitTableReadConnection, PeekTableStreamReadConnection, XpbtReadConnection

public interface TableReadConnection
extends DataSourceReadConnection

A connection for sequentially reading the data of a table data source.

Method Summary

Modifier and Type	Method	Description
default TableReadConnection	buffered()
default TableReadConnection	buffered(int limit)
static TableReadConnection	empty()
default void	forward(DataSourceConnection con)
default int	forwardAndCount(DataSourceConnection con)
default void	forwardRows(OutputStream out, int maxLines)	Writes the rows to an OutputStream in the X-Pipe binary format.
TupleType	getDataType()	Returns the data type of the table data.
default OptionalInt	getRowCount()	Returns the amount of rows to be read or -1 if the amount is unknown.
default TableReadConnection	limit(int limit)
default ArrayNode	readRows(int maxLines)	Reads multiple rows in bulk.
void	withRows(DataStructureNodeAcceptor<TupleNode> lineAcceptor)	Consumes the table rows until the acceptor returns false.

Methods inherited from interface io.xpipe.core.source.DataSourceConnection

close, init

Methods inherited from interface io.xpipe.core.source.DataSourceReadConnection

canRead

Method Details

empty

static TableReadConnection empty()

getDataType

TupleType getDataType()

Returns the data type of the table data.

getRowCount

default OptionalInt getRowCount()
                         throws Exception

Returns the amount of rows to be read or -1 if the amount is unknown.

Throws:

Exception

limit

default TableReadConnection limit(int limit)

buffered

default TableReadConnection buffered()
                              throws Exception

Throws:

Exception

buffered

default TableReadConnection buffered(int limit)
                              throws Exception

Throws:

Exception

withRows

void withRows(DataStructureNodeAcceptor<TupleNode> lineAcceptor)
       throws Exception

Consumes the table rows until the acceptor returns false.

Throws:

Exception

readRows

default ArrayNode readRows(int maxLines)
                    throws Exception

Reads multiple rows in bulk.

Throws:

Exception

forwardRows

default void forwardRows(OutputStream out,
 int maxLines)
                  throws Exception

Writes the rows to an OutputStream in the X-Pipe binary format.

Throws:

Exception

forward

default void forward(DataSourceConnection con)
              throws Exception

Specified by:

forward in interface DataSourceReadConnection

Throws:

Exception

forwardAndCount

default int forwardAndCount(DataSourceConnection con)
                     throws Exception

Throws:

Exception