com.mybatisflex.core.row

接口 RowMapper

public interface RowMapper

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_BATCH_SIZE

方法概要

限定符和类型	方法和说明
int	deleteBatchByIds(String schema, String tableName, String primaryKey, Collection<?> ids) 根据 多个 id 值删除多条数据
default int	deleteById(String schema, String tableName, Row row) 根据 id 删除数据
int	deleteById(String schema, String tableName, String primaryKey, Object id) 根据 id 删除数据
int	deleteByQuery(String schema, String tableName, QueryWrapper queryWrapper) 根据 queryWrapper 构建 where 条件来删除数据
int	deleteBySql(String sql, Object... args) 执行 delete sql 语言
int	insert(String schema, String tableName, Row row) 插入 row 到数据表
int	insertBatchWithFirstRowColumns(String schema, String tableName, List<Row> rows) 批量插入 rows 到数据表 注意，批量插入中，只会根据第一条 row 数据来构建 Sql 插入字段，若每条数据字段不一致，可能造成个别字段无法插入的情况
int	insertBySql(String sql, Object... args) 执行 insert sql 语句
default Page<Row>	paginate(String schema, String tableName, Page<Row> page, QueryWrapper queryWrapper) 分页查询数据
default List<Row>	selectAll(String schema, String tableName) 查询某张表的全部数据
default long	selectCount(String sql, Object... args) 查询数据，一般用于 select count(*)...
default long	selectCountByQuery(String schema, String tableName, QueryWrapper queryWrapper) 查询数据量
Map	selectFirstAndSecondColumnsAsMap(String sql, Object... args)
Map	selectFirstAndSecondColumnsAsMapByQuery(String schema, String tableName, QueryWrapper queryWrapper)
List<Row>	selectListByQuery(String schema, String tableName, QueryWrapper queryWrapper) 根据 queryWrapper 来查询一个 row 列表
List<Row>	selectListBySql(String sql, Object... args) 通过自定义 sql 来查询一个 Row 列表
Object	selectObject(String sql, Object... args) 通过 sql 查询某一个数据，sql 执行的结果应该只有 1 行 1 列 若返回有多列，则只取第一列的值，若有多行，则会出现 TooManyResultsException 错误
default Object	selectObjectByQuery(String schema, String tableName, QueryWrapper queryWrapper) 根据 queryWrapper 1 条数据 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...
List<Object>	selectObjectList(String sql, Object... args) 通过 sql 查询多行数据，sql 执行的结果应该只有 1 列
List<Object>	selectObjectListByQuery(String schema, String tableName, QueryWrapper queryWrapper) 根据 queryWrapper 来查询数据列表 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...
default Row	selectOneById(String schema, String tableName, Row row) 通过主键来查询数据
Row	selectOneById(String schema, String tableName, String primaryKey, Object id) 根据主键来查询数据
default Row	selectOneByQuery(String schema, String tableName, QueryWrapper queryWrapper) 根据 queryWrapper 来查询 1 条数据
default Row	selectOneBySql(String sql, Object... args) 通过原生 SQL 查询 1 条数据，要求数据必须返回 1 条内容，否则会报错
int	updateBatchById(String schema, String tableName, List<Row> rows) 根据主键来批量更新数据 注意： 1、此方法需要在 mysql 等链接配置需要开启 allowMultiQueries=true 2、更新成功返回的结果也可能为 0
int	updateById(String schema, String tableName, Row row) 根据主键来更新数据
int	updateByQuery(String schema, String tableName, Row data, QueryWrapper queryWrapper) 根据 queryWrapper 来构建 where 条件更新数据
int	updateBySql(String sql, Object... args) 执行 update sql 语句
int	updateEntity(Object entity) 更新 entity，主要用于进行批量更新的场景

字段详细资料

DEFAULT_BATCH_SIZE

static final int DEFAULT_BATCH_SIZE

另请参阅:

常量字段值

方法详细资料

insert

@InsertProvider(value=RowSqlProvider.class,
                method="insert")
int insert(@Param(value="$$schemaName")
                                                                                        String schema,
                                                                                        @Param(value="$$tableName")
                                                                                        String tableName,
                                                                                        @Param(value="$$row")
                                                                                        Row row)

插入 row 到数据表

参数:

tableName - 表名

row - 数据内容，当设置有主键时，主键会自动填充

返回:

执行影响的行数

