Skip to main content

4. Mapper Files

General usage: 5.4 Mapper Files. Status links explain differences for each data source.Shared parameter capabilities are listed under Parameters and Rules.

Data sourceCommand ExecutionExecution OptionsKey StrategiesStored Procedure Callssql tagDynamic SQLMapping Result SetsPaging QueriesCall File Mapper
MySQL✓ Supported✓ Supported◐ Partial◐ Partial✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
PostgreSQL✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
Oracle✓ Supported✓ Supported◐ Partial✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
SQL Server✓ Supported✓ Supported✓ Supported◐ Partial✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
DB2✓ Supported✓ Supported✓ Supported◐ Partial✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
H2✓ Supported✓ Supported✓ Supported✕ Unsupported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
ClickHouse✓ Supported✓ Supported◐ Partial✕ Unsupported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
Redis✓ Supported◐ Partial◐ Partial✕ Unsupported✓ Supported◐ Partial◐ Partial✕ Unsupported◐ Partial
MongoDB✓ Supported◐ Partial◐ Partial✕ Unsupported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
ES 6✓ Supported◐ Partial◐ Partial✕ Unsupported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
ES 7✓ Supported◐ Partial◐ Partial✕ Unsupported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
Milvus◐ Partial◐ Partial◐ Partial✕ Unsupported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
  • Command Execution: load files, resolve statements, and execute native commands, including repeated calls and no-match results.
  • Execution Options: statementType, fetchSize, timeout, resultSetType, and scrollable results.
  • Key Strategies: assigned keys, generated keys, and values filled through selectKey.
  • Stored Procedure Calls: input, output, INOUT, and cursor parameters.
  • sql tag: reuse command fragments through <sql> and <include>.
  • Dynamic SQL: generate commands using conditional and loop tags.
  • Mapping Result Sets: use resultType and resultMap for entities, maps, and scalars. Custom receiving interfaces are covered under Receiving Results.
  • Paging Queries: retrieve page data and totals.
  • Call File Mapper: a Java interface uses @RefMapper to call file commands, dynamic content, and result mappings.