style: 为有争议的 API 添加注释。

This commit is contained in:
王帅 2024-10-04 21:28:05 +08:00
parent 10c6d4342d
commit 7b34921445

View File

@ -241,6 +241,35 @@ public class QueryWrapper extends BaseQueryWrapper<QueryWrapper> {
return from(new SelectQueryTable(queryWrapper));
}
/**
* <p> FROM 语句后的第一个表起别名而不是为整个 SELECT 语句起别名
*
* <p>例如以下示例
*
* <p><pre>{@code
* QueryWrapper.create().from(ACCOUNT).as("a");
* }</pre>
*
* <p>等价于
*
* <p><pre>{@code
* QueryWrapper.create().from(ACCOUNT.as("a"));
* }</pre>
*
* <p>最终生成的 SQL
* <p><pre>{@code
* SELECT a.* FROM tb_account a
* }</pre>
*
* <p>而不是
*
* <p><pre>{@code
* (SELECT * FROM tb_account) AS "a"
* }</pre>
*
* @param alias 别名
* @return 当前查询包装器
*/
public QueryWrapper as(String alias) {
if (CollectionUtil.isEmpty(queryTables)) {
throw new IllegalArgumentException("query table must not be empty.");