com.facebook.presto.spi

Interface ConnectorPageSource

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

UpdatablePageSource

All Known Implementing Classes:

FixedPageSource, RecordPageSource

public interface ConnectorPageSource
extends Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static CompletableFuture<?>	NOT_BLOCKED

Method Summary

Modifier and Type	Method and Description
void	close() Immediately finishes this page source.
long	getCompletedBytes() Gets the number of input bytes processed by this page source so far.
long	getCompletedPositions() Gets the number of input rows processed by this page source so far.
Page	getNextPage() Gets the next page of data.
long	getReadTimeNanos() Gets the wall time this page source spent reading data from the input.
default RuntimeStats	getRuntimeStats() Returns the stats of this page source accumulated so far.
long	getSystemMemoryUsage() Get the total memory that needs to be reserved in the general memory pool.
default CompletableFuture<?>	isBlocked() Returns a future that will be completed when the page source becomes unblocked.
boolean	isFinished() Will this page source product more pages?

Field Detail

NOT_BLOCKED

static final CompletableFuture<?> NOT_BLOCKED

Method Detail

getCompletedBytes

long getCompletedBytes()

Gets the number of input bytes processed by this page source so far. If size is not available, this method should return zero.

getCompletedPositions

long getCompletedPositions()

Gets the number of input rows processed by this page source so far. If number is not available, this method should return zero.

getReadTimeNanos

long getReadTimeNanos()

Gets the wall time this page source spent reading data from the input. If read time is not available, this method should return zero.

isFinished

boolean isFinished()

Will this page source product more pages?

getNextPage

Page getNextPage()

Gets the next page of data. This method is allowed to return null.

getSystemMemoryUsage

long getSystemMemoryUsage()

Get the total memory that needs to be reserved in the general memory pool. This memory should include any buffers, etc. that are used for reading data.

Returns:

the memory used so far in table read

close

void close()
    throws IOException

Immediately finishes this page source. Presto will always call this method.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isBlocked

default CompletableFuture<?> isBlocked()

Returns a future that will be completed when the page source becomes unblocked. If the page source is not blocked, this method should return NOT_BLOCKED.

getRuntimeStats

default RuntimeStats getRuntimeStats()

Returns the stats of this page source accumulated so far.