public interface BoundSqlBuilder
Interface for processing
BoundSql objects within the pagination plugin. Implementations of this interface can
modify the BoundSql at different stages of query processing.- Since:
- Java 17+
- Author:
- Kimi Liu
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceRepresents a chain ofBoundSqlBuilderprocessors.static enumEnumerates the types of SQL operations that can be processed by theBoundSqlBuilder. -
Method Summary
Modifier and TypeMethodDescriptionorg.apache.ibatis.mapping.BoundSqlboundSql(BoundSqlBuilder.Type type, org.apache.ibatis.mapping.BoundSql boundSql, org.apache.ibatis.cache.CacheKey cacheKey, BoundSqlBuilder.Chain chain) Processes theBoundSqlfor a specific type of SQL operation.
-
Method Details
-
boundSql
org.apache.ibatis.mapping.BoundSql boundSql(BoundSqlBuilder.Type type, org.apache.ibatis.mapping.BoundSql boundSql, org.apache.ibatis.cache.CacheKey cacheKey, BoundSqlBuilder.Chain chain) Processes theBoundSqlfor a specific type of SQL operation.- Parameters:
type- the type of SQL operation (e.g., ORIGINAL, COUNT_SQL, PAGE_SQL)boundSql- the BoundSql object for the current operationcacheKey- the CacheKey associated with the current querychain- the processor chain, allowing continuation to subsequent processors or termination by returning the modified BoundSql- Returns:
- the modified BoundSql object
-