Update README_cn.md

Author: jayvynl

README_cn.md

@@ -4,9 +4,10 @@ Django ClickHouse Database Backend
 简介
 ---
 
-ClickHouse 数据库的 Django 引擎，实现使用Django原生的ORM操作clickhouse数据库。
+ClickHouse 数据库的 Django 数据库底端，实现使用Django原生的ORM操作clickhouse数据库。
 
-底层驱动使用 [clickhouse-driver](https://clickhouse-driver.readthedocs.io/en/latest/) ，支持django 3.2。
+底层驱动使用 [clickhouse-driver](https://clickhouse-driver.readthedocs.io/en/latest/) ，支持django 3.2及以上。
+使用 [clickhouse-pool](https://github.com/ericmccarthy7/clickhouse-pool) 实现数据库连接池。
 
 特性
 ---
@@ -31,25 +32,23 @@ ClickHouse 数据库的 Django 引擎，实现使用Django原生的ORM操作clic
 ### 安装
 
 ```shell
-pip install git+http://gitlab.bolean.com/wen/django-clickhouse-backend.git
+pip install git+https://github.com/jayvynl/django-clickhouse-backend
 ```
 
 ### 使用
 
-示例项目可在[项目](http://gitlab.bolean.com/wen/django-clickhouse-backend) 中的 `test_project` 中查看。
+参考[示例项目](example)
 
 #### 数据库设置
 
-  以下例子中展示了Pg和CH双数据库的配置，其中ClickHouse中只有`ENGINE`是必选项，其他项的默认值如下：
+  以下例子中展示了PostgreSQL和ClickHouse双数据库的配置，其中ClickHouse只有`ENGINE`是必选项，其他项的默认值如下：
 
   - NAME: 默认数据库名称default
-  
   - HOST: 默认连接地址localhost
-  
   - PORT: 默认端口9000
-  
-  - USER PASSWORD: 默认没有用户名和密码
-  
+  - USER: 默认用户default
+  - PASSWORD: 默认密码为空
+
   ```python
   DATABASES = {
       'default': {
@@ -62,6 +61,7 @@ pip install git+http://gitlab.bolean.com/wen/django-clickhouse-backend.git
       'clickhouse_backend': {
           'ENGINE': 'clickhouse_backend.backend',
           'NAME': 'default',
+          'HOST': 'localhost',
           'USER': 'DB_USER',
           'PASSWORD': 'DB_PASSWORD',
           'TEST': {
@@ -73,50 +73,10 @@ pip install git+http://gitlab.bolean.com/wen/django-clickhouse-backend.git
 
 #### 定义数据库模型
 
-  下面的例子中定义了ENGINE、ORDER BY、PARTITION BY等ClickHouse常用的属性。
+  支持ENGINE、ORDER BY、PARTITION BY等ClickHouse常用的属性，参考[示例项目](example/testapp/models.py)。
 
-  `GenericIPAddressField` 建议使用 `clickhouse.models.fields.GenericIPAddressField`，否则修改带IP类型的对象在保存时会报错。
+  `GenericIPAddressField` 建议使用 `clickhouse_backend.models.fields.GenericIPAddressField`，否则修改带IP类型的对象在保存时会报错。
 
-  ```python
-  from django.db import models
-
-from clickhouse_backend.models import ClickhouseModel
-from clickhouse_backend.models.engines import ReplacingMergeTree
-from clickhouse_backend.models.indexes import Index, Set
-from clickhouse_backend.models.fields import GenericIPAddressField
-
-
-class Packet(ClickhouseModel):
-  device = models.IntegerField(default=0)
-  src_ip = GenericIPAddressField('源IP地址', default='::')
-  src_mac = models.CharField('源MAC地址', max_length=17, default='')
-  src_port = models.PositiveSmallIntegerField('源端口', default=0)
-  dst_ip = GenericIPAddressField('目的IP地址', default='::')
-  dst_mac = models.CharField('目的MAC地址', max_length=17, default='')
-  dst_port = models.PositiveSmallIntegerField('目的端口', default=0)
-  transport = models.CharField('传输层协议', max_length=3, default='')
-  protocol = models.TextField('协议', default='')
-  content = models.TextField('全部应用层内容', default='')
-  occurred_at = models.DateTimeField('发生时间')
-  created_at = models.DateTimeField('创建时间', auto_now_add=True)
-  length = models.PositiveIntegerField('字节数')
-  count = models.PositiveIntegerField('包数', default=1)
-
-  class Meta:
-    verbose_name = '协议审计'
-    ordering = ['-id']
-    db_table = 'packet'
-    engine = ReplacingMergeTree()
-    order_by = ('id',)
-    partition_by = Function('occurred_at', function='toYYYYMMDD')
-    indexes = [
-      Index(
-        fields=('src_ip', 'dst_ip'),
-        type=Set(1000),
-        granularity=4
-      )
-    ]
-  ```
 
 #### 多数据库配置
 
@@ -130,18 +90,18 @@ class Packet(ClickhouseModel):
 
       def db_for_read(self, model, **hints):
           if model._meta.app_label in self.route_app_labels:
-              return 'clickhouse_backend'
+              return 'clickhouse'
           return None
 
       def db_for_write(self, model, **hints):
           if model._meta.app_label in self.route_app_labels:
-              return 'clickhouse_backend'
+              return 'clickhouse'
           return None
 
       def allow_migrate(self, db, app_label, model_name=None, **hints):
           if app_label in self.route_app_labels:
-              return db == 'clickhouse_backend'
-          elif db == 'clickhouse_backend':
+              return db == 'clickhouse'
+          elif db == 'clickhouse':
               return False
           return None
   ```
@@ -156,26 +116,30 @@ class Packet(ClickhouseModel):
 
   ```shell
   python manage.py makemigrations
-  python manage.py migrate --database clickhouse_backend
+  python manage.py migrate --database clickhouse
   ```
 
-  注意迁移的时候必须指定 --database clickhouse 指定执行clickhouse的迁移，否则默认执行default数据库的迁移。
+  注意迁移的时候必须指定 `--database clickhouse` 指定执行clickhouse的迁移，否则默认执行default数据库的迁移。
 
 #### 单元测试
 
   如果使用django内置的TestCase，需要为测试的类增加一个databases类属性，指定在测试中使用clickhouse数据库，例如：
   ```python
+  from django.test import TestCase
   class Test(TestCase):
       databases = {'default', 'clickhouse_backend'}
   ```
 
   如果使用pytest和pytest-django，[多数据库测试](https://pytest-django.readthedocs.io/en/latest/database.html#tests-requiring-multiple-databases) 都需要为pytest.mark.django_db增加一个databases参数，指定在测试中使用clickhouse数据库。
 
   ```python
+  import pytest
+  from testapp.models import Event
+
   @pytest.mark.django_db(databases={'default', 'clickhouse_backend'})
   class Test:
       def test_spam(self):
-          assert MyModel.objects.using('clickhouse_backend').count() == 0
+          assert Event.objects.using('clickhouse').count() == 0
   ```
 
   > **注意**
@@ -188,7 +152,7 @@ class Packet(ClickhouseModel):
 
 ### 数据库迁移
 
-数据库迁移只支持初始的创建、表名修改、字段增删改等简单修改，那么如何维护其他的表结构更新呢?
+数据库迁移只支持表初始的创建、表名修改、字段增删改等简单修改，那么如何维护其他的表结构更新呢?
 
 目前没有好的办，假如没有生成正确的迁移文件，那么就需要手写迁移文件。
 
@@ -204,13 +168,13 @@ Django自动生成的主键是BigAutoField或AutoField，因为Django内置的mo
 
 - 使用BigAutoField
 
-  在数据库中生成Int64类型的列，插入数据时如果未指定主键值，那么默认会使用IdWorker生成唯一主键。
+  在数据库中生成Int64类型的列，插入数据时如果未指定主键值，那么默认会使用`clickhouse.idworker.id_worker`生成唯一主键。
 
-  项目中用到了Twitter的snowflake算法生成唯一主键，实现在clickhouse.snowflake.IdWorker，如果使用多进程启动项目，必须保证每个项目的worker_id是唯一的。
+  项目中用到了Twitter的snowflake算法生成唯一主键，实现在`clickhouse.idworker.snowflake.SnowflakeIDWorker`，如果使用多进程启动项目，必须保证每个进程的(CLICKHOUSE_WORKER_ID, CLICKHOUSE_DATACENTER_ID)环境变量是唯一的。
 
-  可以通过CLICKHOUSE_SNOWFLAKE_ID环境变量传入worker_id。因为使用5位表示workerID，所以范围是 0-31，如果传入了无效的worker_id会报错。
-  
-  如果没有指定CLICKHOUSE_SNOWFLAKE_ID，默认使用31。最多可以为32个进程指定不同的worker id。
+  因为使用work_id和datacenter_id都是5bit，所以范围是 0-31，如果传入了无效的值会报错，CLICKHOUSE_WORKER_ID默认值是0，CLICKHOUSE_DATACENTER_ID如果未提供则随即生成。
+
+  出于效率，默认的`clickhouse.idworker.snowflake.SnowflakeIDWorker`是线程不安全的，用户可继承`clickhouse.idworker.base.BaseIDWorker`实现自己的版本，并在项目的`settings.py`中设置`CLICKHOUSE_ID_WORKER`值为自定义`BaseIDWorker`实例的倒入路径。
 
 在Django 3.12，django内置的app或其他第三方app如果要使用BigAutoField作为默认主键类型，需要设置：
 
@@ -225,7 +189,8 @@ DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
 例如通过设置 `mutations_sync=1` 能够让数据的更新同步执行，默认情况下数据的修改是在后台异步执行的，参考 [mutations_sync](https://clickhouse.com/docs/en/operations/settings/settings/#mutations_sync) ：
 
 ```python
-Packet.objects.filter(protocol='S7').setting(mutations_sync=1).update(dst_port=102)
+from testapp.models import Event
+Event.objects.filter(protocol='S7').setting(mutations_sync=1).update(dst_port=102)
 ```
 
 待实现