Skip to content

Commit 1a84ee1

Browse files
luoyunchongluoyunchong
authored
Merge pull request #2214 from ZacharyBear/docs-irepo
docs(IBaseRepository): added XMLDocs and fixed typos
2 parents 4673be8 + ac96d0d commit 1a84ee1

3 files changed

Lines changed: 76 additions & 20 deletions

File tree

‎FreeSql.DbContext/Repository/Repository/BaseRepository.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ public virtual int Delete(TEntity entity)
9797
_dbset.Remove(entity);
9898
return _db.SaveChanges();
9999
}
100-
public virtual int Delete(IEnumerable<TEntity> entitys)
100+
public virtual int Delete(IEnumerable<TEntity> entities)
101101
{
102-
_dbset.RemoveRange(entitys);
102+
_dbset.RemoveRange(entities);
103103
return _db.SaveChanges();
104104
}
105105
public virtual List<object> DeleteCascadeByDatabase(Expression<Func<TEntity, bool>> predicate)
@@ -115,21 +115,21 @@ public virtual TEntity Insert(TEntity entity)
115115
_db.SaveChanges();
116116
return entity;
117117
}
118-
public virtual List<TEntity> Insert(IEnumerable<TEntity> entitys)
118+
public virtual List<TEntity> Insert(IEnumerable<TEntity> entities)
119119
{
120-
_dbset.AddRange(entitys);
120+
_dbset.AddRange(entities);
121121
_db.SaveChanges();
122-
return entitys.ToList();
122+
return entities.ToList();
123123
}
124124

125125
public virtual int Update(TEntity entity)
126126
{
127127
_dbset.Update(entity);
128128
return _db.SaveChanges();
129129
}
130-
public virtual int Update(IEnumerable<TEntity> entitys)
130+
public virtual int Update(IEnumerable<TEntity> entities)
131131
{
132-
_dbset.UpdateRange(entitys);
132+
_dbset.UpdateRange(entities);
133133
return _db.SaveChanges();
134134
}
135135

‎FreeSql.DbContext/Repository/Repository/BaseRepositoryAsync.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ public virtual Task<int> DeleteAsync(TEntity entity, CancellationToken cancellat
2626
_dbset.Remove(entity);
2727
return _db.SaveChangesAsync(cancellationToken);
2828
}
29-
public virtual Task<int> DeleteAsync(IEnumerable<TEntity> entitys, CancellationToken cancellationToken = default)
29+
public virtual Task<int> DeleteAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default)
3030
{
31-
_dbset.RemoveRange(entitys);
31+
_dbset.RemoveRange(entities);
3232
return _db.SaveChangesAsync(cancellationToken);
3333
}
3434
public virtual async Task<List<object>> DeleteCascadeByDatabaseAsync(Expression<Func<TEntity, bool>> predicate, CancellationToken cancellationToken = default)
@@ -44,21 +44,21 @@ public virtual async Task<TEntity> InsertAsync(TEntity entity, CancellationToken
4444
await _db.SaveChangesAsync(cancellationToken);
4545
return entity;
4646
}
47-
public virtual async Task<List<TEntity>> InsertAsync(IEnumerable<TEntity> entitys, CancellationToken cancellationToken = default)
47+
public virtual async Task<List<TEntity>> InsertAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default)
4848
{
49-
await _dbset.AddRangeAsync(entitys, cancellationToken);
49+
await _dbset.AddRangeAsync(entities, cancellationToken);
5050
await _db.SaveChangesAsync(cancellationToken);
51-
return entitys.ToList();
51+
return entities.ToList();
5252
}
5353

5454
public virtual Task<int> UpdateAsync(TEntity entity, CancellationToken cancellationToken = default)
5555
{
5656
_dbset.Update(entity);
5757
return _db.SaveChangesAsync(cancellationToken);
5858
}
59-
public virtual Task<int> UpdateAsync(IEnumerable<TEntity> entitys, CancellationToken cancellationToken = default)
59+
public virtual Task<int> UpdateAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default)
6060
{
61-
_dbset.UpdateRange(entitys);
61+
_dbset.UpdateRange(entities);
6262
return _db.SaveChangesAsync(cancellationToken);
6363
}
6464

‎FreeSql.DbContext/Repository/Repository/IBaseRepository.cs‎

