- 本文所述开发环境：.C#、NET8、Visual Studio2022
SqlSugar有实体查询数据表
首先根据《SqlSugar使用DbFirst对象根据数据库表结构创建实体类-C#》中的描述的表结构创建所有表的实体类如下：
| 表名 | 创建的实体类名 |
|---|---|
| tb_student | Student |
| tb_teacher | Teacher |
| tb_class | CClass |
| tb_status | Status |
| tb_subject_selection | SubjectSelection |
以下通过将对应的 sql 语句转换为 SqlSugar 的语法方式经行讲解。了解更多可以查看SqlSugar官网
为了可以直观的看到SqlSugar语法最终执行的sql语句，可以使用如下代码，将Sql语句输出到控制台，调试的时候用的较多。
using (SqlSugarClient sugarClient = new(connectionConfig))
{
sugarClient.Aop.OnLogExecuting = (s, p) =>
{
Console.WriteLine("===================================");
Console.WriteLine($"Sql语句：{ s }");
};
// 接下来编辑执行的SqlSugar代码
}
1. 单表查询
- 查询 tb_student表中的数据
Sql语句：select * from tb_student
代码如下：List<Student> students = sugarClient.Queryable<Student>().ToList(); // list类型接收 // 或者 DataTable studentDT = sugarClient.Queryable<Student>().ToDataTable(); // DataTable类型接收
执行后控制台会输出对应的Sql语句，如下：
后面对于输出的语句不做再多的说明。
继续
Sql语句：select count(*) from tb_student
代码如下：int nCount = sugarClient.Queryable<Student>().Count();
Sql语句：select top 1 * from tb_student
代码如下：Student student = sugarClient.Queryable<Student>().First(); //或者 List<Student> student = sugarClient.Queryable<Student>().Take(1).ToList();
Sql语句：select top 10 * from tb_student
代码如下：List<Student> student = sugarClient.Queryable<Student>().Take(10).ToList(); //和其它方法连用时， Task() 方法放在最后
Sql语句：select * from tb_student order by [身高]
代码如下：List<Student> students = sugarClient.Queryable<Student>() .OrderBy("[身高]").ToList(); // 或者 List<Student> students = sugarClient.Queryable<Student>() .OrderBy(it=>it.身高).ToList();
Sql语句：select * from tb_student order by [身高] desc
代码如下：List<Student> students = sugarClient.Queryable<Student>() .OrderBy("[身高] DESC").ToList(); // 或者 List<Student> students = sugarClient.Queryable<Student>() .OrderBy(it=>it.身高, OrderByType.Desc) .ToList();
Sql语句：select * from tb_student order by [年龄],[身高]
代码如下：List<Student> students = sugarClient.Queryable<Student>() .OrderBy("[年龄]") .OrderBy("[身高]") .ToList(); //或者 List<Student> students = sugarClient.Queryable<Student>() .OrderBy("[年龄],[身高]").ToList(); //或者 List<Student> students = sugarClient.Queryable<Student>() .OrderBy(it=>new { it.年龄, it.身高}) .ToList();
Sql语句：select * from tb_student order by [年龄] asc ,[身高] desc
代码如下：List<Student> students = sugarClient.Queryable<Student>() .OrderBy(it=>new { it.年龄, 身高=SqlFunc.Desc(it.身高)}) .ToList(); //或者 List<Student> students = sugarClient.Queryable<Student>() .OrderBy(it=>it.年龄) .OrderBy(it=>it.身高, OrderByType.Desc) .ToList(); // 或者 List<Student> students = sugarClient.Queryable<Student>() .OrderBy("[年龄], [身高] DESC") .ToList();
Sql语句：select 姓名,性别 from tb_student
代码如下：List<Student> students = sugarClient.Queryable<Student>() .Select("姓名,性别").ToList(); //或者 List<Student> students = sugarClient.Queryable<Student>() .Select(it=>new { it.姓名, it.性别}).ToList();
Sql语句：select * from tb_student where 班级ID=1003
代码如下：List<Student> students = sugarClient.Queryable<Student>() .Where(it=>it.班级ID==1003).ToList(); //或者 List<Student> students = sugarClient.Queryable<Student>() .Where("班级ID=1003").ToList();
Sql语句：select 姓名,性别 from tb_student where 班级ID=1003 and 身高>165
代码如下：var students = sugarClient.Queryable<Student>() .Where(it=>it.班级ID == 1003) .Where(it=>it.身高 > 165) .Select(it=>new { it.姓名, it.性别}).ToList(); //或者 var students = sugarClient.Queryable<Student>() .Where("班级ID = @classid and 身高 > @high", new { classid = 1003, high = 165 }) .Select("姓名, 性别").ToList();
Sql语句：select * from tb_subject_selection where 课程 like ‘%化学%’
代码如下：List<SubjectSelection> subjectsels = sugarClient.Queryable<SubjectSelection>() .Where("课程 like '%化学%'") .ToList(); //或者 List<SubjectSelection> subjectsels = sugarClient.Queryable<SubjectSelection>() .Where(it=>it.课程.Contains("化学")) .ToList();
Sql语句：select * from tb_student where 状态ID in (2, 3)
代码如下：List<Student> students = sugarClient.Queryable<Student>() .Where("状态ID in (2, 3)") .ToList(); //或者 List<Student> students = sugarClient.Queryable<Student>() .Where("状态ID in (@statuslist)", new { statuslist = new[] { 2, 3 } }) .ToList(); //或者 var statuslist = new[] { 2, 3 }; List<Student> students = sugarClient.Queryable<Student>() .Where(it=> statuslist.Contains(it.状态ID)) .ToList();
在实际的项目中存在这样一种情况：有一个工具类，类中的字段只有对应表中的几个字段，如果直接用表实体类查询的话，会获取到全部的字段，那么如何将实体类中的对应几个字段赋值给工具类呢。
比如，以下是一个学生的工具类：MiniStudent，在整个项目就只用到了：学生ID、姓名、班级ID三个字段。
public class MiniStudent
{
public int Id { get; set; }
public string Name { get; set; }
public int Class { get; set; }
}
使用SqlSugar将查询结果的相关字段赋值给工具类，代码如下：
List<MiniStudent> students = sugarClient.Queryable<Student>()
.Select(it => new MiniStudent
{
Id = it.学生ID,
Name = it.姓名,
Class = it.班级ID
}).ToList();
这种方式显然不是很好，为了得到MiniStudent，需要有一个实体类Student，感觉多此一举。
直接将工具类MiniStudent绑定到tb_student表结构岂不是美哉。这种需要在MiniStudent类的上面添加SugarTable属性，并且类中的属性名都要是表中有的字段名。
代码如下：
[SugarTable("tb_student")]
public class MiniStudent
{
public int 学生ID { get; set; }
public string 姓名 { get; set; }
public int 班级ID { get; set; }
}
List<MiniStudent> miniStudents = sugarClient.Queryable<MiniStudent>().ToList();
这种相对好一点，但是有一个问题，假如类的属性名就是想用英文的怎么办，能否实现sql语句中的 AS 语法的功能呢。例如：
select 学生ID as Id, 姓名 as Name, 班级ID as Class from tb_student
在实体类中使用字段属性 [SugarColumn(ColumnName = “xxxx”)]，这个意思就是告诉SqlSugar，要将表中的哪个字段赋值给实体类中的修饰属性字段。代码如下：
[SugarTable("tb_student")]
public class MiniStudent
{
[SugarColumn(ColumnName = "学生ID")]
public int Id { get; set; }
[SugarColumn(ColumnName = "姓名")]
public string Name { get; set; }
[SugarColumn(ColumnName = "班级ID")]
public int Class { get; set; }
}
List<MiniStudent> miniStudents = sugarClient.Queryable<MiniStudent>().ToList();
上面这样就可以了，属性SugarColumn告诉SqlSugar:
- 将表字段 学生ID 的内容赋值给 Id 类字段
- 将表字段 姓名 的内容赋值给 Name 类字段
- 将表字段 班级ID 的内容赋值给 Class 类字段
另一种情况：实体类中除了表字段对应的属性字段，还有一些不是表字段中对应的属性，而这些属性又是要用到的，如果还是像上面一样查询就是异常。
例如:还是工具类MiniStudent，但是定义如下：
[SugarTable("tb_student")]
public class MiniStudent
{
[SugarColumn(ColumnName = "学生ID")]
public int Id { get; set; }
[SugarColumn(ColumnName = "姓名")]
public string Name { get; set; }
[SugarColumn(ColumnName = "班级ID")]
public int Class { get; set; }
public string strKey { get; set; }
}
类中多了一个 strKey 的属性字段，这个属性并不是从表中查询获取，但后续代码又会用到，那能不能忽略这个属性字段进行查询呢？答案是肯定的，只需要将要忽略查询的字段加上属性 [SugarColumn(IsIgnore = true)] 即可，代码如下：
[SugarTable("tb_student")]
public class MiniStudent
{
[SugarColumn(ColumnName = "学生ID")]
public int Id { get; set; }
[SugarColumn(ColumnName = "姓名")]
public string Name { get; set; }
[SugarColumn(ColumnName = "班级ID")]
public int Class { get; set; }
[SugarColumn(IsIgnore = true)]
public string strKey { get; set; }
}
List<MiniStudent> miniStudents = sugarClient.Queryable<MiniStudent>().ToList();
再谈一种情况：给实体类和类中每个属性字段都加上SqlSugar的字段属性标签太麻烦了，不想这样，能不能直接用SqlSugar的方法实现？答案也是肯定的。
例如：MiniStudent 类定义如下：
public class MiniStudent
{
public int Id { get; set; }
public string Name { get; set; }
public int Class { get; set; }
public string strKey { get; set; }
}
// 可以用以下方法实现
List<MiniStudent> students = sugarClient.Queryable<MiniStudent>()
.AS("tb_student") // 指定要查的表名
.IgnoreColumns(it=>it.strKey) // 指定实体类中要忽略的属性字段
.Select("学生ID as Id, 姓名 as Name, 班级ID as Class") // 指定表字段别名
.ToList();
2. 多表查询
Sql语句：select 班级名称, 姓名 as 班主任 from tb_class a left join tb_teacher b on a.班主任 = b.教师ID
代码如下：var result = sugarClient.Queryable<CClass>() .LeftJoin<Teacher>((a, b) => a.班主任 == b.教师ID) .Select((a, b) => new { a.班级名称, 班主任 = b.姓名 }) .ToList(); // 或者 var queryable = sugarClient.Queryable<CClass>(); var result = sugarClient.Queryable(queryable) .LeftJoin<Teacher>((a, b) => a.班主任 == b.教师ID) .Select((a, b) => new { a.班级名称, 班主任 = b.姓名 }) .ToDataTable();RightJoin与LeftJoin一样，两个表以上的联合查询也类似，不断的连接起来就可以了。
SqlSugar有实体增加表中数据
- 向表tb_student中插入一行新的记录
代码如下
Student newstudent = new Student()
{
学生ID = 110,
姓名 = "黄同学",
班级ID = 1002,
状态ID = 1,
性别 = "男",
年龄 = 30,
身高 = 175,
体重 = 69
};
int insertnum = sugarClient.Insertable(newstudent).ExecuteCommand(); // 返回插入的行数
- 批量插入多条数据
List<Student> newStudents = [];
for (int i = 0; i < 10; i++)
{
Student newstudent = new Student()
{
学生ID = 111 + i,
姓名 = $"黄同学{i}",
班级ID = 1002,
状态ID = 1,
性别 = i>5?"男":"女",
年龄 = 30 + i,
身高 = 175 + i / 10.0,
体重 = 69 + i / 10.0
};
newStudents.Add(newstudent);
}
int insertnum = sugarClient.Insertable(newStudents).ExecuteCommand(); // 返回插入的行数
SqlSugar有实体更新表中数据
- 更新表中单个字段
Sql语句：update tb_student set 班级ID=1001 where 学生ID=109
代码如下：sugarClient.Updateable<Student>() .SetColumns(it=>it.班级ID == 1001) // 注意：这里也是两个等号 .Where(it=>it.学生ID == 109) .ExecuteCommand();
- 跟新表中多个字段
Sql语句：update tb_student set 班级ID=1001, 状态ID=3 where 学生ID=109
sugarClient.Updateable<Student>() .SetColumns(it=>it.班级ID == 1001) // 注意：这里也是两个等号 .SetColumns(it=>it.状态ID == 3) .Where(it=>it.学生ID == 109) .ExecuteCommand(); // 或者 sugarClient.Updateable<Student>() .SetColumns(it=> new Student() { 班级ID = 1002, 状态ID = 2 }) // 注意：这里也是两个等号 .Where(it=>it.学生ID == 109) .ExecuteCommand();
SqlSugar有实体删除表中数据
- 删除符合条件的记录
Sql语句：delete from tb_student where 学生ID=120
代码如下：sugarClient.Deleteable<Student>(it=>it.学生ID == 120).ExecuteCommand(); // 或者 sugarClient.Deleteable<Student>(new Student() { 学生ID=120}).ExecuteCommand();
- 清空表记录
Sql语句：truncate table tb_student
代码如下：sugarClient.DbMaintenance.TruncateTable<Student>();
