Fast.SqlSugar 公开 API
目标 net8.0;net9.0;net10.0。从本页目录选择类型,查看其声明和成员。配置、运行示例和边界见模块用法。
参考版本 3.5.76。源码提交 a8bd407bf5f6b811da7fb7bd1db827f4da119a94。
Fast.SqlSugar.SugarDbTypeAttribute
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
[AttributeUsage(AttributeTargets.Class)]
public class SugarDbTypeAttribute : AttributeSqlSugar DB 类型
说明:放入 Class 头部,支持传入 Object,然后在 ISqlSugarEntityHandler 自行解析
Fast.SqlSugar.SugarDbTypeAttribute.Type
源码 · 目标:net8.0、net9.0、net10.0
public object Type { get; set; }Entity 的 DB 类型
说明:如果为null,则代表的默认库
Fast.SqlSugar.SugarDbTypeAttribute.SugarDbTypeAttribute
源码 · 目标:net8.0、net9.0、net10.0
public SugarDbTypeAttribute()SqlSugar DB 类型
说明:放入 Class 头部,支持传入 Object,然后在 ISqlSugarEntityHandler 自行解析
Fast.SqlSugar.SugarDbTypeAttribute.SugarDbTypeAttribute
源码 · 目标:net8.0、net9.0、net10.0
public SugarDbTypeAttribute(object type)SqlSugar DB 类型
说明:放入 Class 头部,支持传入 Object,然后在 ISqlSugarEntityHandler 自行解析
- 参数
type:Entity 的 DB 类型
Fast.SqlSugar.SugarSearchTimeAttribute
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
[AttributeUsage(AttributeTargets.Property)]
public class SugarSearchTimeAttribute : AttributeSqlSugar 分页搜索时间列
说明:仅支持 DateTime 类型
Fast.SqlSugar.SugarSearchValueAttribute
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
[AttributeUsage(AttributeTargets.Property)]
public class SugarSearchValueAttribute : AttributeSqlSugar 分页搜索列
Fast.SqlSugar.BaseEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class BaseEntity : IBaseEntityEntity 基类
Fast.SqlSugar.BaseEntity.CreatedUserId
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "创建者用户Id", CreateTableFieldSort = 991)]
public virtual long? CreatedUserId { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseEntity.CreatedUserName
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "创建者用户名称", Length = 20, IsNullable = true, CreateTableFieldSort = 992)]
public virtual string CreatedUserName { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseEntity.CreatedTime
源码 · 目标:net8.0、net9.0、net10.0
[Required]
[SugarColumn(ColumnDescription = "创建时间", CreateTableFieldSort = 993)]
public virtual DateTime? CreatedTime { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseEntity.UpdatedUserId
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "更新者用户Id", CreateTableFieldSort = 994)]
public virtual long? UpdatedUserId { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseEntity.UpdatedUserName
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "更新者用户名称", Length = 20, IsNullable = true, CreateTableFieldSort = 995)]
public virtual string UpdatedUserName { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseEntity.UpdatedTime
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "更新时间", CreateTableFieldSort = 996)]
public virtual DateTime? UpdatedTime { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class BaseRecordEntity : IBaseRecordEntity记录 Entity 基类
Fast.SqlSugar.BaseRecordEntity.Device
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "设备", Length = 50, IsNullable = true, CreateTableFieldSort = 971)]
public virtual string Device { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.OS
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "操作系统(版本)", Length = 50, IsNullable = true, CreateTableFieldSort = 972)]
public virtual string OS { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.Browser
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "浏览器(版本)", Length = 50, IsNullable = true, CreateTableFieldSort = 973)]
public virtual string Browser { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.Province
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "省份", Length = 20, IsNullable = true, CreateTableFieldSort = 974)]
public virtual string Province { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.City
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "城市", Length = 20, IsNullable = true, CreateTableFieldSort = 975)]
public virtual string City { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.Ip
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "Ip", Length = 15, IsNullable = true, CreateTableFieldSort = 976)]
public virtual string Ip { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.CreatedUserId
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "创建者用户Id", CreateTableFieldSort = 991)]
public virtual long? CreatedUserId { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.CreatedUserName
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "创建者用户名称", Length = 20, IsNullable = true, CreateTableFieldSort = 992)]
public virtual string CreatedUserName { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.CreatedTime
源码 · 目标:net8.0、net9.0、net10.0
[Required]
[SugarColumn(ColumnDescription = "创建时间", CreateTableFieldSort = 993)]
public virtual DateTime? CreatedTime { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseRecordEntity.RecordCreate
源码 · 目标:net8.0、net9.0、net10.0
public void RecordCreate(HttpContext httpContext)说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.BaseTEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class BaseTEntity : BaseEntity, IBaseTEntity租户 Entity 基类
Fast.SqlSugar.BaseTEntity.TenantId
源码 · 目标:net8.0、net9.0、net10.0
[SugarColumn(ColumnDescription = "租户Id", CreateTableFieldSort = 997)]
public virtual long TenantId { get; set; }说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.PagedInput
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class PagedInputSqlSugar 统一分页输入
Fast.SqlSugar.PagedInput.PageIndex
源码 · 目标:net8.0、net9.0、net10.0
public virtual int PageIndex { get; set; } = 1;当前页面索引值,默认为 1
Fast.SqlSugar.PagedInput.PageSize
源码 · 目标:net8.0、net9.0、net10.0
public virtual int PageSize { get; set; } = 20;页码容量
Fast.SqlSugar.PagedInput.SearchValue
源码 · 目标:net8.0、net9.0、net10.0
public virtual string SearchValue { get; set; }搜索值
Fast.SqlSugar.PagedInput.SearchTimeList
源码 · 目标:net8.0、net9.0、net10.0
public virtual IList<DateTime?> SearchTimeList { get; set; } = [];搜索时间
Fast.SqlSugar.PagedInput.SearchList
源码 · 目标:net8.0、net9.0、net10.0
public virtual PagedSearchInput[] SearchList { get; set; } = [];搜索集合
Fast.SqlSugar.PagedInput.SortList
源码 · 目标:net8.0、net9.0、net10.0
public virtual PagedSortInput[] SortList { get; set; } = [];排序集合
Fast.SqlSugar.PagedInput.EnablePaged
源码 · 目标:net8.0、net9.0、net10.0
public virtual bool EnablePaged { get; set; } = true;启用分页
说明:默认启用
Fast.SqlSugar.PagedInput.IsOrderBy
源码 · 目标:net8.0、net9.0、net10.0
public bool IsOrderBy { get; }是否可以使用默认排序
Fast.SqlSugar.PagedOutput
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class PagedOutputSqlSugar 统一分页输出
Fast.SqlSugar.PagedOutput.CreatedUserName
源码 · 目标:net8.0、net9.0、net10.0
public virtual string CreatedUserName { get; set; }创建者用户名称
Fast.SqlSugar.PagedOutput.CreatedTime
源码 · 目标:net8.0、net9.0、net10.0
public virtual DateTime? CreatedTime { get; set; }创建时间
Fast.SqlSugar.PagedOutput.UpdatedUserName
源码 · 目标:net8.0、net9.0、net10.0
public virtual string UpdatedUserName { get; set; }更新者用户名称
Fast.SqlSugar.PagedOutput.UpdatedTime
源码 · 目标:net8.0、net9.0、net10.0
public virtual DateTime? UpdatedTime { get; set; }更新时间
Fast.SqlSugar.PagedOutput.RowVersion
源码 · 目标:net8.0、net9.0、net10.0
public virtual long RowVersion { get; set; }更新版本控制字段
Fast.SqlSugar.PagedResult
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class PagedResult<TResult>SqlSugar 统一分页返回结果类
- 类型参数
TResult:操作结果类型
Fast.SqlSugar.PagedResult.PageIndex
源码 · 目标:net8.0、net9.0、net10.0
public virtual int PageIndex { get; set; }当前页
Fast.SqlSugar.PagedResult.PageSize
源码 · 目标:net8.0、net9.0、net10.0
public virtual int PageSize { get; set; }当前页码
Fast.SqlSugar.PagedResult.TotalPage
源码 · 目标:net8.0、net9.0、net10.0
public virtual int TotalPage { get; set; }总页数
Fast.SqlSugar.PagedResult.TotalRows
源码 · 目标:net8.0、net9.0、net10.0
public virtual int TotalRows { get; set; }总条数
Fast.SqlSugar.PagedResult.Rows
源码 · 目标:net8.0、net9.0、net10.0
public virtual IEnumerable<TResult> Rows { get; set; }Data
Fast.SqlSugar.PagedResult.HasPrevPages
源码 · 目标:net8.0、net9.0、net10.0
public virtual bool HasPrevPages { get; set; }是否有上一页
Fast.SqlSugar.PagedResult.HasNextPages
源码 · 目标:net8.0、net9.0、net10.0
public virtual bool HasNextPages { get; set; }是否有下一页
Fast.SqlSugar.PagedResult.AssemblyName
源码 · 目标:net8.0、net9.0、net10.0
public virtual string AssemblyName { get; set; }程序集名称
Fast.SqlSugar.PagedResult.TypeFullName
源码 · 目标:net8.0、net9.0、net10.0
public virtual string TypeFullName { get; set; }类型完全限定名称
Fast.SqlSugar.PagedSearchInput
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class PagedSearchInputSqlSugar 统一分页搜索输入
Fast.SqlSugar.PagedSearchInput.EnField
源码 · 目标:net8.0、net9.0、net10.0
[StringRequired(ErrorMessage = "搜索字段不能为空")]
public virtual string EnField { get; set; }搜索字段英文
说明:主要字段,用于生成查询语句
Fast.SqlSugar.PagedSearchInput.ChField
源码 · 目标:net8.0、net9.0、net10.0
public virtual string ChField { get; set; }搜索字段中文
说明:次要字段,用于提示
Fast.SqlSugar.PagedSearchInput.Value
源码 · 目标:net8.0、net9.0、net10.0
public virtual string Value { get; set; }搜索值
Fast.SqlSugar.PagedSearchInput.Type
源码 · 目标:net8.0、net9.0、net10.0
public virtual PagedSearchTypeEnum Type { get; set; } = PagedSearchTypeEnum.Like;搜索类型
说明:默认模糊匹配
Fast.SqlSugar.PagedSortInput
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class PagedSortInputSqlSugar 统一分页排序输入
Fast.SqlSugar.PagedSortInput.EnField
源码 · 目标:net8.0、net9.0、net10.0
[StringRequired(ErrorMessage = "排序字段不能为空")]
public virtual string EnField { get; set; }排序字段英文
说明:主要字段,用于生成排序语句
Fast.SqlSugar.PagedSortInput.ChField
源码 · 目标:net8.0、net9.0、net10.0
public virtual string ChField { get; set; }排序字段中文
说明:次要字段,用于提示
Fast.SqlSugar.PagedSortInput.Mode
源码 · 目标:net8.0、net9.0、net10.0
public virtual string Mode { get; set; }排序方式
说明:ElementPlus 的 Table 排序方式ascending 正序;descending:倒序;为空默认正序
Fast.SqlSugar.PagedSortInput.IsDescending
源码 · 目标:net8.0、net9.0、net10.0
public virtual bool IsDescending { get; }是否倒序排序
Fast.SqlSugar.SlaveConnectionInfo
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class SlaveConnectionInfo从库连接信息
说明:连接字段独立配置,不从主库继承,也不自动执行后配置。
Fast.SqlSugar.SlaveConnectionInfo.ServiceIp
源码 · 目标:net8.0、net9.0、net10.0
public string ServiceIp { get; set; }服务器 Ip 地址
Fast.SqlSugar.SlaveConnectionInfo.Port
源码 · 目标:net8.0、net9.0、net10.0
public int? Port { get; set; }端口号
Fast.SqlSugar.SlaveConnectionInfo.DbName
源码 · 目标:net8.0、net9.0、net10.0
public string DbName { get; set; }数据库名称
Fast.SqlSugar.SlaveConnectionInfo.DbUser
源码 · 目标:net8.0、net9.0、net10.0
public string DbUser { get; set; }数据库用户
Fast.SqlSugar.SlaveConnectionInfo.DbPwd
源码 · 目标:net8.0、net9.0、net10.0
public string DbPwd { get; set; }数据库密码
Fast.SqlSugar.SlaveConnectionInfo.MaxPoolSize
源码 · 目标:net8.0、net9.0、net10.0
public int? MaxPoolSize { get; set; }最大连接池数量
说明:自动生成 MySql、MySqlConnector、SqlServer 和 PostgreSQL 连接字符串时使用此值,未指定时使用 100。
Fast.SqlSugar.SlaveConnectionInfo.CommandTimeOut
源码 · 目标:net8.0、net9.0、net10.0
public int? CommandTimeOut { get; set; }超时时间,单位为秒
说明:当前连接配置生成流程未将此字段应用为独立的从库命令超时。
Fast.SqlSugar.SlaveConnectionInfo.HitRate
源码 · 目标:net8.0、net9.0、net10.0
public int HitRate { get; set; }从库命中率
说明:为 0 则不命中建议相加不超过 10
Fast.SqlSugar.SqlSugarEntityInfo
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public sealed class SqlSugarEntityInfoSqlSugar 实体信息
Fast.SqlSugar.SqlSugarEntityInfo.TableName
源码 · 目标:net8.0、net9.0、net10.0
public string TableName { get; set; }数据库表名称
Fast.SqlSugar.SqlSugarEntityInfo.TableDescription
源码 · 目标:net8.0、net9.0、net10.0
public string TableDescription { get; set; }数据库表描述
Fast.SqlSugar.SqlSugarEntityInfo.EntityType
源码 · 目标:net8.0、net9.0、net10.0
public Type EntityType { get; set; }实体类型
Fast.SqlSugar.SqlSugarEntityInfo.IsSplitTable
源码 · 目标:net8.0、net9.0、net10.0
public bool IsSplitTable { get; set; }是否分表
Fast.SqlSugar.SqlSugarEntityInfo.SugarDbType
源码 · 目标:net8.0、net9.0、net10.0
public object SugarDbType { get; set; }SugarDbTypeAttribute 特性的 Type 属性
Fast.SqlSugar.UpdateVersionInput
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class UpdateVersionInput行版本更新输入
Fast.SqlSugar.UpdateVersionInput.RowVersion
源码 · 目标:net8.0、net9.0、net10.0
[LongRequired(ErrorMessage = "更新版本控制字段不能为空", AllowZero = true)]
public long RowVersion { get; set; }更新版本控制字段
Fast.SqlSugar.SqlSugarContext
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public sealed class SqlSugarContextSqlSugar 上下文
Fast.SqlSugar.SqlSugarContext.ConnectionSettings
源码 · 目标:net8.0、net9.0、net10.0
public static ConnectionSettingsOptions ConnectionSettings { get; internal set; }连接字符串配置
Fast.SqlSugar.SqlSugarContext.SnowflakeSettings
源码 · 目标:net8.0、net9.0、net10.0
public static SnowflakeSettingsOptions SnowflakeSettings { get; internal set; }雪花Id配置
Fast.SqlSugar.SqlSugarContext.MaxNotPageSize
源码 · 目标:net8.0、net9.0、net10.0
public static int MaxNotPageSize { get; set; }最大不分页大小限制
Fast.SqlSugar.SqlSugarContext.SqlSugarEntityList
源码 · 目标:net8.0、net9.0、net10.0
public static readonly List<SqlSugarEntityInfo> SqlSugarEntityList;SqlSugar 实体集合
Fast.SqlSugar.SqlSugarContext.GetConnectionConfig
源码 · 目标:net8.0、net9.0、net10.0
public static ConnectionConfig GetConnectionConfig(ConnectionSettingsOptions connectionSettings)获取连接配置
- 参数
connectionSettings:connection Settings 配置 - 返回:获取到的连接配置
Fast.SqlSugar.PagedSearchTypeEnum
源码 · 目标:net8.0、net9.0、net10.0
[FastEnum("分页搜索类型枚举")]
public enum PagedSearchTypeEnum : byte分页搜索类型枚举
Fast.SqlSugar.PagedSearchTypeEnum.Like
源码 · 目标:net8.0、net9.0、net10.0
[Description("模糊匹配")]
Like = 1模糊匹配
Fast.SqlSugar.PagedSearchTypeEnum.Equal
源码 · 目标:net8.0、net9.0、net10.0
[Description("等于")]
Equal = 2等于
Fast.SqlSugar.PagedSearchTypeEnum.NotEqual
源码 · 目标:net8.0、net9.0、net10.0
[Description("不等于")]
NotEqual = 3不等于
Fast.SqlSugar.PagedSearchTypeEnum.GreaterThan
源码 · 目标:net8.0、net9.0、net10.0
[Description("大于")]
GreaterThan = 4大于
Fast.SqlSugar.PagedSearchTypeEnum.GreaterThanOrEqual
源码 · 目标:net8.0、net9.0、net10.0
[Description("大于等于")]
GreaterThanOrEqual = 5大于等于
Fast.SqlSugar.PagedSearchTypeEnum.LessThan
源码 · 目标:net8.0、net9.0、net10.0
[Description("小于")]
LessThan = 6小于
Fast.SqlSugar.PagedSearchTypeEnum.LessThanOrEqual
源码 · 目标:net8.0、net9.0、net10.0
[Description("小于等于")]
LessThanOrEqual = 7小于等于
Fast.SqlSugar.PagedSearchTypeEnum.Include
源码 · 目标:net8.0、net9.0、net10.0
[Description("包含")]
Include = 8包含
Fast.SqlSugar.PagedSearchTypeEnum.NotInclude
源码 · 目标:net8.0、net9.0、net10.0
[Description("排除")]
NotInclude = 9排除
Fast.SqlSugar.SugarDbType
源码 · 目标:net8.0、net9.0、net10.0
[FastEnum("Sugar数据库类型枚举")]
public enum SugarDbTypeSugar 数据库类型枚举
Fast.SqlSugar.SugarDbType.MySql
源码 · 目标:net8.0、net9.0、net10.0
[Description("MySql")]
MySql = 1MySql
Fast.SqlSugar.SugarDbType.SqlServer
源码 · 目标:net8.0、net9.0、net10.0
[Description("SqlServer")]
SqlServer = 2SqlServer
Fast.SqlSugar.SugarDbType.Sqlite
源码 · 目标:net8.0、net9.0、net10.0
[Description("SqLite")]
Sqlite = 3SqLite
Fast.SqlSugar.SugarDbType.Oracle
源码 · 目标:net8.0、net9.0、net10.0
[Description("Oracle")]
Oracle = 4Oracle
Fast.SqlSugar.SugarDbType.PostgreSQL
源码 · 目标:net8.0、net9.0、net10.0
[Description("PostgreSQL")]
PostgreSQL = 5PostgreSQL
Fast.SqlSugar.SugarDbType.MongoDb
源码 · 目标:net8.0、net9.0、net10.0
[Description("MongoDB")]
MongoDb = 6MongoDB
Fast.SqlSugar.DbTypeExtension
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public static class DbTypeExtension为 DbType 提供扩展方法
Fast.SqlSugar.DbTypeExtension.ToDbType
源码 · 目标:net8.0、net9.0、net10.0
public static DbType ToDbType(this SugarDbType sugarDbType)将 SugarDbType 转换为 DbType
- 参数
sugarDbType:sugar Db 类型 - 返回:将 SugarDbType 转换为 DbType
- 异常
ArgumentOutOfRangeException:sugarDbType不是当前支持的六种数据库类型之一。
Fast.SqlSugar.DbTypeExtension.ToSugarDbType
源码 · 目标:net8.0、net9.0、net10.0
public static SugarDbType ToSugarDbType(this DbType dbType)将 DbType 转换为 SugarDbType
- 参数
dbType:数据库类型 - 返回:将 DbType 转换为 SugarDbType
- 异常
ArgumentOutOfRangeException:dbType不属于 MySql、SqlServer、Sqlite、Oracle、PostgreSQL 或 MongoDb。
Fast.SqlSugar.IServiceCollectionExtension
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public static class IServiceCollectionExtension为 IServiceCollection 提供动态 API 扩展方法
Fast.SqlSugar.IServiceCollectionExtension.AddSnowflake
源码 · 目标:net8.0、net9.0、net10.0
public static IServiceCollection AddSnowflake(this IServiceCollection services, IConfiguration configuration,
string section = "SnowflakeSettings")添加雪花Id
- 参数
services:要添加服务的服务集合 - 参数
configuration:用于读取模块设置的配置 - 参数
section:JSON 配置文件节点的 Key 默认值:SnowflakeSettings - 返回:返回
services,便于链式调用
Fast.SqlSugar.IServiceCollectionExtension.AddSnowflake
源码 · 目标:net8.0、net9.0、net10.0
public static IServiceCollection AddSnowflake(this IServiceCollection services, IConfiguration configuration,
Action<SnowflakeSettingsOptions> optionAction)添加雪花Id
- 参数
services:要添加服务的服务集合 - 参数
configuration:用于读取模块设置的配置 - 参数
optionAction:雪花Id配置操作 - 返回:返回
services,便于链式调用
Fast.SqlSugar.IServiceCollectionExtension.AddSqlSugar
源码 · 目标:net8.0、net9.0、net10.0
public static IServiceCollection AddSqlSugar(this IServiceCollection services, IConfiguration configuration,
IHostEnvironment hostEnvironment, string connectionSection = "ConnectionSettings")注册 SqlSugar 服务
- 参数
services:要添加服务的服务集合 - 参数
configuration:用于读取模块设置的配置 - 参数
hostEnvironment:当前应用的宿主环境 - 参数
connectionSection:JSON 配置文件节点的 Key 默认值:ConnectionSettings - 返回:返回
services,便于链式调用
Fast.SqlSugar.IServiceCollectionExtension.AddSqlSugar
源码 · 目标:net8.0、net9.0、net10.0
public static IServiceCollection AddSqlSugar(this IServiceCollection services, IConfiguration configuration,
IHostEnvironment hostEnvironment, Action<ConnectionSettingsOptions> optionAction)注册 SqlSugar 服务
- 参数
services:要添加服务的服务集合 - 参数
configuration:用于读取模块设置的配置 - 参数
hostEnvironment:当前应用的宿主环境 - 参数
optionAction:数据库连接配置操作 - 返回:返回
services,便于链式调用
Fast.SqlSugar.SqlSugarExtension
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public static class SqlSugarExtension为 ISqlSugarClient 提供 SqlSugar 扩展方法
Fast.SqlSugar.SqlSugarExtension.GetSugarTableName
源码 · 目标:net8.0、net9.0、net10.0
public static string GetSugarTableName(this Type type)获取 SugarTable 特性中的 TableName
- 参数
type:目标类型 - 返回:获取到的 SugarTable 特性中的 TableName
Fast.SqlSugar.SqlSugarExtension.GetSugarTableAttribute
源码 · 目标:net8.0、net9.0、net10.0
public static SugarTable GetSugarTableAttribute(this Type type)获取 SugarTable 特性
- 参数
type:目标类型 - 返回:获取到的 SugarTable 特性
Fast.SqlSugar.SqlSugarExtension.ToDataTable
源码 · 目标:net8.0、net9.0、net10.0
public static List<DataTable> ToDataTable<T>(this List<T> list)转为 DataTable
- 参数
list:要处理的集合 - 类型参数
T:数据表行对应的模型类型 - 返回:转为 DataTable 集合
Fast.SqlSugar.SqlSugarPageExtension
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public static class SqlSugarPageExtension为 ISugarQueryable{T} 提供 ISugarQueryable 分页扩展方法
Fast.SqlSugar.SqlSugarPageExtension.ToPagedData
源码 · 目标:net8.0、net9.0、net10.0
public static PagedResult<TResult> ToPagedData<TEntity, TResult>(this PagedResult<TEntity> pagedResult,
Func<TEntity, TResult> selectExpression)分页转换类型
- 参数
pagedResult:要写入数据的分页结果 - 参数
selectExpression:用于分页转换类型的表达式 - 类型参数
TEntity:实体类型 - 类型参数
TResult:操作结果类型 - 返回:分页转换类型
Fast.SqlSugar.SqlSugarPageExtension.ToPagedList
源码 · 目标:net8.0、net9.0、net10.0
public static PagedResult<TEntity> ToPagedList<TEntity>(this ISugarQueryable<TEntity> queryable, PagedInput input)SqlSugar 分页扩展
说明:多表查询(LeftJoin/Join)场景需注意:分页统计依赖 MergeTable,建议在分页前进行结构收敛 .Select((t1, t2) => new { ... }).MergeTable() 或 .SelectMergeTable((t1, t2) => new { ... }) 未使用 MergeTable 可能导致总数统计异常或结果不准确
- 参数
queryable:要继续构建的查询对象 - 参数
input:PagedInput 通用 SqlSugar 分页输入 - 类型参数
TEntity:实体类型 - 返回:查询记录与分页信息;禁用分页时恰好达到上限仍允许返回,超过上限抛出异常。
Fast.SqlSugar.SqlSugarPageExtension.ToPagedListAsync
源码 · 目标:net8.0、net9.0、net10.0
public static async Task<PagedResult<TEntity>> ToPagedListAsync<TEntity>(this ISugarQueryable<TEntity> queryable,
PagedInput input)SqlSugar 分页扩展
说明:多表查询(LeftJoin/Join)场景需注意:分页统计依赖 MergeTable,建议在分页前进行结构收敛 .Select((t1, t2) => new { ... }).MergeTable() 或 .SelectMergeTable((t1, t2) => new { ... }) 未使用 MergeTable 可能导致总数统计异常或结果不准确
- 参数
queryable:要继续构建的查询对象 - 参数
input:PagedInput 通用 SqlSugar 分页输入 - 类型参数
TEntity:实体类型 - 返回:包含查询记录与分页信息的任务;非分页查询超过配置上限时抛出异常。
Fast.SqlSugar.SqlSugarPageExtension.ToPagedList
源码 · 目标:net8.0、net9.0、net10.0
public static PagedResult<TEntity> ToPagedList<TEntity>(this ISugarQueryable<TEntity> queryable, int pageIndex,
int pageSize = 20, bool enablePaged = true)SqlSugar 分页扩展
- 参数
queryable:要继续构建的查询对象 - 参数
pageIndex:页码,从 1 开始 - 参数
pageSize:每页记录数 - 参数
enablePaged:是否启用分页查询 - 类型参数
TEntity:实体类型 - 返回:查询记录与分页信息;禁用分页时恰好达到上限仍允许返回,超过上限抛出异常。
Fast.SqlSugar.SqlSugarPageExtension.ToPagedListAsync
源码 · 目标:net8.0、net9.0、net10.0
public static async Task<PagedResult<TEntity>> ToPagedListAsync<TEntity>(this ISugarQueryable<TEntity> queryable,
int pageIndex, int pageSize = 20, bool enablePaged = true)SqlSugar 分页扩展
- 参数
queryable:要继续构建的查询对象 - 参数
pageIndex:页码,从 1 开始 - 参数
pageSize:每页记录数 - 参数
enablePaged:是否启用分页查询 - 类型参数
TEntity:实体类型 - 返回:包含查询记录与分页信息的任务;非分页查询超过配置上限时抛出异常。
Fast.SqlSugar.SqlSugarPageExtension.SugarPaged
源码 · 目标:net8.0、net9.0、net10.0
public static ISugarQueryable<TEntity> SugarPaged<TEntity>(this ISugarQueryable<TEntity> queryable, PagedInput input)Sugar 统一分页处理
说明:支持多库
- 参数
queryable:要继续构建的查询对象 - 参数
input:方法的输入数据 - 类型参数
TEntity:实体类型 - 返回:Sugar 统一分页处理
Fast.SqlSugar.SugarEntityFilter
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public static class SugarEntityFilterSugar 实体过滤器
Fast.SqlSugar.SugarEntityFilter.LoadSugarAop
源码 · 目标:net8.0、net9.0、net10.0
public static void LoadSugarAop(bool isDevelopment, ISqlSugarClient _db, int? sugarSqlExecMaxSeconds = null,
bool diffLog = false, bool disableAop = true, ISqlSugarEntityHandler sqlSugarEntityHandler = null)加载 Sugar AOP
- 参数
isDevelopment:当前环境是否为开发环境 - 参数
_db:当前仓储使用的 SqlSugar 客户端 - 参数
sugarSqlExecMaxSeconds:SQL 执行耗时告警阈值,单位为秒 - 参数
diffLog:是否记录数据变更前后的差异 - 参数
disableAop:是否禁用 SqlSugar AOP 回调 - 参数
sqlSugarEntityHandler:实体保存前后的扩展处理器
Fast.SqlSugar.SugarEntityFilter.LoadSugarFilter
源码 · 目标:net8.0、net9.0、net10.0
public static void LoadSugarFilter(ISqlSugarClient _db, ISqlSugarEntityHandler sqlSugarEntityHandler)加载 Sugar 过滤器
- 参数
_db:当前仓储使用的 SqlSugar 客户端 - 参数
sqlSugarEntityHandler:实体保存前后的扩展处理器
Fast.SqlSugar.ISqlSugarEntityHandler
源码 · 目标:net8.0、net9.0、net10.0
public interface ISqlSugarEntityHandler定义 SqlSugar 实体审计、租户和 SQL 事件处理契约
说明:实现类型的构造函数不得注入 ISqlSugarClient,否则会形成循环依赖实现类型的构造函数不得注入 IHttpContextAccessor 或 HttpContext 否则处理器生命周期可能跨越请求边界并访问已释放的请求资源
Fast.SqlSugar.ISqlSugarEntityHandler.GetConnectionSettings
源码 · 目标:net8.0、net9.0、net10.0
Task<ConnectionSettingsOptions> GetConnectionSettings<TEntity>(ISqlSugarClient sqlSugarClient,
SugarDbTypeAttribute sugarDbType, Type entityType);异步获取指定实体使用的数据库连接配置
- 参数
sqlSugarClient:SqlSugar 客户端实例 - 参数
sugarDbType:实体声明的数据库类型特性;未声明时为null - 参数
entityType:当前实体类型 - 类型参数
TEntity:实体类型 - 返回:实体使用的数据库连接配置;返回
null时使用全局默认配置
Fast.SqlSugar.ISqlSugarEntityHandler.ExecuteAsync
源码 · 目标:net8.0、net9.0、net10.0
Task ExecuteAsync(string rawSql, SugarParameter[] parameters, TimeSpan executeTime, string handlerSql);异步处理已执行的 SQL 语句
- 参数
rawSql:原始 SQL 文本 - 参数
parameters:方法或查询使用的参数集合 - 参数
executeTime:操作耗时 - 参数
handlerSql:要检查或改写的 SQL 文本 - 返回:表示 SQL 处理操作的任务
Fast.SqlSugar.ISqlSugarEntityHandler.ExecuteTimeoutAsync
源码 · 目标:net8.0、net9.0、net10.0
Task ExecuteTimeoutAsync(string fileName, int fileLine, string methodName, string rawSql, SugarParameter[] parameters,
TimeSpan executeTime, string handlerSql, string message);异步处理执行超时的 SQL 语句
- 参数
fileName:源文件名称 - 参数
fileLine:源代码行号 - 参数
methodName:目标方法名称 - 参数
rawSql:原始 SQL 文本 - 参数
parameters:方法或查询使用的参数集合 - 参数
executeTime:操作耗时 - 参数
handlerSql:要检查或改写的 SQL 文本 - 参数
message:要记录或返回的消息 - 返回:表示 SQL 超时处理操作的任务
Fast.SqlSugar.ISqlSugarEntityHandler.ExecuteDiffLogAsync
源码 · 目标:net8.0、net9.0、net10.0
Task ExecuteDiffLogAsync(DiffType diffType, string tableName, string tableDescription, object businessData,
List<List<DiffLogColumnInfo>> beforeColumnList, List<List<DiffLogColumnInfo>> afterColumnList, string rawSql,
SugarParameter[] parameters, TimeSpan? executeTime, string handlerSql);异步记录 SQL 数据变更差异
- 参数
diffType:数据变更类型 - 参数
tableName:数据库表名称 - 参数
tableDescription:数据库表说明 - 参数
businessData:响应中承载的业务数据 - 参数
beforeColumnList:变更前的列值集合 - 参数
afterColumnList:变更后的列值集合 - 参数
rawSql:原始 SQL 文本 - 参数
parameters:方法或查询使用的参数集合 - 参数
executeTime:操作耗时 - 参数
handlerSql:要检查或改写的 SQL 文本 - 返回:表示数据变更差异记录操作的任务
Fast.SqlSugar.ISqlSugarEntityHandler.ExecuteErrorAsync
源码 · 目标:net8.0、net9.0、net10.0
Task ExecuteErrorAsync(string fileName, int fileLine, string methodName, string rawSql, SugarParameter[] parameters,
string handlerSql, SqlSugarException exception);异步处理 SQL 执行异常
- 参数
fileName:源文件名称 - 参数
fileLine:源代码行号 - 参数
methodName:目标方法名称 - 参数
rawSql:原始 SQL 文本 - 参数
parameters:方法或查询使用的参数集合 - 参数
handlerSql:要检查或改写的 SQL 文本 - 参数
exception:SQL 执行期间引发的异常 - 返回:表示 SQL 异常处理操作的任务
Fast.SqlSugar.ISqlSugarEntityHandler.IsSuperAdmin
源码 · 目标:net8.0、net9.0、net10.0
bool IsSuperAdmin();是否为超级管理员
- 返回:满足条件时返回
true;否则返回false
Fast.SqlSugar.ISqlSugarEntityHandler.IsAdmin
源码 · 目标:net8.0、net9.0、net10.0
bool IsAdmin();是否为管理员
- 返回:满足条件时返回
true;否则返回false
Fast.SqlSugar.ISqlSugarEntityHandler.AssignTenantId
源码 · 目标:net8.0、net9.0、net10.0
long? AssignTenantId();获取新实体使用的租户Id
- 返回:租户Id;无法确定时返回
null
Fast.SqlSugar.ISqlSugarEntityHandler.AssignDepartmentId
源码 · 目标:net8.0、net9.0、net10.0
long? AssignDepartmentId();获取新实体使用的部门Id
- 返回:部门Id;无法确定时返回
null
Fast.SqlSugar.ISqlSugarEntityHandler.AssignDepartmentName
源码 · 目标:net8.0、net9.0、net10.0
string AssignDepartmentName();获取新实体使用的部门名称
- 返回:部门名称;无法确定时返回
null
Fast.SqlSugar.ISqlSugarEntityHandler.AssignUserId
源码 · 目标:net8.0、net9.0、net10.0
long? AssignUserId();获取新实体使用的用户Id
- 返回:用户Id;无法确定时返回
null
Fast.SqlSugar.ISqlSugarEntityHandler.AssignUserName
源码 · 目标:net8.0、net9.0、net10.0
string AssignUserName();获取新实体使用的用户名称
- 返回:用户名称;无法确定时返回
null
Fast.SqlSugar.IBaseEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public interface IBaseEntity : IDatabaseEntityEntity 基类接口
Fast.SqlSugar.IBaseEntity.CreatedUserId
源码 · 目标:net8.0、net9.0、net10.0
long? CreatedUserId { get; set; }创建者用户Id
Fast.SqlSugar.IBaseEntity.CreatedUserName
源码 · 目标:net8.0、net9.0、net10.0
string CreatedUserName { get; set; }创建者用户名称
Fast.SqlSugar.IBaseEntity.CreatedTime
源码 · 目标:net8.0、net9.0、net10.0
DateTime? CreatedTime { get; set; }创建时间
Fast.SqlSugar.IBaseEntity.UpdatedUserId
源码 · 目标:net8.0、net9.0、net10.0
long? UpdatedUserId { get; set; }更新者用户Id
Fast.SqlSugar.IBaseEntity.UpdatedUserName
源码 · 目标:net8.0、net9.0、net10.0
string UpdatedUserName { get; set; }更新者用户名称
Fast.SqlSugar.IBaseEntity.UpdatedTime
源码 · 目标:net8.0、net9.0、net10.0
DateTime? UpdatedTime { get; set; }更新时间
Fast.SqlSugar.IBaseRecordEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public interface IBaseRecordEntity : IDatabaseEntity自增主键记录 Entity 基类接口
Fast.SqlSugar.IBaseRecordEntity.Device
源码 · 目标:net8.0、net9.0、net10.0
string Device { get; set; }设备
Fast.SqlSugar.IBaseRecordEntity.OS
源码 · 目标:net8.0、net9.0、net10.0
string OS { get; set; }操作系统(版本)
Fast.SqlSugar.IBaseRecordEntity.Browser
源码 · 目标:net8.0、net9.0、net10.0
string Browser { get; set; }浏览器(版本)
Fast.SqlSugar.IBaseRecordEntity.Province
源码 · 目标:net8.0、net9.0、net10.0
string Province { get; set; }省份
Fast.SqlSugar.IBaseRecordEntity.City
源码 · 目标:net8.0、net9.0、net10.0
string City { get; set; }城市
Fast.SqlSugar.IBaseRecordEntity.Ip
源码 · 目标:net8.0、net9.0、net10.0
string Ip { get; set; }Ip
Fast.SqlSugar.IBaseRecordEntity.CreatedUserId
源码 · 目标:net8.0、net9.0、net10.0
long? CreatedUserId { get; set; }创建者用户Id
Fast.SqlSugar.IBaseRecordEntity.CreatedUserName
源码 · 目标:net8.0、net9.0、net10.0
string CreatedUserName { get; set; }创建者用户名称
Fast.SqlSugar.IBaseRecordEntity.CreatedTime
源码 · 目标:net8.0、net9.0、net10.0
DateTime? CreatedTime { get; set; }创建时间
Fast.SqlSugar.IBaseRecordEntity.RecordCreate
源码 · 目标:net8.0、net9.0、net10.0
void RecordCreate(HttpContext httpContext);记录表创建
- 参数
httpContext:当前请求上下文;非请求环境中可以为null
Fast.SqlSugar.IBaseTEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public interface IBaseTEntity : IDatabaseEntity租户 Entity 基类接口
Fast.SqlSugar.IBaseTEntity.TenantId
源码 · 目标:net8.0、net9.0、net10.0
long TenantId { get; set; }租户Id
Fast.SqlSugar.IDatabaseEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public interface IDatabaseEntity实体接口
Fast.SqlSugar.IDeletedEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public interface IDeletedEntity : IDatabaseEntity软删除实体接口
Fast.SqlSugar.IDeletedEntity.IsDeleted
源码 · 目标:net8.0、net9.0、net10.0
bool IsDeleted { get; set; }软删除标识
Fast.SqlSugar.IDepartmentEntity
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public interface IDepartmentEntity : IDatabaseEntityEntity 部门基类接口
Fast.SqlSugar.IDepartmentEntity.DepartmentId
源码 · 目标:net8.0、net9.0、net10.0
long? DepartmentId { get; set; }部门Id
Fast.SqlSugar.IDepartmentEntity.DepartmentName
源码 · 目标:net8.0、net9.0、net10.0
string DepartmentName { get; set; }部门名称
Fast.SqlSugar.IUpdateVersion
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public interface IUpdateVersion : IDatabaseEntity行版本实体接口
说明:仅单条实体更新会触发行版本检查,冲突时抛出 VersionExceptions
Fast.SqlSugar.IUpdateVersion.RowVersion
源码 · 目标:net8.0、net9.0、net10.0
long RowVersion { get; set; }更新版本控制字段
Fast.SqlSugar.ConnectionSettingsOptions
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class ConnectionSettingsOptions : IPostConfigure连接字符串配置
Fast.SqlSugar.ConnectionSettingsOptions.ConnectionId
源码 · 目标:net8.0、net9.0、net10.0
public string ConnectionId { get; set; }SqlSugarClient 连接Id
Fast.SqlSugar.ConnectionSettingsOptions.DbType
源码 · 目标:net8.0、net9.0、net10.0
public DbType? DbType { get; set; }数据库类型,用于区分使用的是那个类型的数据库
Fast.SqlSugar.ConnectionSettingsOptions.ServiceIp
源码 · 目标:net8.0、net9.0、net10.0
public string ServiceIp { get; set; }服务器 Ip 地址
Fast.SqlSugar.ConnectionSettingsOptions.Port
源码 · 目标:net8.0、net9.0、net10.0
public int? Port { get; set; }端口号
说明:MySql:3306SqlServer:1433Oracle:1521PostgreSQL:5432MongoDb:27017PostConfigure 将未指定的端口设为 1433,不会根据数据库类型自动选择端口。
Fast.SqlSugar.ConnectionSettingsOptions.DbName
源码 · 目标:net8.0、net9.0、net10.0
public string DbName { get; set; }数据库名称
Fast.SqlSugar.ConnectionSettingsOptions.DbUser
源码 · 目标:net8.0、net9.0、net10.0
public string DbUser { get; set; }数据库用户
Fast.SqlSugar.ConnectionSettingsOptions.DbPwd
源码 · 目标:net8.0、net9.0、net10.0
public string DbPwd { get; set; }数据库密码
Fast.SqlSugar.ConnectionSettingsOptions.MaxPoolSize
源码 · 目标:net8.0、net9.0、net10.0
public int? MaxPoolSize { get; set; }最大连接池数量
说明:PostConfigure 将未指定的值设为 100。 自动生成 MySql、MySqlConnector、SqlServer 和 PostgreSQL 连接字符串时使用此值。 使用 CustomConnectionStr 时,应在自定义连接字符串中配置连接池。
Fast.SqlSugar.ConnectionSettingsOptions.CommandTimeOut
源码 · 目标:net8.0、net9.0、net10.0
public int? CommandTimeOut { get; set; }超时时间,单位为秒
Fast.SqlSugar.ConnectionSettingsOptions.SugarSqlExecMaxSeconds
源码 · 目标:net8.0、net9.0、net10.0
public int? SugarSqlExecMaxSeconds { get; set; }SqlSugar SQL 执行最大秒数,如果超过记录警告日志
Fast.SqlSugar.ConnectionSettingsOptions.DiffLog
源码 · 目标:net8.0、net9.0、net10.0
public bool? DiffLog { get; set; }差异日志
Fast.SqlSugar.ConnectionSettingsOptions.DisableAop
源码 · 目标:net8.0、net9.0、net10.0
public bool? DisableAop { get; set; }禁用 SqlSugar 的 AOP
说明:如果是通过 ISqlSugarEntityHandler 进行保存日志到数据库中必须要将相关 AOP 中涉及到的日志表,单独进行分库设置,并且禁用 AOP或通过 new SqlSugarClient() 的方式进行保存。不然会存在死循环的问题
Fast.SqlSugar.ConnectionSettingsOptions.CustomConnectionStr
源码 · 目标:net8.0、net9.0、net10.0
public virtual string CustomConnectionStr { get; set; }自定义连接字符串
说明:非空白时直接使用此连接字符串,并忽略 SlaveConnectionList。 服务器、端口、数据库、凭据及连接池字段不会再用于拼接主库连接字符串。
Fast.SqlSugar.ConnectionSettingsOptions.SlaveConnectionList
源码 · 目标:net8.0、net9.0、net10.0
public List<SlaveConnectionInfo> SlaveConnectionList { get; set; }从库信息
说明:一般默认库或者主库不建议设置从库
Fast.SqlSugar.ConnectionSettingsOptions.PostConfigure
源码 · 目标:net8.0、net9.0、net10.0
public void PostConfigure()说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.SnowflakeSettingsOptions
源码 · 目标:net8.0、net9.0、net10.0
[SuppressSniffer]
public class SnowflakeSettingsOptions : IPostConfigure雪花Id配置
Fast.SqlSugar.SnowflakeSettingsOptions.WorkerId
源码 · 目标:net8.0、net9.0、net10.0
[Required]
public ushort? WorkerId { get; set; }工作Id
Fast.SqlSugar.SnowflakeSettingsOptions.PostConfigure
源码 · 目标:net8.0、net9.0、net10.0
public void PostConfigure()说明继承自接口或基类,需结合对应声明阅读。
Fast.SqlSugar.ISqlSugarRepository
源码 · 目标:net8.0、net9.0、net10.0
public partial interface ISqlSugarRepository<TEntity> : ISqlSugarClient where TEntity : class, new()SqlSugar 仓储接口
Fast.SqlSugar.ISqlSugarRepository.SupportsLogicDelete
源码 · 目标:net8.0、net9.0、net10.0
bool SupportsLogicDelete { get; }是否支持逻辑删除
说明:TEntity 继承了 IDeletedEntity 才有用
Fast.SqlSugar.ISqlSugarRepository.SupportsRowVersion
源码 · 目标:net8.0、net9.0、net10.0
bool SupportsRowVersion { get; }是否支持行版本控制(乐观锁)
说明:TEntity 继承了 IUpdateVersion 才有用
Fast.SqlSugar.ISqlSugarRepository.IsSplitTable
源码 · 目标:net8.0、net9.0、net10.0
bool IsSplitTable { get; }是否分表
说明:TEntity 头部标记 SplitTableAttribute 特性才有用
Fast.SqlSugar.ISqlSugarRepository.DatabaseInfo
源码 · 目标:net8.0、net9.0、net10.0
ConnectionSettingsOptions DatabaseInfo { get; }当前仓储的数据库信息
Fast.SqlSugar.ISqlSugarRepository.Change
源码 · 目标:net8.0、net9.0、net10.0
ISqlSugarRepository<TChangeEntity> Change<TChangeEntity>() where TChangeEntity : class, new();切换仓储/切换租户仓储
- 类型参数
TChangeEntity:临时切换使用的实体类型 - 返回:切换仓储/切换租户仓储
Fast.SqlSugar.ISqlSugarRepository
源码 · 目标:net8.0、net9.0、net10.0
public partial interface ISqlSugarRepository<TEntity>SqlSugar 删除仓储接口
Fast.SqlSugar.ISqlSugarRepository.Delete
源码 · 目标:net8.0、net9.0、net10.0
int Delete(TEntity entity);删除一条记录
- 参数
entity:要处理的实体 - 返回:实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.DeleteAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> DeleteAsync(TEntity entity);删除一条记录
- 参数
entity:要处理的实体 - 返回:表示异步删除一条记录的任务,任务结果为实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.Delete
源码 · 目标:net8.0、net9.0、net10.0
int Delete(object key);删除一条记录
- 参数
key:要删除实体的主键值 - 返回:实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.DeleteAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> DeleteAsync(object key);删除一条记录
- 参数
key:要删除实体的主键值 - 返回:表示异步删除一条记录的任务,任务结果为实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.Delete
源码 · 目标:net8.0、net9.0、net10.0
int Delete(params object[] keys);删除多条记录
- 参数
keys:用于定位目标数据的键集合 - 返回:实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.DeleteAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> DeleteAsync(params object[] keys);删除多条记录
- 参数
keys:用于定位目标数据的键集合 - 返回:表示异步删除多条记录的任务,任务结果为实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.Delete
源码 · 目标:net8.0、net9.0、net10.0
int Delete(params TEntity[] entities);删除多条记录
- 参数
entities:要批量处理的实体集合 - 返回:实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.DeleteAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> DeleteAsync(params TEntity[] entities);删除多条记录
- 参数
entities:要批量处理的实体集合 - 返回:表示异步删除多条记录的任务,任务结果为实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.Delete
源码 · 目标:net8.0、net9.0、net10.0
int Delete(IEnumerable<TEntity> entities);删除多条记录
- 参数
entities:要批量处理的实体集合 - 返回:实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.DeleteAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> DeleteAsync(IEnumerable<TEntity> entities);删除多条记录
- 参数
entities:要批量处理的实体集合 - 返回:表示异步删除多条记录的任务,任务结果为实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.Delete
源码 · 目标:net8.0、net9.0、net10.0
int Delete(Expression<Func<TEntity, bool>> whereExpression);自定义条件删除记录
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.DeleteAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> DeleteAsync(Expression<Func<TEntity, bool>> whereExpression);自定义条件删除记录
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:表示异步自定义条件删除记录的任务,任务结果为实际删除的项数
Fast.SqlSugar.ISqlSugarRepository.LogicDelete
源码 · 目标:net8.0、net9.0、net10.0
int LogicDelete(Expression<Func<TEntity, bool>> whereExpression);自定义条件逻辑删除记录
说明:注意,实体必须继承 IDeletedEntity
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:自定义条件逻辑删除记录
Fast.SqlSugar.ISqlSugarRepository.LogicDeleteAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> LogicDeleteAsync(Expression<Func<TEntity, bool>> whereExpression);自定义条件逻辑删除记录
说明:注意,实体必须继承 IDeletedEntity
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:表示异步自定义条件逻辑删除记录的任务,任务结果为自定义条件逻辑删除记录
Fast.SqlSugar.ISqlSugarRepository
源码 · 目标:net8.0、net9.0、net10.0
public partial interface ISqlSugarRepository<TEntity>SqlSugar 插入仓储接口
Fast.SqlSugar.ISqlSugarRepository.Insert
源码 · 目标:net8.0、net9.0、net10.0
int Insert(TEntity entity);新增一条记录
- 参数
entity:要处理的实体 - 返回:新增一条记录
Fast.SqlSugar.ISqlSugarRepository.InsertAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> InsertAsync(TEntity entity);新增一条记录
- 参数
entity:要处理的实体 - 返回:表示异步新增一条记录的任务,任务结果为新增一条记录
Fast.SqlSugar.ISqlSugarRepository.Insert
源码 · 目标:net8.0、net9.0、net10.0
int Insert(params TEntity[] entities);新增多条记录
- 参数
entities:要批量处理的实体集合 - 返回:新增多条记录
Fast.SqlSugar.ISqlSugarRepository.InsertAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> InsertAsync(params TEntity[] entities);新增多条记录
- 参数
entities:要批量处理的实体集合 - 返回:表示异步新增多条记录的任务,任务结果为新增多条记录
Fast.SqlSugar.ISqlSugarRepository.Insert
源码 · 目标:net8.0、net9.0、net10.0
int Insert(IEnumerable<TEntity> entities);新增多条记录
- 参数
entities:要批量处理的实体集合 - 返回:新增多条记录
Fast.SqlSugar.ISqlSugarRepository.InsertAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> InsertAsync(IEnumerable<TEntity> entities);新增多条记录
- 参数
entities:要批量处理的实体集合 - 返回:表示异步新增多条记录的任务,任务结果为新增多条记录
Fast.SqlSugar.ISqlSugarRepository.InsertReturnIdentity
源码 · 目标:net8.0、net9.0、net10.0
int InsertReturnIdentity(TEntity entity);新增一条记录返回自增Id
- 参数
entity:要处理的实体 - 返回:新增一条记录返回自增Id
Fast.SqlSugar.ISqlSugarRepository.InsertReturnIdentityAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> InsertReturnIdentityAsync(TEntity entity);新增一条记录返回自增Id
- 参数
entity:要处理的实体 - 返回:表示异步新增一条记录返回自增Id的任务,任务结果为新增一条记录返回自增Id
Fast.SqlSugar.ISqlSugarRepository.ExecuteReturnBigIdentity
源码 · 目标:net8.0、net9.0、net10.0
long ExecuteReturnBigIdentity(TEntity entity);新增一条记录返回 Long 类型的自增Id
- 参数
entity:要处理的实体 - 返回:新增一条记录返回 Long 类型的自增Id
Fast.SqlSugar.ISqlSugarRepository.ExecuteReturnBigIdentityAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<long> ExecuteReturnBigIdentityAsync(TEntity entity);新增一条记录返回 Long 类型的自增Id
- 参数
entity:要处理的实体 - 返回:表示异步新增一条记录返回 Long 类型的自增Id的任务,任务结果为新增一条记录返回 Long 类型的自增Id
Fast.SqlSugar.ISqlSugarRepository.InsertReturnEntity
源码 · 目标:net8.0、net9.0、net10.0
TEntity InsertReturnEntity(TEntity entity);新增一条记录返回新增的数据
- 参数
entity:要处理的实体 - 返回:新增一条记录返回新增的数据
Fast.SqlSugar.ISqlSugarRepository.InsertReturnEntityAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<TEntity> InsertReturnEntityAsync(TEntity entity);新增一条记录返回新增的数据
- 参数
entity:要处理的实体 - 返回:表示异步新增一条记录返回新增的数据的任务,任务结果为新增一条记录返回新增的数据
Fast.SqlSugar.ISqlSugarRepository
源码 · 目标:net8.0、net9.0、net10.0
public partial interface ISqlSugarRepository<TEntity>SqlSugar 查询仓储接口
Fast.SqlSugar.ISqlSugarRepository.Count
源码 · 目标:net8.0、net9.0、net10.0
int Count(Expression<Func<TEntity, bool>> whereExpression = null);获取总数
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:满足条件的项数
Fast.SqlSugar.ISqlSugarRepository.CountAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> CountAsync(Expression<Func<TEntity, bool>> whereExpression = null);获取总数
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:表示异步获取总数的任务,任务结果为满足条件的项数
Fast.SqlSugar.ISqlSugarRepository.Any
源码 · 目标:net8.0、net9.0、net10.0
bool Any(Expression<Func<TEntity, bool>> whereExpression);检查是否存在
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:满足条件时返回
true;否则返回false
Fast.SqlSugar.ISqlSugarRepository.AnyAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<bool> AnyAsync(Expression<Func<TEntity, bool>> whereExpression);检查是否存在
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:满足条件时返回
true;否则返回false
Fast.SqlSugar.ISqlSugarRepository.SingleOrDefault
源码 · 目标:net8.0、net9.0、net10.0
TEntity SingleOrDefault(object Id);根据主键获取实体
- 参数
Id:唯一标识 - 返回:根据主键获取实体
Fast.SqlSugar.ISqlSugarRepository.SingleOrDefaultAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<TEntity> SingleOrDefaultAsync(object Id);根据主键获取实体
- 参数
Id:唯一标识 - 返回:表示异步根据主键获取实体的任务,任务结果为根据主键获取实体
Fast.SqlSugar.ISqlSugarRepository.SingleOrDefault
源码 · 目标:net8.0、net9.0、net10.0
TEntity SingleOrDefault(Expression<Func<TEntity, bool>> whereExpression);根据条件获取实体
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:根据条件获取实体
Fast.SqlSugar.ISqlSugarRepository.SingleOrDefaultAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<TEntity> SingleOrDefaultAsync(Expression<Func<TEntity, bool>> whereExpression);根据条件获取实体
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:表示异步根据条件获取实体的任务,任务结果为根据条件获取实体
Fast.SqlSugar.ISqlSugarRepository.FirstOrDefault
源码 · 目标:net8.0、net9.0、net10.0
TEntity FirstOrDefault(Expression<Func<TEntity, bool>> whereExpression);获取一个实体
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:获取到的一个实体
Fast.SqlSugar.ISqlSugarRepository.FirstOrDefaultAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<TEntity> FirstOrDefaultAsync(Expression<Func<TEntity, bool>> whereExpression);获取一个实体
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:表示异步获取一个实体的任务,任务结果为获取到的一个实体
Fast.SqlSugar.ISqlSugarRepository.ToList
源码 · 目标:net8.0、net9.0、net10.0
List<TEntity> ToList();获取列表
- 返回:获取到的列表集合
Fast.SqlSugar.ISqlSugarRepository.ToListAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<List<TEntity>> ToListAsync();获取列表
- 返回:表示异步获取列表的任务,任务结果为获取到的列表集合
Fast.SqlSugar.ISqlSugarRepository.ToList
源码 · 目标:net8.0、net9.0、net10.0
List<TEntity> ToList(Expression<Func<TEntity, bool>> whereExpression);获取列表
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:获取到的列表集合
Fast.SqlSugar.ISqlSugarRepository.ToListAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<List<TEntity>> ToListAsync(Expression<Func<TEntity, bool>> whereExpression);获取列表
- 参数
whereExpression:用于筛选实体的条件表达式 - 返回:表示异步获取列表的任务,任务结果为获取到的列表集合
Fast.SqlSugar.ISqlSugarRepository.ToList
源码 · 目标:net8.0、net9.0、net10.0
List<TEntity> ToList(Expression<Func<TEntity, bool>> whereExpression, Expression<Func<TEntity, object>> orderByExpression,
OrderByType orderByType = OrderByType.Asc);获取列表
- 参数
whereExpression:用于筛选实体的条件表达式 - 参数
orderByExpression:用于指定排序字段的表达式 - 参数
orderByType:排序方向 - 返回:获取到的列表集合
Fast.SqlSugar.ISqlSugarRepository.ToListAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<List<TEntity>> ToListAsync(Expression<Func<TEntity, bool>> whereExpression,
Expression<Func<TEntity, object>> orderByExpression, OrderByType orderByType = OrderByType.Asc);获取列表
- 参数
whereExpression:用于筛选实体的条件表达式 - 参数
orderByExpression:用于指定排序字段的表达式 - 参数
orderByType:排序方向 - 返回:表示异步获取列表的任务,任务结果为获取到的列表集合
Fast.SqlSugar.ISqlSugarRepository
源码 · 目标:net8.0、net9.0、net10.0
public partial interface ISqlSugarRepository<TEntity>SqlSugar 更新仓储接口
Fast.SqlSugar.ISqlSugarRepository.Update
源码 · 目标:net8.0、net9.0、net10.0
int Update(TEntity entity, bool isNoUpdateNull = false);更新一条记录
- 参数
entity:要处理的实体 - 参数
isNoUpdateNull:更新时是否跳过值为null的属性 - 返回:更新一条记录
Fast.SqlSugar.ISqlSugarRepository.UpdateAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> UpdateAsync(TEntity entity, bool isNoUpdateNull = false);更新一条记录
- 参数
entity:要处理的实体 - 参数
isNoUpdateNull:更新时是否跳过值为null的属性 - 返回:表示异步更新一条记录的任务,任务结果为更新一条记录
Fast.SqlSugar.ISqlSugarRepository.Update
源码 · 目标:net8.0、net9.0、net10.0
int Update(params TEntity[] entities);更新多条记录
- 参数
entities:要批量处理的实体集合 - 返回:更新多条记录
Fast.SqlSugar.ISqlSugarRepository.UpdateAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> UpdateAsync(params TEntity[] entities);更新多条记录
- 参数
entities:要批量处理的实体集合 - 返回:表示异步更新多条记录的任务,任务结果为更新多条记录
Fast.SqlSugar.ISqlSugarRepository.Update
源码 · 目标:net8.0、net9.0、net10.0
int Update(IEnumerable<TEntity> entities);更新多条记录
- 参数
entities:要批量处理的实体集合 - 返回:更新多条记录
Fast.SqlSugar.ISqlSugarRepository.UpdateAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> UpdateAsync(IEnumerable<TEntity> entities);更新多条记录
- 参数
entities:要批量处理的实体集合 - 返回:表示异步更新多条记录的任务,任务结果为更新多条记录
Fast.SqlSugar.ISqlSugarRepository.UpdateNoPrimaryKey
源码 · 目标:net8.0、net9.0、net10.0
int UpdateNoPrimaryKey(TEntity entity, Expression<Func<TEntity, object>> columns);无主键更新一条记录
- 参数
entity:要处理的实体 - 参数
columns:参与更新的列集合 - 返回:无主键更新一条记录
Fast.SqlSugar.ISqlSugarRepository.UpdateNoPrimaryKeyAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> UpdateNoPrimaryKeyAsync(TEntity entity, Expression<Func<TEntity, object>> columns);无主键更新一条记录
- 参数
entity:要处理的实体 - 参数
columns:参与更新的列集合 - 返回:表示异步无主键更新一条记录的任务,任务结果为无主键更新一条记录
Fast.SqlSugar.ISqlSugarRepository.UpdateNoPrimaryKey
源码 · 目标:net8.0、net9.0、net10.0
int UpdateNoPrimaryKey(List<TEntity> entity, Expression<Func<TEntity, object>> columns);无主键更新多条记录
- 参数
entity:要处理的实体 - 参数
columns:参与更新的列集合 - 返回:无主键更新多条记录
Fast.SqlSugar.ISqlSugarRepository.UpdateNoPrimaryKeyAsync
源码 · 目标:net8.0、net9.0、net10.0
Task<int> UpdateNoPrimaryKeyAsync(List<TEntity> entity, Expression<Func<TEntity, object>> columns);无主键更新多条记录
- 参数
entity:要处理的实体 - 参数
columns:参与更新的列集合 - 返回:表示异步无主键更新多条记录的任务,任务结果为无主键更新多条记录
