Files
OnboardXAdmin/SimpleAdmin.SqlSugar/SimpleAdmin.SqlSugar.xml
T
2025-09-29 13:48:36 +08:00

666 lines
26 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>SimpleAdmin.SqlSugar</name>
</assembly>
<members>
<member name="T:SimpleAdmin.SqlSugar.CommonStatusConst">
<summary>
通用状态常量
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.CommonStatusConst.ENABLE">
<summary>
启用
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.CommonStatusConst.DISABLED">
<summary>
停用
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.EffTypeConst">
<summary>
前端控件作用类型常量
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.INPUT">
<summary>
输入框
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.TEXTAREA">
<summary>
文本框
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.SELECT">
<summary>
下拉框
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.RADIO">
<summary>
单选框
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.CHECKBOX">
<summary>
复选框
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.DATEPICKER">
<summary>
日期选择器
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.TIMEPICKER">
<summary>
时间选择器
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.INPUT_NUMBER">
<summary>
数字输入框
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.SLIDER">
<summary>
滑动数字条
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.EffTypeConst.SWITCH">
<summary>
下拉框
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.SqlSugarConst">
<summary>
SqlSugar系统常量类
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.SqlSugarConst.DB_DEFAULT">
<summary>
默认库ConfigId
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.SqlSugarConst.DB_PRIMARY_KEY">
<summary>
默认表主键
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.SqlSugarConst.N_VAR_CHAR_MAX">
<summary>
varchar(max)
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.SqlSugarConst.N_VAR_CHAR_4000">
<summary>
varchar(4000)
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.SqlSugarConst.N_VAR_CHAR_20">
<summary>
varchar(20)
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.SqlSugarConst.LONG_TEXT">
<summary>
mysql的longtext
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.SqlSugarConst.TEXT">
<summary>
sqlite的text
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.DbContext">
<summary>
数据库上下文对象
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.DbContext.DB_CONFIGS">
<summary>
读取配置文件中的 ConnectionStrings:SqlSugar 配置节点
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.DbContext.DB">
<summary>
SqlSugar 数据库实例
</summary>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbContext.ExternalServicesSetting(SqlSugar.SqlSugarScopeProvider,SimpleAdmin.SqlSugar.SqlSugarConfig)">
<summary>
实体拓展配置,自定义类型多库兼容
</summary>
<param name="db"></param>
<param name="config"></param>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbContext.AopSetting(SqlSugar.SqlSugarScopeProvider)">
<summary>
Aop设置
</summary>
<param name="db"></param>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbContext.MoreSetting(SqlSugar.SqlSugarScopeProvider,SqlSugar.DbType)">
<summary>
实体更多配置
</summary>
<param name="db">db</param>
<param name="dbType">数据库类型</param>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbContext.FilterSetting(SqlSugar.SqlSugarScopeProvider)">
<summary>
过滤器设置
</summary>
<param name="db"></param>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbContext.LogicDeletedEntityFilter(SqlSugar.SqlSugarScopeProvider)">
<summary>
假删除过滤器
</summary>
<param name="db"></param>
</member>
<member name="T:SimpleAdmin.SqlSugar.DbRepository`1">
<summary>
仓储模式对象
</summary>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbRepository`1.InsertOrBulkCopy(System.Collections.Generic.List{`0},System.Int32)">
<summary>
批量插入判断走普通导入还是大数据
</summary>
<param name="data">数据</param>
<param name="threshold">阈值</param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbRepository`1.GetListAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,`0}})">
<summary>
获取列表指定多个字段
</summary>
<param name="whereExpression">查询条件</param>
<param name="selectExpression">查询字段</param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbRepository`1.GetListAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.String}})">
<summary>
获取列表指定单个字段
</summary>
<param name="whereExpression">查询条件</param>
<param name="selectExpression">查询字段</param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbRepository`1.GetListAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.Int64}})">
<summary>
获取列表指定单个字段
</summary>
<param name="whereExpression">查询条件</param>
<param name="selectExpression">查询字段</param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbRepository`1.GetFirstAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.String}})">
<summary>
获取指定表的单个字段
</summary>
<param name="whereExpression">查询条件</param>
<param name="selectExpression">查询字段</param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbRepository`1.GetFirstAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.Int64}})">
<summary>
获取指定表的单个字段
</summary>
<param name="whereExpression">查询条件</param>
<param name="selectExpression">查询字段</param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbRepository`1.GetFirstSplitTableAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.DateTime,System.DateTime)">
<summary>
根据条件查询获取自动分表的单个数据
</summary>
<param name="whereExpression">条件表达式</param>
<param name="startTime">开始时间</param>
<param name="endTime">结束时间</param>
<returns>实体</returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.DbRepository`1.GetFirstSplitTableAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Func{System.Collections.Generic.List{SqlSugar.SplitTableInfo},System.Collections.Generic.IEnumerable{SqlSugar.SplitTableInfo}})">
<summary>
根据条件查询获取自动分表的单个数据
</summary>
<param name="whereExpression">条件表达式</param>
<param name="getTableNamesFunc">分表查询表达式</param>
<returns>实体</returns>
</member>
<member name="T:SimpleAdmin.SqlSugar.SqlSugarConfig">
<summary>
SqlSugar数据库配置
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarConfig.IsUnderLine">
<summary>
是否驼峰转下划线
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.LinqPagedList`1">
<summary>
Linq分页泛型集合
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:SimpleAdmin.SqlSugar.PrimaryKeyEntity">
<summary>
主键实体基类
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.PrimaryKeyEntity.Id">
<summary>
主键Id
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.PrimaryKeyEntity.ExtJson">
<summary>
拓展信息
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.BaseEntity">
<summary>
框架实体基类
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.BaseEntity.CreateTime">
<summary>
创建时间
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.BaseEntity.UpdateTime">
<summary>
更新时间
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.BaseEntity.CreateUserId">
<summary>
创建者Id
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.BaseEntity.UpdateUserId">
<summary>
修改者Id
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.BaseEntity.CreateUser">
<summary>
创建人
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.BaseEntity.UpdateUser">
<summary>
更新人
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.BaseEntity.IsDelete">
<summary>
软删除
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.DataEntityBase">
<summary>
业务数据实体基类(数据权限)
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.DataEntityBase.CreateOrgId">
<summary>
创建者部门Id
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.ISqlSugarEntitySeedData`1">
<summary>
实体种子数据接口
</summary>
<typeparam name="TEntity"></typeparam>
</member>
<member name="M:SimpleAdmin.SqlSugar.ISqlSugarEntitySeedData`1.SeedData">
<summary>
种子数据
</summary>
<returns></returns>
</member>
<member name="T:SimpleAdmin.SqlSugar.SqlSugarPageExtension">
<summary>
SqlSugar分页拓展类
</summary>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarPageExtension.ToPagedList``1(SqlSugar.ISugarQueryable{``0},System.Int32,System.Int32)">
<summary>
SqlSugar分页扩展
</summary>
<typeparam name="TEntity"></typeparam>
<param name="queryable"></param>
<param name="pageNum"></param>
<param name="pageSize"></param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarPageExtension.ToPagedListAsync``1(SqlSugar.ISugarQueryable{``0},System.Int32,System.Int32)">
<summary>
SqlSugar分页扩展
</summary>
<typeparam name="TEntity"></typeparam>
<param name="queryable"></param>
<param name="pageNum"></param>
<param name="pageSize"></param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarPageExtension.ToPagedList``2(SqlSugar.ISugarQueryable{``0},System.Int32,System.Int32,System.Linq.Expressions.Expression{System.Func{``0,``1}})">
<summary>
SqlSugar分页扩展
</summary>
<typeparam name="TEntity"></typeparam>
<typeparam name="TResult"></typeparam>
<param name="queryable"></param>
<param name="pageNum"></param>
<param name="pageSize"></param>
<param name="expression"></param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarPageExtension.ToPagedListAsync``2(SqlSugar.ISugarQueryable{``0},System.Int32,System.Int32,System.Linq.Expressions.Expression{System.Func{``0,``1}})">
<summary>
SqlSugar分页扩展
</summary>
<typeparam name="TEntity"></typeparam>
<typeparam name="TResult"></typeparam>
<param name="queryable"></param>
<param name="pageNum"></param>
<param name="pageSize"></param>
<param name="expression"></param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarPageExtension.LinqPagedList``1(System.Collections.Generic.List{``0},System.Int32,System.Int32)">
<summary>
分页查询
</summary>
<typeparam name="T"></typeparam>
<param name="list">数据列表</param>
<param name="pageNum">当前页</param>
<param name="pageSize">每页数量</param>
<returns>分页集合</returns>
</member>
<member name="T:SimpleAdmin.SqlSugar.SqlSugarPagedList`1">
<summary>
SqlSugar 分页泛型集合
</summary>
<typeparam name="TEntity"></typeparam>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarPagedList`1.PageNum">
<summary>
页码
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarPagedList`1.PageSize">
<summary>
数量
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarPagedList`1.Total">
<summary>
总条数
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarPagedList`1.Pages">
<summary>
总页数
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarPagedList`1.List">
<summary>
当前页集合
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarPagedList`1.HasPrevPages">
<summary>
是否有上一页
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarPagedList`1.HasNextPages">
<summary>
是否有下一页
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.SqlSugarUnitOfWork">
<summary>
SqlSugar 事务和工作单元
</summary>
</member>
<member name="F:SimpleAdmin.SqlSugar.SqlSugarUnitOfWork._sqlSugarClient">
<summary>
SqlSugar 对象
</summary>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUnitOfWork.#ctor(SqlSugar.ISqlSugarClient,Microsoft.Extensions.Logging.ILogger{SimpleAdmin.SqlSugar.SqlSugarUnitOfWork})">
<summary>
构造函数
</summary>
<param name="sqlSugarClient"></param>
<param name="logger"></param>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUnitOfWork.BeginTransaction(Microsoft.AspNetCore.Mvc.Filters.FilterContext,MoYu.DatabaseAccessor.UnitOfWorkAttribute)">
<summary>
开启工作单元处理
</summary>
<param name="context"></param>
<param name="unitOfWork"></param>
<exception cref="T:System.NotImplementedException"></exception>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUnitOfWork.CommitTransaction(Microsoft.AspNetCore.Mvc.Filters.FilterContext,MoYu.DatabaseAccessor.UnitOfWorkAttribute)">
<summary>
提交工作单元处理
</summary>
<param name="resultContext"></param>
<param name="unitOfWork"></param>
<exception cref="T:System.NotImplementedException"></exception>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUnitOfWork.RollbackTransaction(Microsoft.AspNetCore.Mvc.Filters.FilterContext,MoYu.DatabaseAccessor.UnitOfWorkAttribute)">
<summary>
回滚工作单元处理
</summary>
<param name="resultContext"></param>
<param name="unitOfWork"></param>
<exception cref="T:System.NotImplementedException"></exception>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUnitOfWork.OnCompleted(Microsoft.AspNetCore.Mvc.Filters.FilterContext,Microsoft.AspNetCore.Mvc.Filters.FilterContext)">
<summary>
执行完毕(无论成功失败)
</summary>
<param name="context"></param>
<param name="resultContext"></param>
<exception cref="T:System.NotImplementedException"></exception>
</member>
<member name="T:SimpleAdmin.SqlSugar.Filter.IDeletedFilter">
<summary>
假删除接口过滤器
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.Filter.IDeletedFilter.IsDelete">
<summary>
软删除
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.Startup">
<summary>
AppStartup启动类
</summary>
</member>
<member name="M:SimpleAdmin.SqlSugar.Startup.ConfigureServices(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
<summary>
ConfigureServices中不能解析服务,比如App.GetService(),尤其是不能在ConfigureServices中获取诸如缓存等数据进行初始化,应该在Configure中进行
服务都还没初始化完成,会导致内存中存在多份 IOC 容器!!
正确应该在 Configure 中,这个时候服务(IServiceCollection 已经完成 BuildServiceProvider() 操作了
</summary>
<param name="services"></param>
</member>
<member name="M:SimpleAdmin.SqlSugar.Startup.CheckSameConfigId">
<summary>
检查是否有相同的ConfigId
</summary>
<returns></returns>
</member>
<member name="T:SimpleAdmin.SqlSugar.CodeFirstUtils">
<summary>
CodeFirst功能类
</summary>
</member>
<member name="M:SimpleAdmin.SqlSugar.CodeFirstUtils.CodeFirst(SimpleAdmin.Core.BaseOptions,System.String)">
<summary>
CodeFirst生成数据库表结构和种子数据
</summary>
<param name="options">codefirst选项</param>
<param name="assemblyName">程序集名称</param>
</member>
<member name="M:SimpleAdmin.SqlSugar.CodeFirstUtils.InitTable(System.String)">
<summary>
初始化数据库表结构
</summary>
<param name="assemblyName">程序集名称</param>
</member>
<member name="M:SimpleAdmin.SqlSugar.CodeFirstUtils.InitSeedData(System.String)">
<summary>
初始化种子数据
</summary>
<param name="assemblyName">程序集名称</param>
</member>
<member name="M:SimpleAdmin.SqlSugar.CodeFirstUtils.HasImplementedRawGeneric(System.Type,System.Type)">
<summary>
判断类型是否实现某个泛型
</summary>
<param name="type">类型</param>
<param name="generic">泛型类型</param>
<returns>bool</returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.CodeFirstUtils.ToDataTable``1(System.Collections.Generic.List{``0})">
<summary>
List转DataTable
</summary>
<typeparam name="T"></typeparam>
<param name="list"></param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.CodeFirstUtils.IsIgnoreColumn(System.Reflection.PropertyInfo)">
<summary>
排除SqlSugar忽略的列
</summary>
<param name="pi"></param>
<returns></returns>
</member>
<member name="T:SimpleAdmin.SqlSugar.SqlSugarColumnInfo">
<summary>
SqlSugar字段信息
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarColumnInfo.ColumnName">
<summary>
字段名称
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarColumnInfo.IsPrimaryKey">
<summary>
是否主键
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarColumnInfo.DataType">
<summary>
字段类型
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarColumnInfo.ColumnDescription">
<summary>
字段注释
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.SqlSugarTableInfo">
<summary>
SqlSugar表信息
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarTableInfo.ConfigId">
<summary>
所属库
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarTableInfo.TableName">
<summary>
表名称
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarTableInfo.EntityName">
<summary>
实体名
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarTableInfo.TableDescription">
<summary>
表注释
</summary>
</member>
<member name="P:SimpleAdmin.SqlSugar.SqlSugarTableInfo.Columns">
<summary>
表字段
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.SeedDataUtil">
<summary>
种子数据工具类
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.SeedDataRecords`1">
<summary>
种子数据格式实体类,遵循Navicat导出json格式
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="P:SimpleAdmin.SqlSugar.SeedDataRecords`1.Records">
<summary>
数据
</summary>
</member>
<member name="T:SimpleAdmin.SqlSugar.SqlSugarUtils">
<summary>
SqlSugar通用功能
</summary>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUtils.GetTablesByAttribute``1">
<summary>
根据特性获取所有表信息
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUtils.GetTableColumns(System.String,System.String)">
<summary>
获取字段信息
</summary>
<param name="configId"></param>
<param name="tableName"></param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUtils.ConvertDataType(System.String)">
<summary>
数据库字段类型转.NET类型
</summary>
<param name="dataType">字段类型</param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUtils.DataTypeToEff(System.String)">
<summary>
数据类型转显示类型
</summary>
<param name="dataType"></param>
<returns></returns>
</member>
<member name="M:SimpleAdmin.SqlSugar.SqlSugarUtils.IsCommonColumn(System.String)">
<summary>
是否通用字段
</summary>
<param name="columnName">字段名</param>
<returns></returns>
</member>
</members>
</doc>