com.alibaba.innodb.java.reader

接口 TableReader

所有超级接口:

AutoCloseable, Closeable

所有已知实现类:

TableReaderImpl

public interface TableReader
extends Closeable

Reader to query upon an Innodb file with suffix of *.ibd. All operations are thread-safe.

作者:

xu.zx

方法概要

限定符和类型	方法和说明
void	close() Close.
double	getAllIndexPageFillingRate() Get all index page filling rate, use iterator pattern to avoid OutOfMemory.
double	getIndexPageFillingRate(int pageNumber) Get single index page filling rate.
long	getNumOfPages() Return total page count.
Iterator<AbstractPage>	getPageIterator() Get page iterator.
Iterator<GenericRecord>	getQueryAllIterator() Return an iterator to query all records of a tablespace.
Iterator<GenericRecord>	getQueryAllIterator(boolean ascOrder) Return an iterator to query all records of a tablespace.
Iterator<GenericRecord>	getQueryAllIterator(List<String> projection) Return an iterator to query all records of a tablespace.
Iterator<GenericRecord>	getQueryAllIterator(List<String> projection, boolean ascOrder) Return an iterator to query all records of a tablespace.
Iterator<GenericRecord>	getRangeQueryIterator(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator) Return an iterator to do range query records by primary key in a tablespace.
Iterator<GenericRecord>	getRangeQueryIterator(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, boolean ascOrder) Return an iterator to do range query records by primary key in a tablespace.
Iterator<GenericRecord>	getRangeQueryIterator(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, List<String> projection) Return an iterator to do range query records by primary key in a tablespace.
Iterator<GenericRecord>	getRangeQueryIterator(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, List<String> projection, boolean ascOrder) Return an iterator to do range query records by primary key in a tablespace.
Iterator<GenericRecord>	getRecordIteratorBySk(String skName, List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator) Return record iterator by secondary key (SK) in a tablespace.
Iterator<GenericRecord>	getRecordIteratorBySk(String skName, List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, boolean ascOrder) Return record iterator by secondary key (SK) in a tablespace.
Iterator<GenericRecord>	getRecordIteratorBySk(String skName, List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, List<String> projection) Return record iterator by secondary key (SK) in a tablespace.
Iterator<GenericRecord>	getRecordIteratorBySk(String skName, List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, List<String> projection, boolean ascOrder) Return record iterator by secondary key (SK) in a tablespace.
TableDef	getTableDef() Return table definition.
void	open() Open table.
List<GenericRecord>	queryAll() Query all records in a tablespace.
List<GenericRecord>	queryAll(List<String> projection) Query all records in a tablespace with a filter and projection.
List<GenericRecord>	queryAll(java.util.function.Predicate<GenericRecord> recordPredicate) Query all records in a tablespace with a filter.
List<GenericRecord>	queryAll(java.util.function.Predicate<GenericRecord> recordPredicate, List<String> projection) Query all records in a tablespace with a filter and projection.
List<GenericRecord>	queryByPageNumber(int pageNumber) Query all records by single index page.
List<GenericRecord>	queryByPageNumber(long pageNumber) Query all records by single index page.
GenericRecord	queryByPrimaryKey(List<Object> key) Query record by primary key in a tablespace.
GenericRecord	queryByPrimaryKey(List<Object> key, List<String> projection) Query record by primary key in a tablespace with projection.
List<GenericRecord>	rangeQueryByPrimaryKey(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator) Range query records by primary key in a tablespace.
List<GenericRecord>	rangeQueryByPrimaryKey(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, List<String> projection) Range query records by primary key in a tablespace with a filter.
List<GenericRecord>	rangeQueryByPrimaryKey(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, java.util.function.Predicate<GenericRecord> recordPredicate) Range query records by primary key in a tablespace with a filter.
List<GenericRecord>	rangeQueryByPrimaryKey(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, java.util.function.Predicate<GenericRecord> recordPredicate, List<String> projection) Range query records by primary key in a tablespace with a filter.
List<FilHeader>	readAllPageHeaders() Read all page headers into memory.
List<AbstractPage>	readAllPages() Read all pages into memory which may cause OutOfMemory when tablespace file size is too big.
AbstractPage	readPage(long pageNumber) Read one page as AbstractPage.

方法详细资料

open

void open()

Open table.

getNumOfPages

long getNumOfPages()

Return total page count.

返回:

number of pages.

readAllPages

List<AbstractPage> readAllPages()