另请参阅:

RowSqlProvider.insert(Map)

insertBySql

@InsertProvider(value=RowSqlProvider.class,
                method="providerRawSql")
int insertBySql(@Param(value="$$sql")
                                                                                                     String sql,
                                                                                                     @Param(value="$$sql_args")
                                                                                                     Object... args)

执行 insert sql 语句

参数:

sql - insert sql 语句

args - 参数

返回:

执行影响的行数

另请参阅:

Db.insertBySql(String, Object...), RowSqlProvider.providerRawSql(Map)

insertBatchWithFirstRowColumns

@InsertProvider(value=RowSqlProvider.class,
                method="insertBatchWithFirstRowColumns")
int insertBatchWithFirstRowColumns(@Param(value="$$schemaName")
                                                                                                                                        String schema,
                                                                                                                                        @Param(value="$$tableName")
                                                                                                                                        String tableName,
                                                                                                                                        @Param(value="$$rows")
                                                                                                                                        List<Row> rows)

批量插入 rows 到数据表

注意，批量插入中，只会根据第一条 row 数据来构建 Sql 插入字段，若每条数据字段不一致，可能造成个别字段无法插入的情况

参数:

tableName - 表名

rows - 数据内容，当设置有主键时，主键会自动填充

返回:

执行影响的行数

另请参阅:

RowSqlProvider.insertBatchWithFirstRowColumns(Map)

deleteBySql

@DeleteProvider(value=RowSqlProvider.class,
                method="providerRawSql")
int deleteBySql(@Param(value="$$sql")
                                                                                                     String sql,
                                                                                                     @Param(value="$$sql_args")
                                                                                                     Object... args)

执行 delete sql 语言

参数:

sql - delete sql 语句

args - 参数

返回:

执行影响的行数

另请参阅:

RowSqlProvider.providerRawSql(Map)

deleteById

default int deleteById(String schema,
                       String tableName,
                       Row row)

根据 id 删除数据

参数:

schema - 模式

tableName - 表名

row - id 和 值的数据，可以通过 Row.ofKey(String, Object) 来创建

返回:

执行影响的行数

deleteById

@DeleteProvider(value=RowSqlProvider.class,
                method="deleteById")
int deleteById(@Param(value="$$schemaName")
                                                                                                String schema,
                                                                                                @Param(value="$$tableName")
                                                                                                String tableName,
                                                                                                @Param(value="$$primaryKey")
                                                                                                String primaryKey,
                                                                                                @Param(value="$$primaryValue")
                                                                                                Object id)

根据 id 删除数据

参数:

schema - 模式

tableName - 表名

primaryKey - 主键，多个主键用英文逗号隔开

id - 数据，多个主键时传入数组，例如 new Object[]{1,2}

返回:

执行影响的行数

另请参阅:

RowSqlProvider.deleteById(Map)

deleteBatchByIds

@DeleteProvider(value=RowSqlProvider.class,
                method="deleteBatchByIds")
int deleteBatchByIds(@Param(value="$$schemaName")
                                                                                                            String schema,
                                                                                                            @Param(value="$$tableName")
                                                                                                            String tableName,
                                                                                                            @Param(value="$$primaryKey")
                                                                                                            String primaryKey,
                                                                                                            @Param(value="$$primaryValue")
                                                                                                            Collection<?> ids)

根据 多个 id 值删除多条数据

参数:

schema - 模式

tableName - 表名

primaryKey - 主键

ids - id 的集合

返回:

执行影响的行数

另请参阅:

RowSqlProvider.deleteBatchByIds(Map)

deleteByQuery

@DeleteProvider(value=RowSqlProvider.class,
                method="deleteByQuery")
int deleteByQuery(@Param(value="$$schemaName")
                                                                                                      String schema,
                                                                                                      @Param(value="$$tableName")
                                                                                                      String tableName,
                                                                                                      @Param(value="$$query")
                                                                                                      QueryWrapper queryWrapper)

根据 queryWrapper 构建 where 条件来删除数据

参数:

schema - 模式

tableName - 表名

queryWrapper - queryWrapper

返回:

执行影响的行数

另请参阅:

RowSqlProvider.deleteByQuery(Map)

updateBySql

@UpdateProvider(value=RowSqlProvider.class,
                method="providerRawSql")
