FreeSql/FreeSql.DbContext/FreeSql.DbContext.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>FreeSql.DbContext</name>
    </assembly>
    <members>
        <member name="M:FreeSql.DbContext.Add``1(``0)">
            <summary>
            添加
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbContext.Update``1(``0)">
            <summary>
            更新
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbContext.Remove``1(``0)">
            <summary>
            删除
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbContext.AddOrUpdate``1(``0)">
            <summary>
            添加或更新
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbContext.SaveMany``1(``0,System.String)">
            <summary>
            保存实体的指定 ManyToMany/OneToMany 导航属性（完整对比）<para></para>
            场景：在关闭级联保存功能之后，手工使用本方法<para></para>
            例子：保存商品的 OneToMany 集合属性，SaveMany(goods, "Skus")<para></para>
            当 goods.Skus 为空(非null)时，会删除表中已存在的所有数据<para></para>
            当 goods.Skus 不为空(非null)时，添加/更新后，删除表中不存在 Skus 集合属性的所有记录
            </summary>
            <param name="data">实体对象</param>
            <param name="propertyName">属性名</param>
        </member>
        <member name="M:FreeSql.DbContext.Attach``1(``0)">
            <summary>
            附加实体，可用于不查询就更新或删除
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbContext.AttachOnlyPrimary``1(``0)">
            <summary>
            附加实体，并且只附加主键值，可用于不更新属性值为null或默认值的字段
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="data"></param>
        </member>
        <member name="P:FreeSql.DbContext.EntityChangeReport.ChangeInfo.BeforeObject">
            <summary>
            Type = Update 的时候，获取更新之前的对象
            </summary>
        </member>
        <member name="P:FreeSql.DbContext.EntityChangeReport.Report">
            <summary>
            实体变化记录
            </summary>
        </member>
        <member name="P:FreeSql.DbContext.EntityChangeReport.OnChange">
            <summary>
            实体变化事件
            </summary>
        </member>
        <member name="M:FreeSql.DbContext.FlushCommand">
            <summary>
            刷新队列中的命令
            </summary>
        </member>
        <member name="P:FreeSql.DbContextOptions.EnableAddOrUpdateNavigateList">
            <summary>
            是否开启一对多，多对多级联保存功能<para></para>
            <para></para>
            【一对多】模型下， 保存时可级联保存实体的属性集合。出于使用安全考虑我们没做完整对比，只实现实体属性集合的添加或更新操作，所以不会删除实体属性集合的数据。<para></para>
            完整对比的功能使用起来太危险，试想下面的场景：<para></para>
            - 保存的时候，实体的属性集合是空的，如何操作？记录全部删除？<para></para>
            - 保存的时候，由于数据库中记录非常之多，那么只想保存子表的部分数据，或者只需要添加，如何操作？<para></para>
            <para></para>
            【多对多】模型下，我们对中间表的保存是完整对比操作，对外部实体的操作只作新增（*注意不会更新）<para></para>
            - 属性集合为空时，删除他们的所有关联数据（中间表）<para></para>
            - 属性集合不为空时，与数据库存在的关联数据（中间表）完全对比，计算出应该删除和添加的记录
            </summary>
        </member>
        <member name="P:FreeSql.DbContextOptions.NoneParameter">
            <summary>
            使用无参数化设置（对应 IInsert/IUpdate）
            </summary>
        </member>
        <member name="P:FreeSql.DbContextOptions.EnableGlobalFilter">
            <summary>
            是否开启 IFreeSql GlobalFilter 功能（默认：true）
            </summary>
        </member>
        <member name="P:FreeSql.DbContextOptions.OnEntityChange">
            <summary>
            实体变化事件
            </summary>
        </member>
        <member name="M:FreeSql.DbSet`1.AsType(System.Type)">
            <summary>
            动态Type，在使用 DbSet&lt;object&gt; 后使用本方法，指定实体类型
            </summary>
            <param name="entityType"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.DbSet`1.Attach(`0)">
            <summary>
            附加实体，可用于不查询就更新或删除
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbSet`1.AttachOnlyPrimary(`0)">
            <summary>
            附加实体，并且只附加主键值，可用于不更新属性值为null或默认值的字段
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbSet`1.FlushState">
            <summary>
            清空状态数据
            </summary>
        </member>
        <member name="M:FreeSql.DbSet`1.RemoveAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
            <summary>
            根据 lambda 条件删除数据
            </summary>
            <param name="predicate"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.DbSet`1.Add(`0)">
            <summary>
            添加
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbSet`1.SaveMany(`0,System.String)">
            <summary>
            保存实体的指定 ManyToMany/OneToMany 导航属性（完整对比）<para></para>
            场景：在关闭级联保存功能之后，手工使用本方法<para></para>
            例子：保存商品的 OneToMany 集合属性，SaveMany(goods, "Skus")<para></para>
            当 goods.Skus 为空(非null)时，会删除表中已存在的所有数据<para></para>
            当 goods.Skus 不为空(非null)时，添加/更新后，删除表中不存在 Skus 集合属性的所有记录
            </summary>
            <param name="item">实体对象</param>
            <param name="propertyName">属性名</param>
        </member>
        <member name="M:FreeSql.DbSet`1.Update(`0)">
            <summary>
            更新
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbSet`1.Remove(`0)">
            <summary>
            删除
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbSet`1.Remove(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
            <summary>
            根据 lambda 条件删除数据
            </summary>
            <param name="predicate"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.DbSet`1.AddOrUpdate(`0)">
            <summary>
            添加或更新
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbSet`1.BeginEdit(System.Collections.Generic.List{`0})">
            <summary>
            开始编辑数据，然后调用方法 EndEdit 分析出添加、修改、删除 SQL 语句进行执行<para></para>
            场景：winform 加载表数据后，一顿添加、修改、删除操作之后，最后才点击【保存】<para></para><para></para>
            示例：https://github.com/dotnetcore/FreeSql/issues/397<para></para>
            注意：* 本方法只支持单表操作，不支持导航属性级联保存
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.DbSet`1.EndEdit(System.Collections.Generic.List{`0})">
            <summary>
            完成编辑数据，进行保存动作<para></para>
            该方法根据 BeginEdit 传入的数据状态分析出添加、修改、删除 SQL 语句<para></para>
            注意：* 本方法只支持单表操作，不支持导航属性级联保存
            </summary>
            <param name="data">可选参数：手工传递最终的 data 值进行对比<para></para>默认：如果不传递，则使用 BeginEdit 传入的 data 引用进行对比</param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.Extensions.EfCoreFluentApi.EfCoreColumnFluent.Help">
            <summary>
            使用 FreeSql FluentApi 方法，当 EFCore FluentApi 方法无法表示的时候使用
            </summary>
            <returns></returns>
        </member>
        <member name="M:FreeSql.Extensions.EfCoreFluentApi.EfCoreTableFluent.Help">
            <summary>
            使用 FreeSql FluentApi 方法，当 EFCore FluentApi 方法无法表示的时候使用
            </summary>
            <returns></returns>
        </member>
        <member name="M:FreeSql.Extensions.EfCoreFluentApi.EfCoreTableFluent.HasData(System.Collections.Generic.IEnumerable{System.Object})">
            <summary>
            使用 Repository + EnableAddOrUpdateNavigateList + NoneParameter 方式插入种子数据
            </summary>
            <param name="data"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.Extensions.EfCoreFluentApi.EfCoreTableFluent`1.Help">
            <summary>
            使用 FreeSql FluentApi 方法，当 EFCore FluentApi 方法无法表示的时候使用
            </summary>
            <returns></returns>
        </member>
        <member name="M:FreeSql.Extensions.EfCoreFluentApi.EfCoreTableFluent`1.HasData(System.Collections.Generic.IEnumerable{`0})">
            <summary>
            使用 Repository + EnableAddOrUpdateNavigateList + NoneParameter 方式插入种子数据
            </summary>
            <param name="data"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IRepositoryUnitOfWork.GetRepository``2(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
            <summary>
            在工作单元内创建默认仓库类，工作单元下的仓储操作具有事务特点
            </summary>
            <typeparam name="TEntity"></typeparam>
            <typeparam name="TKey"></typeparam>
            <param name="filter">数据过滤 + 验证</param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IRepositoryUnitOfWork.GetRepository``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
            <summary>
            在工作单元内创建联合主键的仓储类，工作单元下的仓储操作具有事务特点
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="filter">数据过滤 + 验证</param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IRepositoryUnitOfWork.GetGuidRepository``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Func{System.String,System.String})">
            <summary>
            在工作单元内创建仓库类，工作单元下的仓储操作具有事务特点
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="filter">数据过滤 + 验证</param>
            <param name="asTable">分表规则，参数：旧表名；返回：新表名 https://github.com/2881099/FreeSql/wiki/Repository</param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IDataFilter`1.Enable(System.String[])">
            <summary>
            开启过滤器，若使用 using 则使用完后，恢复为原有状态
            </summary>
            <param name="filterName">过滤器名称</param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IDataFilter`1.EnableAll">
            <summary>
            开启所有过滤器，若使用 using 则使用完后，恢复为原有状态
            </summary>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IDataFilter`1.Disable(System.String[])">
            <summary>
            禁用过滤器，若使用 using 则使用完后，恢复为原有状态
            </summary>
            <param name="filterName"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IDataFilter`1.DisableAll">
            <summary>
            禁用所有过滤器，若使用 using 则使用完后，恢复为原有状态
            </summary>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IBaseRepository.AsType(System.Type)">
            <summary>
            动态Type，在使用 Repository&lt;object&gt; 后使用本方法，指定实体类型
            </summary>
            <param name="entityType"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSql.IBaseRepository.AsTable(System.Func{System.String,System.String})">
            <summary>
            分表规则，参数：旧表名；返回：新表名 https://github.com/2881099/FreeSql/wiki/Repository
            </summary>
            <param name="rule"></param>
        </member>
        <member name="P:FreeSql.IBaseRepository.DbContextOptions">
            <summary>
            设置 DbContext 选项
            </summary>
        </member>
        <member name="M:FreeSql.IBaseRepository`1.FlushState">
            <summary>
            清空状态数据
            </summary>
        </member>
        <member name="M:FreeSql.IBaseRepository`1.Attach(`0)">
            <summary>
            附加实体，可用于不查询就更新或删除
            </summary>
            <param name="entity"></param>
        </member>
        <member name="M:FreeSql.IBaseRepository`1.AttachOnlyPrimary(`0)">
            <summary>
            附加实体，并且只附加主键值，可用于不更新属性值为null或默认值的字段
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.IBaseRepository`1.SaveMany(`0,System.String)">
            <summary>
            保存实体的指定 ManyToMany/OneToMany 导航属性（完整对比）<para></para>
            场景：在关闭级联保存功能之后，手工使用本方法<para></para>
            例子：保存商品的 OneToMany 集合属性，SaveMany(goods, "Skus")<para></para>
            当 goods.Skus 为空(非null)时，会删除表中已存在的所有数据<para></para>
            当 goods.Skus 不为空(非null)时，添加/更新后，删除表中不存在 Skus 集合属性的所有记录
            </summary>
            <param name="entity">实体对象</param>
            <param name="propertyName">属性名</param>
        </member>
        <member name="M:FreeSql.IBaseRepository`1.BeginEdit(System.Collections.Generic.List{`0})">
            <summary>
            开始编辑数据，然后调用方法 EndEdit 分析出添加、修改、删除 SQL 语句进行执行<para></para>
            场景：winform 加载表数据后，一顿添加、修改、删除操作之后，最后才点击【保存】<para></para><para></para>
            示例：https://github.com/dotnetcore/FreeSql/issues/397<para></para>
            注意：* 本方法只支持单表操作，不支持导航属性级联保存
            </summary>
            <param name="data"></param>
        </member>
        <member name="M:FreeSql.IBaseRepository`1.EndEdit(System.Collections.Generic.List{`0})">
            <summary>
            完成编辑数据，进行保存动作<para></para>
            该方法根据 BeginEdit 传入的数据状态分析出添加、修改、删除 SQL 语句<para></para>
            注意：* 本方法只支持单表操作，不支持导航属性级联保存
            </summary>
            <param name="data">可选参数：手工传递最终的 data 值进行对比<para></para>默认：如果不传递，则使用 BeginEdit 传入的 data 引用进行对比</param>
            <returns></returns>
        </member>
        <member name="T:FreeSql.IUnitOfWork">
            <summary>
            工作单元
            </summary>
        </member>
        <member name="M:FreeSql.IUnitOfWork.GetOrBeginTransaction(System.Boolean)">
            <summary>
            开启事务，或者返回已开启的事务
            </summary>
            <param name="isCreate">若未开启事务，则开启</param>
            <returns></returns>
        </member>
        <member name="P:FreeSql.IUnitOfWork.EntityChangeReport">
            <summary>
            工作单元内的实体变化跟踪
            </summary>
        </member>
        <member name="P:FreeSql.UnitOfWork.DebugBeingUsed">
            <summary>
            正在使用中的工作单元（调试）
            </summary>
        </member>
        <member name="P:FreeSql.UnitOfWork.Id">
            <summary>
            开启事务后有值，是 UnitOfWork 的唯一标识<para></para>
            格式：yyyyMMdd_HHmmss_种子id<para></para>
            例如：20191121_214504_1
            </summary>
        </member>
        <member name="T:FreeSql.UnitOfWorkManager">
            <summary>
            工作单元管理器
            </summary>
        </member>
        <member name="P:FreeSql.UnitOfWorkManager.Current">
            <summary>
            当前的工作单元
            </summary>
        </member>
        <member name="M:FreeSql.UnitOfWorkManager.Binding(FreeSql.IBaseRepository)">
            <summary>
            将仓储的事务交给我管理
            </summary>
            <param name="repository"></param>
        </member>
        <member name="M:FreeSql.UnitOfWorkManager.Begin(FreeSql.Propagation,System.Nullable{System.Data.IsolationLevel})">
            <summary>
            创建工作单元
            </summary>
            <param name="propagation">事务传播方式</param>
            <param name="isolationLevel">事务隔离级别</param>
            <returns></returns>
        </member>
        <member name="T:FreeSql.Propagation">
            <summary>
            事务传播方式
            </summary>
        </member>
        <member name="F:FreeSql.Propagation.Required">
            <summary>
            如果当前没有事务，就新建一个事务，如果已存在一个事务中，加入到这个事务中，默认的选择。
            </summary>
        </member>
        <member name="F:FreeSql.Propagation.Supports">
            <summary>
            支持当前事务，如果没有当前事务，就以非事务方法执行。
            </summary>
        </member>
        <member name="F:FreeSql.Propagation.Mandatory">
            <summary>
            使用当前事务，如果没有当前事务，就抛出异常。
            </summary>
        </member>
        <member name="F:FreeSql.Propagation.NotSupported">
            <summary>
            以非事务方式执行操作，如果当前存在事务，就把当前事务挂起。
            </summary>
        </member>
        <member name="F:FreeSql.Propagation.Never">
            <summary>
            以非事务方式执行操作，如果当前事务存在则抛出异常。
            </summary>
        </member>
        <member name="F:FreeSql.Propagation.Nested">
            <summary>
            以嵌套事务方式执行。
            </summary>
        </member>
        <member name="M:FreeSqlDbContextExtensions.Entity``1(FreeSql.ICodeFirst,System.Action{FreeSql.Extensions.EfCoreFluentApi.EfCoreTableFluent{``0}})">
            <summary>
            EFCore 95% 相似的 FluentApi 扩展方法
            </summary>
            <typeparam name="T"></typeparam>
            <param name="codeFirst"></param>
            <param name="modelBuilder"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSqlDbContextExtensions.Entity(FreeSql.ICodeFirst,System.Type,System.Action{FreeSql.Extensions.EfCoreFluentApi.EfCoreTableFluent})">
            <summary>
            EFCore 95% 相似的 FluentApi 扩展方法
            </summary>
            <param name="codeFirst"></param>
            <param name="entityType">实体类型</param>
            <param name="modelBuilder"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSqlDbContextExtensions.CreateDbContext(IFreeSql)">
            <summary>
            创建普通数据上下文档对象
            </summary>
            <param name="that"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSqlDbContextExtensions.NoTracking``1(FreeSql.ISelect{``0})">
            <summary>
            不跟踪查询的实体数据（在不需要更新其数据时使用），可提升查询性能
            </summary>
            <typeparam name="T"></typeparam>
            <param name="select"></param>
            <returns></returns>
        </member>
        <member name="M:FreeSqlDbContextExtensions.SetDbContextOptions(IFreeSql,System.Action{FreeSql.DbContextOptions})">
            <summary>
            设置 DbContext 选项设置
            </summary>
            <param name="that"></param>
            <param name="options"></param>
        </member>
        <member name="M:FreeSqlDbContextExtensions.GetRepository``2(IFreeSql,System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
            <summary>
            返回默认仓库类
            </summary>
            <typeparam name="TEntity"></typeparam>
            <typeparam name="TKey"></typeparam>
            <param name="that"></param>
            <param name="filter">数据过滤 + 验证</param>
            <returns></returns>
        </member>
        <member name="M:FreeSqlDbContextExtensions.GetRepository``1(IFreeSql,System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
            <summary>
            返回默认仓库类，适用联合主键的仓储类
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="that"></param>
            <param name="filter">数据过滤 + 验证</param>
            <returns></returns>
        </member>
        <member name="M:FreeSqlDbContextExtensions.GetGuidRepository``1(IFreeSql,System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Func{System.String,System.String})">
            <summary>
            返回仓库类
            </summary>
            <typeparam name="TEntity"></typeparam>
            <param name="that"></param>
            <param name="filter">数据过滤 + 验证</param>
            <param name="asTable">分表规则，参数：旧表名；返回：新表名 https://github.com/2881099/FreeSql/wiki/Repository</param>
            <returns></returns>
        </member>
        <member name="M:FreeSqlDbContextExtensions.CreateUnitOfWork(IFreeSql)">
            <summary>
            创建基于仓储功能的工作单元，务必使用 using 包含使用
            </summary>
            <param name="that"></param>
            <returns></returns>
        </member>
        <member name="M:Microsoft.Extensions.DependencyInjection.FreeSqlRepositoryDependencyInjection.AddFreeRepository(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{FreeSql.FluentDataFilter},System.Reflection.Assembly[])">
            <summary>
            批量注入 Repository，可以参考代码自行调整
            </summary>
            <param name="services"></param>
            <param name="globalDataFilter"></param>
            <param name="assemblies"></param>
            <returns></returns>
        </member>
    </members>
</doc>