com.alibaba.innodb.java.reader.service

接口 IndexService

所有已知实现类:

IndexServiceImpl

public interface IndexService

Innodb index page service, providing read-only query operations.

作者:

xu.zx

字段概要

字段

限定符和类型	字段和说明
static BitSet	NOP_PROJECTION Special projection indicating no projection is needed, all fields will be included.

方法概要

限定符和类型	方法和说明
Iterator<GenericRecord>	getQueryAllIterator(Optional<List<String>> recordProjection, boolean ascOrder) Return an iterator to query all records of a tablespace.
Iterator<GenericRecord>	getQueryIteratorBySk(String skName, List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, Optional<List<String>> recordProjection, boolean ascOrder) Return record iterator by secondary key (SK) in a tablespace.
Iterator<GenericRecord>	getRangeQueryIterator(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, Optional<List<String>> recordProjection, boolean ascOrder) Return an iterator to do range query by primary key in a tablespace.
Index	loadIndexPage(long pageNumber) Load index page by page number.
List<GenericRecord>	queryAll(Optional<java.util.function.Predicate<GenericRecord>> recordPredicate, Optional<List<String>> recordProjection) Query all records in a tablespace.
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, Optional<List<String>> recordProjection) Query record by primary key in a tablespace with projection list.
List<GenericRecord>	rangeQueryByPrimaryKey(List<Object> lower, ComparisonOperator lowerOperator, List<Object> upper, ComparisonOperator upperOperator, Optional<java.util.function.Predicate<GenericRecord>> recordPredicate, Optional<List<String>> recordProjection) Range query records by primary key in a tablespace with a filter and projection.

字段详细资料

NOP_PROJECTION

static final BitSet NOP_PROJECTION

Special projection indicating no projection is needed, all fields will be included.

方法详细资料

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

queryAll

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

Query all records in a tablespace.

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

recordProjection - optional projection of selected column names, if no present, all fields will be included

返回:

all records

queryByPrimaryKey

GenericRecord queryByPrimaryKey(List<Object> key,
                                Optional<List<String>> recordProjection)

Query record by primary key in a tablespace with projection list.

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

参数:

key - key list of primary key, single key or a composite key

recordProjection - optional projection of selected column names, if no present, all fields will be included

返回:

record

rangeQueryByPrimaryKey

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

Range query records by primary key in a tablespace with a filter and projection.

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

参数:

lower - lower bound

lowerOperator - comparison operator for lower

upper - upper bound

upperOperator - comparison operator for upper

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

recordProjection - optional projection of selected column names, if no present, all fields will be included

返回:

list of records

getQueryAllIterator

Iterator<GenericRecord> getQueryAllIterator(Optional<List<String>> recordProjection,
                                            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.

参数:

recordProjection - optional projection of selected column names, if no present, all fields will be included

ascOrder - if set result records in ascending order

返回:

record iterator

getRangeQueryIterator

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

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

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.

参数:

lower - lower bound

lowerOperator - comparison operator for lower

upper - upper bound

upperOperator - comparison operator for upper

recordProjection - optional projection of selected column names, if no present, all fields will be included

ascOrder - if set result records in ascending order

返回:

record iterator

getQueryIteratorBySk

Iterator<GenericRecord> getQueryIteratorBySk(String skName,
                                             List<Object> lower,
                                             ComparisonOperator lowerOperator,
                                             List<Object> upper,
                                             ComparisonOperator upperOperator,
                                             Optional<List<String>> recordProjection,
                                             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

recordProjection - optional projection of selected column names, if no present, all fields will be included

ascOrder - if set result records in ascending order

返回:

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

loadIndexPage

Index loadIndexPage(long pageNumber)

Load index page by page number.

参数:

pageNumber - page number

返回:

index page