int updateBySql(@Param(value="$$sql")
                                                                                                     String sql,
                                                                                                     @Param(value="$$sql_args")
                                                                                                     Object... args)

执行 update sql 语句

参数:

sql - sql 语句

args - 参数内容

返回:

执行影响的行数

另请参阅:

RowSqlProvider.providerRawSql(Map)

updateById

@UpdateProvider(value=RowSqlProvider.class,
                method="updateById")
int updateById(@Param(value="$$schemaName")
                                                                                                String schema,
                                                                                                @Param(value="$$tableName")
                                                                                                String tableName,
                                                                                                @Param(value="$$row")
                                                                                                Row row)

根据主键来更新数据

参数:

schema - 模式

tableName - 表名

row - 数据，其必须包含主键数据列名和值

返回:

执行影响的行数

另请参阅:

RowSqlProvider.updateById(Map)

updateByQuery

@UpdateProvider(value=RowSqlProvider.class,
                method="updateByQuery")
int updateByQuery(@Param(value="$$schemaName")
                                                                                                      String schema,
                                                                                                      @Param(value="$$tableName")
                                                                                                      String tableName,
                                                                                                      @Param(value="$$row")
                                                                                                      Row data,
                                                                                                      @Param(value="$$query")
                                                                                                      QueryWrapper queryWrapper)

根据 queryWrapper 来构建 where 条件更新数据

参数:

schema - 模式

tableName - 表名

data - 更新数据

queryWrapper - queryWrapper

返回:

执行影响的行数

另请参阅:

RowSqlProvider.updateByQuery(Map)

updateBatchById

@UpdateProvider(value=RowSqlProvider.class,
                method="updateBatchById")
int updateBatchById(@Param(value="$$schemaName")
                                                                                                          String schema,
                                                                                                          @Param(value="$$tableName")
                                                                                                          String tableName,
                                                                                                          @Param(value="$$rows")
                                                                                                          List<Row> rows)

根据主键来批量更新数据 注意： 1、此方法需要在 mysql 等链接配置需要开启 allowMultiQueries=true 2、更新成功返回的结果也可能为 0

参数:

schema - 模式

tableName - 表名

rows - 数据，其必须包含主键数据列名和值

返回:

执行影响的行数

另请参阅:

RowSqlProvider.updateBatchById(Map)

updateEntity

@UpdateProvider(value=RowSqlProvider.class,
                method="updateEntity")
int updateEntity(@Param(value="$$entity")
                                                                                                    Object entity)

更新 entity，主要用于进行批量更新的场景

参数:

entity - 实体类

另请参阅:

RowSqlProvider.updateEntity(Map), Db.updateEntitiesBatch(Collection, int)

selectOneBySql

default Row selectOneBySql(String sql,
                           Object... args)

通过原生 SQL 查询 1 条数据，要求数据必须返回 1 条内容，否则会报错

参数:

sql - select sql 语句

args - 参数

返回:

返回一条数据

selectOneById

default Row selectOneById(String schema,
                          String tableName,
                          Row row)

通过主键来查询数据

参数:

schema - 模式

tableName - 表名

row - 主键和ID的描述，通过 Row.ofKey(String, Object) 来进行构建

返回:

返回一条数据，或者 null

selectOneById

@SelectProvider(value=RowSqlProvider.class,
                method="selectOneById")
Row selectOneById(@Param(value="$$schemaName")
                                                                                                      String schema,
                                                                                                      @Param(value="$$tableName")
                                                                                                      String tableName,
                                                                                                      @Param(value="$$primaryKey")
                                                                                                      String primaryKey,
                                                                                                      @Param(value="$$primaryValue")
                                                                                                      Object id)

根据主键来查询数据

参数:

schema - 模式

tableName - 表名

primaryKey - 主键

id - id 值

返回:

row or null

另请参阅:

RowSqlProvider.selectOneById(Map)

selectOneByQuery

default Row selectOneByQuery(String schema,
                             String tableName,
                             QueryWrapper queryWrapper)

根据 queryWrapper 来查询 1 条数据

参数:

schema - 模式

tableName - 表名

queryWrapper - queryWrapper

返回:

row or null

selectListBySql

@SelectProvider(value=RowSqlProvider.class,
                method="providerRawSql")
List<Row> selectListBySql(@Param(value="$$sql")
                                                                                                               String sql,
                                                                                                               @Param(value="$$sql_args")
                                                                                                               Object... args)

