Skip to main content

3. Builder API

General usage: 5.3 Builder API. Status links explain differences for each data source.

Data sourceData WritesWrite ConflictsQueryMap Query ModePaginationWhere BuilderPredicate ValuesGroup ByOrder By
MySQL✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
PostgreSQL✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
Oracle✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
SQL Server✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
DB2✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
H2✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
ClickHouse◐ Partial✕ Unsupported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
Redis✕ Unsupported✕ Unsupported✕ Unsupported✕ Unsupported✕ Unsupported✕ Unsupported✕ Unsupported✕ Unsupported✕ Unsupported
MongoDB✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported◐ Partial
ES 6✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
ES 7✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported✓ Supported
Milvus◐ Partial◐ Partial◐ Partial✓ Supported✓ Supported◐ Partial◐ Partial✕ Unsupported✕ Unsupported
  • Data Writes: inserts, updates, and deletes, including multiple operations, empty-condition protection, affected counts, and readback.
  • Write Conflicts: default inserts, Ignore, and Update strategies.
  • Query: field selection, entity and Map results, scalars, calculated columns, counts, and distinct queries.
  • Map Query Mode: mapped Map uses Java property names; freedom Map uses database column names. Both include reads and writes.
  • Pagination: pages, totals, navigation, and iteration in pages.
  • Where Builder: comparisons, ranges, collections, LIKE, NULL, empty strings, and condition groups.
  • Predicate Values: value binding in condition methods and apply, including special characters and boundary values.
  • Group By: grouped queries and aggregate results.
  • Order By: ascending and descending order, multi-column priority, and null ordering.