210 lines
12 KiB
C#
210 lines
12 KiB
C#
#if FANTASY_NET
|
||
using System;
|
||
using System.Collections.Generic;
|
||
using System.Linq.Expressions;
|
||
using Fantasy.Async;
|
||
using Fantasy.Entitas;
|
||
using MongoDB.Driver;
|
||
// ReSharper disable InconsistentNaming
|
||
#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
|
||
|
||
#pragma warning disable CS8625
|
||
|
||
namespace Fantasy.DataBase
|
||
{
|
||
/// <summary>
|
||
/// 数据库设置助手
|
||
/// </summary>
|
||
public static class DataBaseSetting
|
||
{
|
||
/// <summary>
|
||
/// 初始化自定义委托，当设置了这个委托后，就不会自动创建MongoClient，需要自己在委托里创建MongoClient。
|
||
/// </summary>
|
||
public static Func<DataBaseCustomConfig, MongoClient>? MongoDBCustomInitialize;
|
||
}
|
||
|
||
/// <summary>
|
||
/// MongoDB自定义连接参数
|
||
/// </summary>
|
||
public sealed class DataBaseCustomConfig
|
||
{
|
||
/// <summary>
|
||
/// 当前Scene
|
||
/// </summary>
|
||
public Scene Scene;
|
||
/// <summary>
|
||
/// 连接字符串
|
||
/// </summary>
|
||
public string ConnectionString;
|
||
/// <summary>
|
||
/// 数据库名字
|
||
/// </summary>
|
||
public string DBName;
|
||
}
|
||
|
||
/// <summary>
|
||
/// 表示用于执行各种数据库操作的数据库接口。
|
||
/// </summary>
|
||
public interface IDataBase : IDisposable
|
||
{
|
||
/// <summary>
|
||
/// 获得当前数据的类型
|
||
/// </summary>
|
||
public DataBaseType GetDataBaseType { get;}
|
||
/// <summary>
|
||
/// 获得对应数据的操作实例
|
||
/// </summary>
|
||
/// <returns>如MongoDB就是IMongoDatabase</returns>
|
||
public object GetDataBaseInstance { get;}
|
||
/// <summary>
|
||
/// 初始化数据库连接。
|
||
/// </summary>
|
||
IDataBase Initialize(Scene scene, string connectionString, string dbName);
|
||
/// <summary>
|
||
/// 在指定的集合中检索类型 <typeparamref name="T"/> 的实体数量。
|
||
/// </summary>
|
||
FTask<long> Count<T>(string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 在指定的集合中检索满足给定筛选条件的类型 <typeparamref name="T"/> 的实体数量。
|
||
/// </summary>
|
||
FTask<long> Count<T>(Expression<Func<T, bool>> filter, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 检查指定集合中是否存在类型 <typeparamref name="T"/> 的实体。
|
||
/// </summary>
|
||
FTask<bool> Exist<T>(string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 检查指定集合中是否存在满足给定筛选条件的类型 <typeparamref name="T"/> 的实体。
|
||
/// </summary>
|
||
FTask<bool> Exist<T>(Expression<Func<T, bool>> filter, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 从指定集合中检索指定 ID 的类型 <typeparamref name="T"/> 的实体，不锁定。
|
||
/// </summary>
|
||
FTask<T> QueryNotLock<T>(long id, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 从指定集合中检索指定 ID 的类型 <typeparamref name="T"/> 的实体。
|
||
/// </summary>
|
||
FTask<T> Query<T>(long id, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 按页查询满足给定筛选条件的类型 <typeparamref name="T"/> 的实体数量和日期。
|
||
/// </summary>
|
||
FTask<(int count, List<T> dates)> QueryCountAndDatesByPage<T>(Expression<Func<T, bool>> filter, int pageIndex, int pageSize, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 按页查询满足给定筛选条件的类型 <typeparamref name="T"/> 的实体数量和日期。
|
||
/// </summary>
|
||
FTask<(int count, List<T> dates)> QueryCountAndDatesByPage<T>(Expression<Func<T, bool>> filter, int pageIndex, int pageSize, string[] cols, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 分页查询指定集合中满足给定筛选条件的类型 <typeparamref name="T"/> 的实体列表。
|
||
/// </summary>
|
||
FTask<List<T>> QueryByPage<T>(Expression<Func<T, bool>> filter, int pageIndex, int pageSize, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 分页查询指定集合中满足给定筛选条件的类型 <typeparamref name="T"/> 的实体列表，仅返回指定列的数据。
|
||
/// </summary>
|
||
FTask<List<T>> QueryByPage<T>(Expression<Func<T, bool>> filter, int pageIndex, int pageSize, string[] cols, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 从指定集合中按页查询满足给定筛选条件的类型 <typeparamref name="T"/> 的实体列表，按指定字段排序。
|
||
/// </summary>
|
||
FTask<List<T>> QueryByPageOrderBy<T>(Expression<Func<T, bool>> filter, int pageIndex, int pageSize, Expression<Func<T, object>> orderByExpression, bool isAsc = true, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 检索满足给定筛选条件的类型 <typeparamref name="T"/> 的第一个实体，从指定集合中。
|
||
/// </summary>
|
||
FTask<T?> First<T>(Expression<Func<T, bool>> filter, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 查询指定集合中满足给定 JSON 查询字符串的类型 <typeparamref name="T"/> 的第一个实体，仅返回指定列的数据。
|
||
/// </summary>
|
||
FTask<T> First<T>(string json, string[] cols, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 从指定集合中按页查询满足给定筛选条件的类型 <typeparamref name="T"/> 的实体列表，按指定字段排序。
|
||
/// </summary>
|
||
FTask<List<T>> QueryOrderBy<T>(Expression<Func<T, bool>> filter, Expression<Func<T, object>> orderByExpression, bool isAsc = true, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 从指定集合中按页查询满足给定筛选条件的类型 <typeparamref name="T"/> 的实体列表。
|
||
/// </summary>
|
||
FTask<List<T>> Query<T>(Expression<Func<T, bool>> filter, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 查询指定集合中满足给定筛选条件的类型 <typeparamref name="T"/> 实体列表，仅返回指定字段的数据。
|
||
/// </summary>
|
||
FTask<List<T>> Query<T>(Expression<Func<T, bool>> filter, Expression<Func<T, object>>[] cols, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 查询指定 ID 的多个集合，将结果存储在给定的实体列表中。
|
||
/// </summary>
|
||
FTask Query(long id, List<string> collectionNames, List<Entity> result, bool isDeserialize = false);
|
||
/// <summary>
|
||
/// 根据给定的 JSON 查询字符串查询指定集合中的类型 <typeparamref name="T"/> 实体列表。
|
||
/// </summary>
|
||
FTask<List<T>> QueryJson<T>(string json, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 根据给定的 JSON 查询字符串查询指定集合中的类型 <typeparamref name="T"/> 实体列表，仅返回指定列的数据。
|
||
/// </summary>
|
||
FTask<List<T>> QueryJson<T>(string json, string[] cols, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 根据给定的 JSON 查询字符串查询指定集合中的类型 <typeparamref name="T"/> 实体列表，通过指定的任务 ID 进行标识。
|
||
/// </summary>
|
||
FTask<List<T>> QueryJson<T>(long taskId, string json, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 查询指定集合中满足给定筛选条件的类型 <typeparamref name="T"/> 实体列表，仅返回指定列的数据。
|
||
/// </summary>
|
||
FTask<List<T>> Query<T>(Expression<Func<T, bool>> filter, string[] cols, bool isDeserialize = false, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 保存类型 <typeparamref name="T"/> 实体到指定集合中，如果集合不存在将自动创建。
|
||
/// </summary>
|
||
FTask Save<T>(T entity, string collection = null) where T : Entity, new();
|
||
/// <summary>
|
||
/// 保存一组实体到数据库中，根据实体列表的 ID 进行区分和存储。
|
||
/// </summary>
|
||
FTask Save(long id, List<Entity> entities);
|
||
/// <summary>
|
||
/// 通过事务会话将类型 <typeparamref name="T"/> 实体保存到指定集合中，如果集合不存在将自动创建。
|
||
/// </summary>
|
||
FTask Save<T>(object transactionSession, T entity, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 向指定集合中插入一个类型 <typeparamref name="T"/> 实体，如果集合不存在将自动创建。
|
||
/// </summary>
|
||
FTask Insert<T>(T entity, string collection = null) where T : Entity, new();
|
||
/// <summary>
|
||
/// 批量插入一组类型 <typeparamref name="T"/> 实体到指定集合中，如果集合不存在将自动创建。
|
||
/// </summary>
|
||
FTask InsertBatch<T>(IEnumerable<T> list, string collection = null) where T : Entity, new();
|
||
/// <summary>
|
||
/// 通过事务会话，批量插入一组类型 <typeparamref name="T"/> 实体到指定集合中，如果集合不存在将自动创建。
|
||
/// </summary>
|
||
FTask InsertBatch<T>(object transactionSession, IEnumerable<T> list, string collection = null) where T : Entity, new();
|
||
/// <summary>
|
||
/// 通过事务会话，根据指定的 ID 从数据库中删除指定类型 <typeparamref name="T"/> 实体。
|
||
/// </summary>
|
||
FTask<long> Remove<T>(object transactionSession, long id, string collection = null) where T : Entity, new();
|
||
/// <summary>
|
||
/// 根据指定的 ID 从数据库中删除指定类型 <typeparamref name="T"/> 实体。
|
||
/// </summary>
|
||
FTask<long> Remove<T>(long id, string collection = null) where T : Entity, new();
|
||
/// <summary>
|
||
/// 通过事务会话，根据给定的筛选条件从数据库中删除指定类型 <typeparamref name="T"/> 实体。
|
||
/// </summary>
|
||
FTask<long> Remove<T>(long coroutineLockQueueKey, object transactionSession, Expression<Func<T, bool>> filter, string collection = null) where T : Entity, new();
|
||
/// <summary>
|
||
/// 根据给定的筛选条件从数据库中删除指定类型 <typeparamref name="T"/> 实体。
|
||
/// </summary>
|
||
FTask<long> Remove<T>(long coroutineLockQueueKey, Expression<Func<T, bool>> filter, string collection = null) where T : Entity, new();
|
||
/// <summary>
|
||
/// 根据给定的筛选条件计算指定集合中类型 <typeparamref name="T"/> 实体某个属性的总和。
|
||
/// </summary>
|
||
FTask<long> Sum<T>(Expression<Func<T, bool>> filter, Expression<Func<T, object>> sumExpression, string collection = null) where T : Entity;
|
||
/// <summary>
|
||
/// 在指定的集合中创建索引，以提高类型 <typeparamref name="T"/> 实体的查询性能。
|
||
/// </summary>
|
||
FTask CreateIndex<T>(string collection, params object[] keys) where T : Entity;
|
||
/// <summary>
|
||
/// 在默认集合中创建索引，以提高类型 <typeparamref name="T"/> 实体的查询性能。
|
||
/// </summary>
|
||
FTask CreateIndex<T>(params object[] keys) where T : Entity;
|
||
/// <summary>
|
||
/// 创建指定类型 <typeparamref name="T"/> 的数据库，用于存储实体。
|
||
/// </summary>
|
||
FTask CreateDB<T>() where T : Entity;
|
||
/// <summary>
|
||
/// 根据指定类型创建数据库，用于存储实体。
|
||
/// </summary>
|
||
FTask CreateDB(Type type);
|
||
}
|
||
}
|
||
|
||
#endif |