Read all pages into memory which may cause OutOfMemory when tablespace file size is too big. Use getPageIterator() if file size is too big.

返回:

list of AbstractPage

getPageIterator

Iterator<AbstractPage> getPageIterator()

Get page iterator.

返回:

Iterator of AbstractPage

readAllPageHeaders

List<FilHeader> readAllPageHeaders()

Read all page headers into memory.

返回:

list of FilHeader

readPage

AbstractPage readPage(long pageNumber)

Read one page as AbstractPage.

参数:

pageNumber - page number

返回:

AbstractPage

getAllIndexPageFillingRate

double getAllIndexPageFillingRate()

Get all index page filling rate, use iterator pattern to avoid OutOfMemory.

返回:

filling rate

getIndexPageFillingRate

double getIndexPageFillingRate(int pageNumber)

Get single index page filling rate.

参数:

pageNumber - page number

返回:

filling rate

queryByPageNumber

List<GenericRecord> queryByPageNumber(int pageNumber)

Query all records by single index page.

参数:

pageNumber - page number (int type), can be leaf or non-leaf page

返回:

list of records

queryByPageNumber

List<GenericRecord> queryByPageNumber(long pageNumber)

Query all records by single index page.

参数:

pageNumber - page number (long type), can be leaf or non-leaf page

返回:

list of records

queryByPrimaryKey

GenericRecord queryByPrimaryKey(List<Object> key)

Query record by primary key in a tablespace.

For single key the list size should be one, for composite key the size will be more than one.

参数:

key - primary key, single key or a composite key

返回:

record

queryByPrimaryKey

GenericRecord queryByPrimaryKey(List<Object> key,
                                List<String> projection)

Query record by primary key in a tablespace with projection.

For single key the list size should be one, for composite key the size will be more than one.

参数:

key - primary key, single key or a composite key

projection - projection of selected column names

返回:

record

queryAll

List<GenericRecord> queryAll()

Query all records in a tablespace.

Note this will cause out-of-memory if the table size is too big.

返回:

all records

queryAll

List<GenericRecord> queryAll(java.util.function.Predicate<GenericRecord> recordPredicate)

Query all records in a tablespace with a filter.

Note this will cause out-of-memory if the table size is too big.

参数:

recordPredicate - optional filtering, if predicate returns true upon record, then it will be added to result set

返回:

all records

queryAll

List<GenericRecord> queryAll(List<String> projection)

Query all records in a tablespace with a filter and projection.

Note this will cause out-of-memory if the table size is too big.

参数:

projection - projection of selected column names

返回:

all records

queryAll

List<GenericRecord> queryAll(java.util.function.Predicate<GenericRecord> recordPredicate,
                             List<String> projection)

Query all records in a tablespace with a filter and projection.

Note this will cause out-of-memory if the table size is too big. Make sure fields are included in projection for predicate to use.

参数:

recordPredicate - optional filtering, if predicate returns true upon record, then it will be added to result set

projection - projection of selected column names

返回:

all records

rangeQueryByPrimaryKey

List<GenericRecord> rangeQueryByPrimaryKey(List<Object> lower,
                                           ComparisonOperator lowerOperator,
                                           List<Object> upper,
                                           ComparisonOperator upperOperator)

Range query records by primary key in a tablespace. For single key the list size should be one, for composite key the size will be more than one.

参数:

lower - if rangeQuery is true, then this is the lower bound

lowerOperator - if rangeQuery is true, then this is the comparison operator for lower

upper - if rangeQuery is true, then this is the upper bound

upperOperator - if rangeQuery is true, then this is the comparison operator for upper

返回:

list of records

rangeQueryByPrimaryKey

List<GenericRecord> rangeQueryByPrimaryKey(List<Object> lower,
                                           ComparisonOperator lowerOperator,
                                           List<Object> upper,
                                           ComparisonOperator upperOperator,
                                           java.util.function.Predicate<GenericRecord> recordPredicate)

Range query records by primary key in a tablespace with a filter. For single key the list size should be one, for composite key the size will be more than one.

参数:

lower - if rangeQuery is true, then this is the lower bound

lowerOperator - if rangeQuery is true, then this is the comparison operator for lower

upper - if rangeQuery is true, then this is the upper bound

upperOperator - if rangeQuery is true, then this is the comparison operator for upper

recordPredicate - optional filtering, if predicate returns true upon record, then it will be added to result set

返回:

list of records

rangeQueryByPrimaryKey