通过自定义 sql 来查询一个 Row 列表

参数:

sql - 自定义的 sql

args - sql 参数

返回:

row 列表

selectListByQuery

@SelectProvider(value=RowSqlProvider.class,
                method="selectListByQuery")
List<Row> selectListByQuery(@Param(value="$$schemaName")
                                                                                                                    String schema,
                                                                                                                    @Param(value="$$tableName")
                                                                                                                    String tableName,
                                                                                                                    @Param(value="$$query")
                                                                                                                    QueryWrapper queryWrapper)

根据 queryWrapper 来查询一个 row 列表

参数:

schema - 模式

tableName - 表名

queryWrapper - queryWrapper

返回:

row 列表

另请参阅:

RowSqlProvider.selectListByQuery(Map)

selectAll

default List<Row> selectAll(String schema,
                            String tableName)

查询某张表的全部数据

参数:

schema - 模式

tableName - 表名

返回:

row 列表

selectObject

@SelectProvider(value=RowSqlProvider.class,
                method="providerRawSql")
Object selectObject(@Param(value="$$sql")
                                                                                                         String sql,
                                                                                                         @Param(value="$$sql_args")
                                                                                                         Object... args)

通过 sql 查询某一个数据，sql 执行的结果应该只有 1 行 1 列 若返回有多列，则只取第一列的值，若有多行，则会出现 TooManyResultsException 错误

参数:

sql - sql

args - sql 参数

返回:

object

selectFirstAndSecondColumnsAsMap

@SelectProvider(value=RowSqlProvider.class,
                method="providerRawSql")
Map selectFirstAndSecondColumnsAsMap(@Param(value="$$sql")
                                                                                                                          String sql,
                                                                                                                          @Param(value="$$sql_args")
                                                                                                                          Object... args)

selectFirstAndSecondColumnsAsMapByQuery

@SelectProvider(type=RowSqlProvider.class,
                method="selectListByQuery")
Map selectFirstAndSecondColumnsAsMapByQuery(@Param(value="$$schemaName")
                                                                                                                                   String schema,
                                                                                                                                   @Param(value="$$tableName")
                                                                                                                                   String tableName,
                                                                                                                                   @Param(value="$$query")
                                                                                                                                   QueryWrapper queryWrapper)

selectObjectList

@SelectProvider(value=RowSqlProvider.class,
                method="providerRawSql")
List<Object> selectObjectList(@Param(value="$$sql")
                                                                                                                   String sql,
                                                                                                                   @Param(value="$$sql_args")
                                                                                                                   Object... args)

通过 sql 查询多行数据，sql 执行的结果应该只有 1 列

参数:

sql - sql 语句

args - sql 参数

返回:

object list

selectCount

default long selectCount(String sql,
                         Object... args)

查询数据，一般用于 select count(*)... 的语言，也可用于执行的结果只有一个数值的其他 sql

参数:

sql - sql 语句

args - sql 参数

返回:

返回数据

selectObjectByQuery

default Object selectObjectByQuery(String schema,
                                   String tableName,
                                   QueryWrapper queryWrapper)

根据 queryWrapper 1 条数据 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...

参数:

schema - 模式

tableName - 表名

queryWrapper - queryWrapper

返回:

数据

selectObjectListByQuery

@SelectProvider(type=RowSqlProvider.class,
                method="selectListByQuery")
List<Object> selectObjectListByQuery(@Param(value="$$schemaName")
                                                                                                                            String schema,
                                                                                                                            @Param(value="$$tableName")
                                                                                                                            String tableName,
                                                                                                                            @Param(value="$$query")
                                                                                                                            QueryWrapper queryWrapper)

根据 queryWrapper 来查询数据列表 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...

参数:

queryWrapper - 查询包装器

返回:

数据列表

另请参阅:

RowSqlProvider.selectListByQuery(Map)

selectCountByQuery

default long selectCountByQuery(String schema,
                                String tableName,
                                QueryWrapper queryWrapper)

查询数据量

参数:

schema - 模式

tableName - 表名

queryWrapper - 查询包装器

返回:

数据量

paginate

default Page<Row> paginate(String schema,
                           String tableName,
                           Page<Row> page,
                           QueryWrapper queryWrapper)

分页查询数据

参数:

schema - 模式

tableName - 表名

page - page 封装类

queryWrapper - 条件

返回: