Module bus.pager

Interface BoundSqlBuilder


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 Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Represents a chain of BoundSqlBuilder processors.
    static enum 
    Enumerates the types of SQL operations that can be processed by the BoundSqlBuilder.
  • Method Summary

    Modifier and Type
    Method
    Description
    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 the BoundSql for 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 the BoundSql for 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 operation
      cacheKey - the CacheKey associated with the current query
      chain - the processor chain, allowing continuation to subsequent processors or termination by returning the modified BoundSql
      Returns:
      the modified BoundSql object