List<GenericRecord> rangeQueryByPrimaryKey(List<Object> lower,
                                           ComparisonOperator lowerOperator,
                                           List<Object> upper,
                                           ComparisonOperator upperOperator,
                                           List<String> projection)

Range query records by primary key in a tablespace with a filter. For single key the list size should be one, for composite key the size will be more than one.

参数:

lower - if rangeQuery is true, then this is the lower bound

lowerOperator - if rangeQuery is true, then this is the comparison operator for lower

upper - if rangeQuery is true, then this is the upper bound

upperOperator - if rangeQuery is true, then this is the comparison operator for upper

projection - projection of selected column names

返回:

list of records

rangeQueryByPrimaryKey

List<GenericRecord> rangeQueryByPrimaryKey(List<Object> lower,
                                           ComparisonOperator lowerOperator,
                                           List<Object> upper,
                                           ComparisonOperator upperOperator,
                                           java.util.function.Predicate<GenericRecord> recordPredicate,
                                           List<String> projection)

Range query records by primary key in a tablespace with a filter. For single key the list size should be one, for composite key the size will be more than one.

参数:

lower - if rangeQuery is true, then this is the lower bound

lowerOperator - if rangeQuery is true, then this is the comparison operator for lower

upper - if rangeQuery is true, then this is the upper bound

upperOperator - if rangeQuery is true, then this is the comparison operator for upper

recordPredicate - optional filtering, if predicate returns true upon record, then it will be added to result set

projection - projection of selected column names

返回:

list of records

getQueryAllIterator

Iterator<GenericRecord> getQueryAllIterator()

Return an iterator to query all records of a tablespace.

This is friendly to memory since only one page is loaded per batch.

返回:

record iterator

getQueryAllIterator

Iterator<GenericRecord> getQueryAllIterator(List<String> projection)

Return an iterator to query all records of a tablespace.

This is friendly to memory since only one page is loaded per batch.

参数:

projection - projection of selected column names

返回:

record iterator

getQueryAllIterator

Iterator<GenericRecord> getQueryAllIterator(boolean ascOrder)

Return an iterator to query all records of a tablespace.

This is friendly to memory since only one page is loaded per batch.

参数:

ascOrder - if set result records in ascending order

返回:

record iterator

getQueryAllIterator

Iterator<GenericRecord> getQueryAllIterator(List<String> projection,
                                            boolean ascOrder)

Return an iterator to query all records of a tablespace.

This is friendly to memory since only one page is loaded per batch.

参数:

projection - projection of selected column names

ascOrder - if set result records in ascending order

返回:

record iterator

getRangeQueryIterator

Iterator<GenericRecord> getRangeQueryIterator(List<Object> lower,
                                              ComparisonOperator lowerOperator,
                                              List<Object> upper,
                                              ComparisonOperator upperOperator)

Return an iterator to do range query records by primary key in a tablespace.

This is friendly to memory since only one page is loaded per batch.

For single key the list size should be one, for composite key the size will be more than one.

参数:

lower - if rangeQuery is true, then this is the lower bound

lowerOperator - if rangeQuery is true, then this is the comparison operator for lower

upper - if rangeQuery is true, then this is the upper bound

upperOperator - if rangeQuery is true, then this is the comparison operator for upper

返回:

record iterator

getRangeQueryIterator

Iterator<GenericRecord> getRangeQueryIterator(List<Object> lower,
                                              ComparisonOperator lowerOperator,
                                              List<Object> upper,
                                              ComparisonOperator upperOperator,
                                              List<String> projection)

Return an iterator to do range query records by primary key in a tablespace.

This is friendly to memory since only one page is loaded per batch.

For single key the list size should be one, for composite key the size will be more than one.

参数:

lower - if rangeQuery is true, then this is the lower bound

lowerOperator - if rangeQuery is true, then this is the comparison operator for lower

upper - if rangeQuery is true, then this is the upper bound

upperOperator - if rangeQuery is true, then this is the comparison operator for upper

projection - projection of selected column names

返回:

record iterator

getRangeQueryIterator

Iterator<GenericRecord> getRangeQueryIterator(List<Object> lower,
                                              ComparisonOperator lowerOperator,
                                              List<Object> upper,
                                              ComparisonOperator upperOperator,
                                              boolean ascOrder)

Return an iterator to do range query records by primary key in a tablespace.

This is friendly to memory since only one page is loaded per batch.

For single key the list size should be one, for composite key the size will be more than one.

参数:

lower - if rangeQuery is true, then this is the lower bound

