readme english

2022-02-18 09:02:31 +08:00 · 2022-02-18 09:02:31 +08:00 · 4936c79b90
parent 43bb9ea3dc
commit 4936c79b90
4 changed files with 56 additions and 50 deletions
--- a/README-zh.md
+++ b/README-zh.md
@ -1,19 +1,23 @@
 <p align="center">
-  <img height="340" src="https://xuejm.gitee.io/sharding-core-doc/logo.svg">
+  <img height="340" src="https://xuejmnet.github.io/sharding-core-doc/logo.svg">
 </p>

+# [English](https://github.com/dotnetcore/sharding-core/blob/main/README.md) | 中文
 # ShardingCore
-
-
-`ShardingCore` 一款`ef-core`下高性能、轻量级针对分表分库读写分离的解决方案，具有零依赖、零学习成本、零业务代码入侵。
+一款`ef-core`下高性能、轻量级针对分表分库读写分离的解决方案。
+- 零依赖
+- 零学习成本
+- 零业务代码入侵

 ---
+- [Gitee](https://gitee.com/dotnetchina/sharding-core) 国内镜像

-<div align="center">
-<p><a href="https://github.com/xuejmnet/sharding-core">Github Source Code</a>  助力dotnet 生态 <a href="https://gitee.com/dotnetchina/sharding-core">Gitee Source Code</a> </p>
-</div>

---
+## 社区合作伙伴和赞助商
+
+<a href="https://www.jetbrains.com/?from=.NETCoreCommunity(NCC)" target="_blank">
+<img src="./imgs/jetbrains.png" title="JetBrains" width=130 />
+</a>

 ## 📚 Documentation

@ -34,7 +38,7 @@ Release  | EF Core | .NET  | .NET (Core)
 ## 快速开始
 5步实现按月分表,且支持自动化建表建库
 ### 第一步安装依赖
-`ShardingCore`版本表现形式为a.b.c.d,其中a表示`efcore`的版本号,b表示`ShardingCore`的主版本号,c表示`ShardingCore`次级版本号,d表示`ShardingCore`的修订版本号
+选择您的efcore的数据库驱动版本
 ```shell
 # 请对应安装您需要的版本
 PM> Install-Package ShardingCore
--- a/README.md
+++ b/README.md
@ -2,21 +2,19 @@
  <img height="340" src="https://xuejmnet.github.io/sharding-core-doc/logo.svg">
 </p>

+# English | [中文](https://github.com/dotnetcore/sharding-core/blob/main/README-zh.md)
+
 # ShardingCore
-
-
-`ShardingCore` 一款`ef-core`下高性能、轻量级针对分表分库读写分离的解决方案，具有零依赖、零学习成本、零业务代码入侵。
-
---
-
-<div align="center">
-<p><a href="https://github.com/xuejmnet/sharding-core">Github Source Code</a>  助力dotnet 生态 <a href="https://gitee.com/dotnetchina/sharding-core">Gitee Source Code</a> </p>
-</div>
+high performance lightweight solution for efcore sharding table and sharding database support read-write-separation.
+- zero dependency
+- zero learning cost
+- zero incursion

 ---
+- [Gitee](https://gitee.com/dotnetchina/sharding-core) 国内镜像


-## 社区合作伙伴和赞助商
+## Community Partners and Sponsors

 <a href="https://www.jetbrains.com/?from=.NETCoreCommunity(NCC)" target="_blank">
 <img src="./imgs/jetbrains.png" title="JetBrains" width=130 />
@ -28,7 +26,7 @@


 [中文文档Gitee](https://xuejm.gitee.io/sharding-core-doc/) | [English Document Gitee](https://xuejm.gitee.io/sharding-core-doc/en/)
-## 依赖
+## Dependency

 Release  | EF Core | .NET  | .NET (Core) 
 --- | --- | --- | --- 
@ -38,21 +36,21 @@ Release  | EF Core | .NET  | .NET (Core)
 [2.x.x.x](https://www.nuget.org/packages/ShardingCore) | 2.2.6 | Standard 2.0 | 2.0+ 


-## 快速开始
-5步实现按月分表,且支持自动化建表建库
-### 第一步安装依赖
-`ShardingCore`版本表现形式为a.b.c.d,其中a表示`efcore`的版本号,b表示`ShardingCore`的主版本号,c表示`ShardingCore`次级版本号,d表示`ShardingCore`的修订版本号
+## Quick start
+5 steps implement sharding by month and support auto create table by month
+### Step 1: Install the package
+Choose data base driver for efcore
 ```shell
-# 请对应安装您需要的版本
+# basic package
 PM> Install-Package ShardingCore
-# use sqlserver
+# sqlserver driver
 PM> Install-Package Microsoft.EntityFrameworkCore.SqlServer
-#  use mysql
+# mysql driver
 #PM> Install-Package Pomelo.EntityFrameworkCore.MySql
 # use other database driver,if efcore support
 ```

-### 第二步创建查询对象
+### Step 2: Query entity

 查询对象
 ```csharp
@ -95,8 +93,10 @@ PM> Install-Package Microsoft.EntityFrameworkCore.SqlServer
        PayFail=4
    }
 ```
-### 第三步创建dbcontext
-dbcontext `AbstractShardingDbContext`和`IShardingTableDbContext`如果你是普通的DbContext那么就继承`AbstractShardingDbContext`需要分表就实现`IShardingTableDbContext`,如果只有分库可以不实现`IShardingTableDbContext`接口
+### Step 3: Create DbContext
+Create `MyDbContext` extends `AbstractShardingDbContext`,
+then this dbcontext support sharding database,if u want support 
+sharding table(spilt table eg. order_202101,order_202102,order_202103......),u need implements `IShardingTableDbContext`
 ```csharp

    public class MyDbContext:AbstractShardingDbContext,IShardingTableDbContext
