BaseMapper Interface

The generic BaseMapper interface provides a set of common database operations that work with mapping metadata to perform database actions. Using the base mapper keeps your data-access layer concise.

Highlights

After defining Object Mapping, you can perform database operations with the BaseMapper Interface.

1. Entity
@Table("users")
public class User {
    @Column(name = "id", primary = true, keyType = KeyTypeEnum.Auto)
    private Long id;
    @Column("name")
    private String name;
    ...
}

2. Operate
// Insert one row
User user = ...
int result = mapper.insert(user);

// Insert multiple rows
User user1 = ...
User user2 = ...
int result = mapper.insert(Arrays.asList(user1, user2));

// Update by object ID
User user = ...
int result = mapper.update(user);

// Delete by object ID
int result = mapper.delete(1);

// Query by example
User sample = ...
List<User> result = mapper.listBySample(sample);

// Paginated query by example
User sample = ...
Page pageInfo = PageObject.of(0, 20);   // Page 0, 20 rows per page, page index starts at 0
// or pageInfo = PageObject.of(1, 20, 1); // Page 1, 20 rows per page, page index starts at 1
PageResult<User> result = mapper.pageBySample(sample, pageInfo);

details