Lines changed: 62 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,38 @@ public interface IBaseRepository : IDisposable
4343
public interface IBaseRepository<TEntity> : IBaseRepository
4444
where TEntity : class
4545
{
46+
/// <summary>
47+
/// 查询数据
48+
/// </summary>
4649
ISelect<TEntity> Select { get; }
4750

51+
/// <summary>
52+
/// 筛选数据
53+
/// </summary>
54+
/// <param name="exp">Lambda 筛选表达式</param>
55+
/// <returns>筛选后的查询对象</returns>
4856
ISelect<TEntity> Where(Expression<Func<TEntity, bool>> exp);
4957
ISelect<TEntity> WhereIf(bool condition, Expression<Func<TEntity, bool>> exp);
5058

59+
/// <summary>
60+
/// 插入实体
61+
/// </summary>
62+
/// <param name="entity">需要插入的实体对象</param>
63+
/// <returns>插入后的实体对象</returns>
5164
TEntity Insert(TEntity entity);
52-
List<TEntity> Insert(IEnumerable<TEntity> entitys);
65+
66+
/// <summary>
67+
/// 批量插入实体
68+
/// </summary>
69+
/// <param name="entities">需要插入的实体对象集合</param>
70+
/// <returns>插入后的实体对象集合</returns>
71+
List<TEntity> Insert(IEnumerable<TEntity> entities);
5372

5473
/// <summary>
5574
/// 清空状态数据
5675
/// </summary>
5776
void FlushState();
77+
5878
/// <summary>
5979
/// 附加实体，可用于不查询就更新或删除
6080
/// </summary>
@@ -73,15 +93,51 @@ public interface IBaseRepository<TEntity> : IBaseRepository
7393
/// <returns>key: 属性名, value: [旧值, 新值]</returns>
7494
Dictionary<string, object[]> CompareState(TEntity newdata);
7595

96+
/// <summary>
97+
/// 更新实体
98+
/// </summary>
99+
/// <param name="entity">需要更新的实体对象</param>
100+
/// <returns>返回受影响的行数</returns>
76101
int Update(TEntity entity);
77-
int Update(IEnumerable<TEntity> entitys);
102+
103+
/// <summary>
104+
/// 更新实体集合
105+
/// </summary>
106+
/// <param name="entities">需要更新的实体对象集合</param>
107+
/// <returns>返回受影响的行数</returns>
108+
int Update(IEnumerable<TEntity> entities);
78109

110+
/// <summary>
111+
/// 更新实体，不存在则插入
112+
/// </summary>
113+
/// <param name="entity">需要插入或更新的实体对象</param>
114+
/// <returns>受影响的行数</returns>
79115
TEntity InsertOrUpdate(TEntity entity);
80116

117+
/// <summary>
118+
/// DIY 方式更新
119+
/// </summary>
81120
IUpdate<TEntity> UpdateDiy { get; }
82121

122+
/// <summary>
123+
/// 根据主键删除实体
124+
/// </summary>
125+
/// <param name="entity">需要删除的实体</param>
126+
/// <returns>受影响的行数</returns>
83127
int Delete(TEntity entity);
84-
int Delete(IEnumerable<TEntity> entitys);
128+
129+
/// <summary>
130+
/// 批量删除实体，一样是根据主键删除
131+
/// </summary>
132+
/// <param name="entities">需要删除的实体对象集合</param>
133+
/// <returns>受影响的行数</returns>
134+
int Delete(IEnumerable<TEntity> entities);
135+
136+
/// <summary>
137+
/// 根据 Lambda 表达式删除实体
138+
/// </summary>
139+
/// <param name="predicate">Lambda 表达式，用于筛选需要删除的实体</param>
140+
/// <returns>受影响的行数</returns>
85141
int Delete(Expression<Func<TEntity, bool>> predicate);
86142
/// <summary>
87143
/// 根据设置的 OneToOne/OneToMany/ManyToMany 导航属性，级联查询所有的数据库记录，删除并返回它们
@@ -121,15 +177,15 @@ public interface IBaseRepository<TEntity> : IBaseRepository
121177
#if net40
122178
#else
123179
Task<TEntity> InsertAsync(TEntity entity, CancellationToken cancellationToken = default);
124-
Task<List<TEntity>> InsertAsync(IEnumerable<TEntity> entitys, CancellationToken cancellationToken = default);
180+
Task<List<TEntity>> InsertAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default);
125181

126182
Task<int> UpdateAsync(TEntity entity, CancellationToken cancellationToken = default);
127-
Task<int> UpdateAsync(IEnumerable<TEntity> entitys, CancellationToken cancellationToken = default);
183+
Task<int> UpdateAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default);
128184
Task<TEntity> InsertOrUpdateAsync(TEntity entity, CancellationToken cancellationToken = default);
129185
Task SaveManyAsync(TEntity entity, string propertyName, CancellationToken cancellationToken = default);
130186

131187
Task<int> DeleteAsync(TEntity entity, CancellationToken cancellationToken = default);
132-
Task<int> DeleteAsync(IEnumerable<TEntity> entitys, CancellationToken cancellationToken = default);
188+
Task<int> DeleteAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default);
133189
Task<int> DeleteAsync(Expression<Func<TEntity, bool>> predicate, CancellationToken cancellationToken = default);
134190
Task<List<object>> DeleteCascadeByDatabaseAsync(Expression<Func<TEntity, bool>> predicate, CancellationToken cancellationToken = default);
135191
#endif

0 commit comments

Comments
 (0)