lowerOperator - if rangeQuery is true, then this is the comparison operator for lower

upper - if rangeQuery is true, then this is the upper bound

upperOperator - if rangeQuery is true, then this is the comparison operator for upper

ascOrder - if set result records in ascending order

返回:

record iterator

getRangeQueryIterator

Iterator<GenericRecord> getRangeQueryIterator(List<Object> lower,
                                              ComparisonOperator lowerOperator,
                                              List<Object> upper,
                                              ComparisonOperator upperOperator,
                                              List<String> projection,
                                              boolean ascOrder)

Return an iterator to do range query records by primary key in a tablespace.

This is friendly to memory since only one page is loaded per batch.

For single key the list size should be one, for composite key the size will be more than one.

参数:

lower - if rangeQuery is true, then this is the lower bound

lowerOperator - if rangeQuery is true, then this is the comparison operator for lower

upper - if rangeQuery is true, then this is the upper bound

upperOperator - if rangeQuery is true, then this is the comparison operator for upper

projection - projection of selected column names

ascOrder - if set result records in ascending order

返回:

record iterator

getRecordIteratorBySk

Iterator<GenericRecord> getRecordIteratorBySk(String skName,
                                              List<Object> lower,
                                              ComparisonOperator lowerOperator,
                                              List<Object> upper,
                                              ComparisonOperator upperOperator)

Return record iterator by secondary key (SK) in a tablespace. This is first go through all secondary keys and look up record back to clustered index.

This is friendly to memory since only one page is loaded per batch.

For single key the lower or upper list size should be one, for composite key the size will be more than one.

参数:

skName - secondary key name in SHOW CREATE TABLE command

lower - lower bound

lowerOperator - comparison operator for lower

upper - upper bound

upperOperator - comparison operator for upper

返回:

record iterator, record is composed by secondary key columns and primary key columns

getRecordIteratorBySk

Iterator<GenericRecord> getRecordIteratorBySk(String skName,
                                              List<Object> lower,
                                              ComparisonOperator lowerOperator,
                                              List<Object> upper,
                                              ComparisonOperator upperOperator,
                                              List<String> projection)

Return record iterator by secondary key (SK) in a tablespace. This is first go through all secondary keys and look up record back to clustered index.

This is friendly to memory since only one page is loaded per batch.

For single key the lower or upper list size should be one, for composite key the size will be more than one.

参数:

skName - secondary key name in SHOW CREATE TABLE command

lower - lower bound

lowerOperator - comparison operator for lower

upper - upper bound

upperOperator - comparison operator for upper

projection - projection of selected column names

返回:

record iterator, record is composed by secondary key columns and primary key columns

getRecordIteratorBySk

Iterator<GenericRecord> getRecordIteratorBySk(String skName,
                                              List<Object> lower,
                                              ComparisonOperator lowerOperator,
                                              List<Object> upper,
                                              ComparisonOperator upperOperator,
                                              boolean ascOrder)

Return record iterator by secondary key (SK) in a tablespace. This is first go through all secondary keys and look up record back to clustered index.

This is friendly to memory since only one page is loaded per batch.

For single key the lower or upper list size should be one, for composite key the size will be more than one.

参数:

skName - secondary key name in SHOW CREATE TABLE command

lower - lower bound

lowerOperator - comparison operator for lower

upper - upper bound

upperOperator - comparison operator for upper

ascOrder - if set result records in ascending order

返回:

record iterator, record is composed by secondary key columns and primary key columns

getRecordIteratorBySk

Iterator<GenericRecord> getRecordIteratorBySk(String skName,
                                              List<Object> lower,
                                              ComparisonOperator lowerOperator,
                                              List<Object> upper,
                                              ComparisonOperator upperOperator,
                                              List<String> projection,
                                              boolean ascOrder)

Return record iterator by secondary key (SK) in a tablespace. This is first go through all secondary keys and look up record back to clustered index.

This is friendly to memory since only one page is loaded per batch.

For single key the lower or upper list size should be one, for composite key the size will be more than one.

参数:

skName - secondary key name in SHOW CREATE TABLE command

lower - lower bound

lowerOperator - comparison operator for lower

upper - upper bound

upperOperator - comparison operator for upper

projection - projection of selected column names

ascOrder - if set result records in ascending order

返回:

record iterator, record is composed by secondary key columns and primary key columns

getTableDef

TableDef getTableDef()

Return table definition.

返回:

table definition

close

void close()

Close.

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 Closeable