@ -119,13 +119,13 @@ dbcontext `AbstractShardingDbContext`和`IShardingTableDbContext`如果你是普
            });
        }
        /// <summary>
-        /// empty impl if use sharding table
+        /// empty implment if use sharding table
        /// </summary>
        public IRouteTail RouteTail { get; set; }
    }
 ```

-### 第四步添加分表路由
+### Step 4:Create route that data(Order) query mapping table name

 ```csharp

@ -160,14 +160,14 @@ dbcontext `AbstractShardingDbContext`和`IShardingTableDbContext`如果你是普
    }
 ```

-### 第五步配置启动项
+### Step 5: Start up Configure
 无论你是何种数据库只需要修改`AddDefaultDataSource`里面的链接字符串 请不要修改委托内部的UseXXX参数 `conStr` and `connection`
 ```csharp

        public void ConfigureServices(IServiceCollection services)
        {

-            //额外添加分片配置
+            //sharding config
            services.AddShardingDbContext<MyDbContext>()
                .AddEntityConfig(op =>
                {
@ -201,7 +201,7 @@ dbcontext `AbstractShardingDbContext`和`IShardingTableDbContext`如果你是普
            // other configure....
        }
 ```
-这样所有的配置就完成了你可以愉快地对Order表进行按月分表了
+then efcore support sharding，like sharding-jdbc in java,u can happy coding for efcore

 ```csharp
 [Route("api/[controller]")]
@ -224,16 +224,16 @@ public class ValuesController : Controller
 ```


-## 性能
+## Performance

+Test 
+ - on expression compile cache
+ - ShardingCore x.3.1.63+ version
+ - efcore 6.0 version
+ - order id is string, sharding mod(hashcode%5)
+ - N mean execute count

-以下所有数据均在开启了表达式编译缓存的情况下测试，并且电脑处于长时间未关机并且开着很多vs和idea的情况下仅供参考,所有测试都是基于ShardingCore x.3.1.63+ version
-
-以下所有数据均在[源码中有案例](https://github.com/xuejmnet/sharding-core/blob/main/benchmarks/ShardingCoreBenchmark/EFCoreCrud.cs)
-
-efcore版本均为6.0 表结构为string型id的订单取模分成5张表
-
-N代表执行次数
+[Benchmark Demo](https://github.com/xuejmnet/sharding-core/blob/main/benchmarks/ShardingCoreBenchmark/EFCoreCrud.cs)

 ### 性能损耗 sql server 2012,data rows 7734363 =773w

--- a/src/ShardingCore/Extensions/ShardingQueryableExtensions/EntityFrameworkShardingQueryableExtension.cs
+++ b/src/ShardingCore/Extensions/ShardingQueryableExtensions/EntityFrameworkShardingQueryableExtension.cs
@ -71,7 +71,7 @@ namespace ShardingCore.Extensions.ShardingQueryableExtensions
        }

        /// <summary>
-        /// 开启提示路由的前提下手动指定表、手动指定数据源
+        /// 需要Route启用HintRoute:开启提示路由的前提下手动指定表、手动指定数据源
        /// </summary>
        /// <param name="source"></param>
        /// <param name="routeConfigure"></param>
@ -102,10 +102,12 @@ namespace ShardingCore.Extensions.ShardingQueryableExtensions

        /// <summary>
        /// 设置连接而模式
+        /// connectionMode = ConnectionModeEnum.SYSTEM_AUTO
+        /// maxQueryConnectionsLimit就可以简单理解为同一个数据库的并发数
        /// </summary>
        /// <param name="source"></param>
-        /// <param name="maxQueryConnectionsLimit"></param>
-        /// <param name="connectionMode"></param>
+        /// <param name="maxQueryConnectionsLimit">单次查询最大连接数</param>
+        /// <param name="connectionMode">连接模式</param>
        /// <typeparam name="TEntity"></typeparam>
        /// <returns></returns>
        /// <exception cref="ArgumentException"></exception>
@ -133,7 +135,7 @@ namespace ShardingCore.Extensions.ShardingQueryableExtensions
                    : source;
        }
        /// <summary>
-        /// 不使用顺序查询
+        /// 需要Route启用EntityQuery:不使用顺序查询,仅支持单表
        /// </summary>
        /// <typeparam name="TEntity"></typeparam>
        /// <param name="source"></param>
@ -145,11 +147,11 @@ namespace ShardingCore.Extensions.ShardingQueryableExtensions

        }
        /// <summary>
-        /// 使用顺序查询
+        /// 需要Route启用EntityQuery:使用顺序查询,仅支持单表
        /// </summary>
        /// <typeparam name="TEntity"></typeparam>
        /// <param name="source"></param>
-        /// <param name="comparerWithShardingComparer"></param>
+        /// <param name="comparerWithShardingComparer">顺序查询的排序方式是否和表后缀一样</param>
        /// <returns></returns>
        public static IQueryable<TEntity> AsSequence<TEntity>(this IQueryable<TEntity> source,
            bool comparerWithShardingComparer)
--- a/src/ShardingCore/ShardingCore.csproj
+++ b/src/ShardingCore/ShardingCore.csproj
@ -2,7 +2,7 @@
    <PropertyGroup>
        <TargetFramework>net6.0</TargetFramework>
        <Version>$(EFCORE6)</Version>
-        <GenerateAssemblyInfo>true</GenerateAssemblyInfo>
+	    <GenerateAssemblyInfo>true</GenerateAssemblyInfo>
        <DefineConstants>TRACE;DEBUG;EFCORE6;</DefineConstants>
        <LangVersion>latest</LangVersion>
 	    <RepositoryUrl>https://github.com/xuejmnet/sharding-core</RepositoryUrl>