com.alibaba.innodb.java.reader

类 TableReaderImpl

java.lang.Object

com.alibaba.innodb.java.reader.TableReaderImpl

所有已实现的接口:

TableReader, Closeable, AutoCloseable

public class TableReaderImpl
extends Object
implements TableReader

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

作者:

xu.zx

构造器概要

构造器

构造器和说明
TableReaderImpl(String ibdFilePath, String createTableSql)
TableReaderImpl(String ibdFilePath, String createTableSql, KeyComparator keyComparator)
TableReaderImpl(String ibdFilePath, TableDef tableDef)
TableReaderImpl(String ibdFilePath, TableDef tableDef, KeyComparator keyComparator)

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

TableReaderImpl

public TableReaderImpl(String ibdFilePath,
                       String createTableSql)

TableReaderImpl

public TableReaderImpl(String ibdFilePath,
                       String createTableSql,
                       KeyComparator keyComparator)

TableReaderImpl

public TableReaderImpl(String ibdFilePath,
                       TableDef tableDef)

TableReaderImpl

public TableReaderImpl(String ibdFilePath,
                       TableDef tableDef,
                       KeyComparator keyComparator)

方法详细资料

open

public void open()

从接口复制的说明: TableReader

Open table.

指定者:

open 在接口中 TableReader

getNumOfPages

public long getNumOfPages()

从接口复制的说明: TableReader

Return total page count.

指定者:

getNumOfPages 在接口中 TableReader

返回:

number of pages.

readAllPages

public List<AbstractPage> readAllPages()

从接口复制的说明: TableReader

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

指定者:

readAllPages 在接口中 TableReader

返回:

list of AbstractPage

getPageIterator

public Iterator<AbstractPage> getPageIterator()

从接口复制的说明: TableReader

Get page iterator.

指定者:

getPageIterator 在接口中 TableReader

返回:

Iterator of AbstractPage

readAllPageHeaders

public List<FilHeader> readAllPageHeaders()

从接口复制的说明: TableReader

Read all page headers into memory.

指定者:

readAllPageHeaders 在接口中 TableReader

返回:

list of FilHeader

readPage

public AbstractPage readPage(long pageNumber)

从接口复制的说明: TableReader

Read one page as AbstractPage.

指定者:

readPage 在接口中 TableReader

参数:

pageNumber - page number

返回:

AbstractPage

getAllIndexPageFillingRate

public double getAllIndexPageFillingRate()

从接口复制的说明: TableReader

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

指定者:

getAllIndexPageFillingRate 在接口中 TableReader

返回:

filling rate

getIndexPageFillingRate

public double getIndexPageFillingRate(int pageNumber)

从接口复制的说明: TableReader

Get single index page filling rate.

指定者:

getIndexPageFillingRate 在接口中 TableReader

参数:

pageNumber - page number

返回:

filling rate

queryByPageNumber

public List<GenericRecord> queryByPageNumber(int pageNumber)

从接口复制的说明: TableReader

Query all records by single index page.

指定者:

queryByPageNumber 在接口中 TableReader

参数:

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

返回:

list of records

queryByPageNumber

public List<GenericRecord> queryByPageNumber(long pageNumber)

从接口复制的说明: TableReader

Query all records by single index page.

指定者:

queryByPageNumber 在接口中 TableReader

参数:

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

返回:

list of records

queryByPrimaryKey

public GenericRecord queryByPrimaryKey(List<Object> key)

从接口复制的说明: TableReader

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.

指定者:

queryByPrimaryKey 在接口中 TableReader

参数:

key - primary key, single key or a composite key

返回:

record

queryByPrimaryKey

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

从接口复制的说明: TableReader

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.

指定者:

queryByPrimaryKey 在接口中 TableReader

参数:

key - primary key, single key or a composite key

projection - projection of selected column names

返回:

record

queryAll

public List<GenericRecord> queryAll()

从接口复制的说明: TableReader

Query all records in a tablespace.

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

指定者:

queryAll 在接口中 TableReader

返回:

all records

queryAll

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

从接口复制的说明: TableReader

Query all records in a tablespace with a filter.

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

指定者:

queryAll 在接口中 TableReader

参数:

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

返回:

all records

queryAll

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

从接口复制的说明: TableReader

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.

指定者:

queryAll 在接口中 TableReader

参数:

projection - projection of selected column names

返回:

all records

queryAll

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

从接口复制的说明: TableReader

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.

指定者:

queryAll 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

rangeQueryByPrimaryKey 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

rangeQueryByPrimaryKey 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

rangeQueryByPrimaryKey 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

rangeQueryByPrimaryKey 在接口中 TableReader

参数:

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

public Iterator<GenericRecord> getQueryAllIterator()

从接口复制的说明: TableReader

Return an iterator to query all records of a tablespace.

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

指定者:

getQueryAllIterator 在接口中 TableReader

返回:

record iterator

getQueryAllIterator

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

从接口复制的说明: TableReader

Return an iterator to query all records of a tablespace.

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

指定者:

getQueryAllIterator 在接口中 TableReader

参数:

projection - projection of selected column names

返回:

record iterator

getQueryAllIterator

public Iterator<GenericRecord> getQueryAllIterator(boolean ascOrder)

从接口复制的说明: TableReader

Return an iterator to query all records of a tablespace.

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

指定者:

getQueryAllIterator 在接口中 TableReader

参数:

ascOrder - if set result records in ascending order

返回:

record iterator

getQueryAllIterator

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

从接口复制的说明: TableReader

Return an iterator to query all records of a tablespace.

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

指定者:

getQueryAllIterator 在接口中 TableReader

参数:

projection - projection of selected column names

ascOrder - if set result records in ascending order

返回:

record iterator

getRangeQueryIterator

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

从接口复制的说明: TableReader

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.

指定者:

getRangeQueryIterator 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

getRangeQueryIterator 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

getRangeQueryIterator 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

getRangeQueryIterator 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

getRecordIteratorBySk 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

getRecordIteratorBySk 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

getRecordIteratorBySk 在接口中 TableReader

参数:

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

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

从接口复制的说明: TableReader

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.

指定者:

getRecordIteratorBySk 在接口中 TableReader

参数:

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

public TableDef getTableDef()

从接口复制的说明: TableReader

Return table definition.

指定者:

getTableDef 在接口中 TableReader

返回:

table definition

close

public void close()

从接口复制的说明: TableReader

Close.

指定者:

close 在接口中 TableReader

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable