Skip to content

Commit a1bd617

Browse files
committed
[Mod] 更新说明文档
1 parent 619bc33 commit a1bd617

File tree

3 files changed

+37
-40
lines changed

3 files changed

+37
-40
lines changed

README.md

Lines changed: 36 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -12,59 +12,57 @@
1212

1313
## 说明
1414

15-
基于peewee开发的Mysql数据库接口
15+
基于peewee开发的MySQL数据库接口
1616

17-
由于peewee对Mysql的限制,目前存在以下问题。如不影响使用可以忽略,当影响使用时,可按照以下方式手动修改mysql数据库表来解决。
17+
## 使用
18+
19+
### 全局配置
20+
21+
在vn.py中使用MySQL时,需要在全局配置中填写以下字段信息:
22+
23+
|名称|含义|必填|举例|
24+
|---------|----|---|---|
25+
|database.name|名称||mysql|
26+
|database.host|地址||localhost|
27+
|database.port|端口||3306|
28+
|database.database|实例||vnpy|
29+
|database.user|用户名||root|
30+
|database.password|密码||123456|
31+
32+
### 创建实例(Schema)
1833

19-
- 保存tick数据时,保存数据的时间精确度只能精确到秒
34+
vn.py不会主动为MySQL数据库创建实例,所以使用前请确保database.database字段中填写的的数据库实例已经创建了。
35+
36+
若实例尚未创建,可以使用【MySQL Workbench】客户端的【new_schema】进行操作。
37+
38+
### Tick时间戳的毫秒支持
39+
40+
由于peewee的建表功能限制,默认情况下在保存tick数据时,时间精确度只能精确到秒。如果影响使用,可按照以下方式手动修改MySQL数据表来解决:
2041

2142
```
22-
# 首先进入Mysql数据库
23-
# 选择vnpy数据库
43+
# 用MySQL命令行工具连接数据库
44+
45+
# 选择数据实例
2446
use vnpy;
47+
2548
# 修改dbtickdata表datetime列的数据格式
2649
ALTER TABLE `dbtickdata` MODIFY COLUMN `datetime` DATETIME(3);
2750
```
2851

29-
- 部分系统对大小写不明敏感
52+
### 字符串大小写敏感支持
53+
54+
由于peewee的建表功能限制,默认情况下在保存合约代码的【symbol】字段时,无法区分字符串大小写。如果影响使用,可按照以下方式手动修改MySQL数据表来解决:
3055

3156
```
32-
# 首先进入Mysql数据库
33-
# 选择vnpy数据库
57+
# 用MySQL命令行工具连接数据库
58+
59+
# 选择数据实例
3460
use vnpy;
35-
# 修改三张表symbol字段BINARY属性
61+
62+
# 修改三张表symbol字段的BINARY属性
3663
ALTER TABLE `dbbaroverview` MODIFY COLUMN `symbol` VARCHAR(45) BINARY;
3764
3865
ALTER TABLE `dbbardata` MODIFY COLUMN `symbol` VARCHAR(45) BINARY;
3966
4067
ALTER TABLE `dbtickdata` MODIFY COLUMN `symbol` VARCHAR(45) BINARY;
4168
```
42-
43-
## 使用
44-
45-
MySQL在VN Trader中配置时,需要填写以下字段信息:
46-
47-
| 字段名 ||
48-
|--------- |---- |
49-
|database.driver | "mysql" |
50-
|database.host | 地址 |
51-
|database.port | 端口 |
52-
|database.database | 数据库名 |
53-
|database.user | 用户名 |
54-
|database.password | 密码 |
55-
56-
MySQL的例子如下所示:
57-
58-
| 字段名 ||
59-
|--------- |---- |
60-
|database.driver | mysql |
61-
|database.host | localhost |
62-
|database.port | 3306 |
63-
|database.database | vnpy |
64-
|database.user | root |
65-
|database.password | .... |
66-
67-
请注意,vn.py不会主动为关系型数据库创建数据库,所以请确保你所填的database.database字段对应的数据库已经创建好了。若未创建数据库,请手动连上数据库并运行该命令:
68-
```
69-
create database <你填的database.database>;
70-
```

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ url = https://www.vnpy.com
55
license = MIT
66
author = Xiaoyou Chen
77
author_email = xiaoyou.chen@mail.vnpy.com
8-
description = Mysql database manager for vn.py quant trading framework.
8+
description = MySQL database adapter for vn.py quant trading framework.
99
long_description = file: README.md
1010
long_description_content_type = text/markdown
1111
keywords =

vnpy_mysql/mysql_database.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""""""
21
from datetime import datetime
32
from typing import List
43

0 commit comments

Comments
 (0)