Call File Mapper

You can execute SQL located in Mapper files through the executeStatement and queryStatement methods of the BaseMapper interface.

Tip

How to obtain a Session depends on your project architecture. See Framework Integration for details.

For example: Mapper file is as follows
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//dbvisitor.net//DTD Mapper 1.0//EN"
        "https://www.dbvisitor.net/schema/dbvisitor-mapper.dtd">
<mapper namespace="user">
    <select id="listUsers" resultMap="user_resultMap">
        select * from users
    </select>
</mapper>

Execute via BaseMapper
BaseMapper<User> mapper = session.createBaseMapper(User.class);
// "user.listUsers": user is the namespace, listUsers is the statement Id
List<User> users = mapper.queryStatement("user.listUsers", null);

Execute via Session (same effect, but different exception types)
List<User> users = session.queryStatement("user.listUsers", null);

For detailed configuration of File Mapper, please refer to:

Please refer to File Mapper for details.

Pagination Query

Perform pagination queries by passing the Page parameter. Both BaseMapper and Session support queryStatement with pagination.

Pagination Query (returns List)
PageObject page = new PageObject();
page.setPageSize(20);

// Via BaseMapper
BaseMapper<User> mapper = session.createBaseMapper(User.class);
List<User> users = mapper.queryStatement("user.listUsers", null, page);

Pagination Query (returns PageResult, Session only)
PageObject page = new PageObject();
page.setPageSize(20);

PageResult<User> users = session.pageStatement("user.listUsers", null, page);

PageResult pagination results will also contain Original Pagination Info, Total Records, Total Pages.

Pagination Query​

Pagination Query