Skip to content

Commit 60b3963

Browse files
committed
update readme
1 parent eb3f43f commit 60b3963

File tree

2 files changed

+35
-22
lines changed

2 files changed

+35
-22
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*:star: Leave a star if django-db-connection-pool is helpful to you, or you like it, Thank you:smile:*
44

5-
MySQL & Oracle & PostgreSQL & JDBC connection pool backends of Django,
5+
MySQL & Oracle & PostgreSQL & JDBC (Oracle, OceanBase) connection pool backends of Django,
66
Be based on [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy).
77
Work fine in multiprocessing and multithreading django project.
88

@@ -57,7 +57,7 @@ DATABASES = {
5757
}
5858
```
5959

60-
#### pool options(optional)
60+
#### Pool options(optional)
6161
you can provide additional options to pass to SQLAlchemy's pool creation, key's name is `POOL_OPTIONS`:
6262

6363
```python
@@ -111,30 +111,30 @@ import dj_db_conn_pool
111111
dj_db_conn_pool.setup(pool_size=100, max_overflow=50)
112112
```
113113

114-
## JDBC
115-
Thanks to [JPype](https://github.com/jpype-project/jpype)[JayDeBeApi](https://github.com/baztian/jaydebeapi/),
114+
## JDBC (experimental, NOT PRODUCTION READY)
115+
Thanks to [JPype](https://github.com/jpype-project/jpype) [JayDeBeApi](https://github.com/baztian/jaydebeapi/) ,
116116
django-db-connection-pool can connect to database in jdbc way
117117

118118
### Usage
119-
#### Setup java runtime env
119+
#### Set Java runtime environment
120120
```bash
121121
export JAVA_HOME=$PATH_TO_JRE;
122122
export CLASSPATH=$PATH_RO_JDBC_DRIVER_JAR
123123
```
124124

125-
### Start JVM
126-
Start JVM before Django's app initialization
125+
#### Start JVM
126+
Start JVM before initialization of Django
127127

128128
```python
129129
import jpype
130130
jvm_path = jpype.getDefaultJVMPath()
131131
jpype.startJVM(jvm_path)
132132
```
133133

134-
### Update settings.DATABASES
135-
#### JDBC Oracle
134+
#### Update settings.DATABASES
135+
##### Oracle
136136

137-
change `django.db.backends.oracle` to `dj_db_conn_pool.backends.oracle`:
137+
change `django.db.backends.oracle` to `dj_db_conn_pool.backends.jdbc.oracle`:
138138
```python
139139
DATABASES = {
140140
'default': {
@@ -143,5 +143,12 @@ DATABASES = {
143143
}
144144
```
145145

146-
#### MySQL and etc.
147-
already in todo list...
146+
##### OceanBase
147+
use `dj_db_conn_pool.backends.jdbc.oceanbase`:
148+
```python
149+
DATABASES = {
150+
'default': {
151+
'ENGINE': 'dj_db_conn_pool.backends.jdbc.oceanbase'
152+
}
153+
}
154+
```

README_CN.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*:star: 如果这个库能对你有所帮助,不妨点个star,谢谢:smile:*
44

5-
驱动 Django 访问 MySQL、Oracle、PostgreSQL、JDBC 连接池的轮子,
5+
驱动 Django 访问 MySQL、Oracle、PostgreSQL、JDBC (Oracle, OceanBase) 连接池的轮子,
66
基于 [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) 队列池。
77
在多进程、多线程 django 项目中,运行良好。
88

@@ -114,18 +114,17 @@ import dj_db_conn_pool
114114
dj_db_conn_pool.setup(pool_size=100, max_overflow=50)
115115
```
116116

117-
## JDBC
118-
基于 [JPype](https://github.com/jpype-project/jpype)[JayDeBeApi](https://github.com/baztian/jaydebeapi/)
119-
django-db-connection-pool 现在可以通过 jdbc 连接到数据库并保持连接
117+
## JDBC(仍在完善中,不建议用于生产)
118+
基于 [JPype](https://github.com/jpype-project/jpype) [JayDeBeApi](https://github.com/baztian/jaydebeapi/) ,django-db-connection-pool 现在可以通过 jdbc 连接到数据库并保持连接
120119

121-
### 配置方法
120+
### 使用方法
122121
#### 设置环境变量
123122
```bash
124123
export JAVA_HOME=$PATH_TO_JRE;
125124
export CLASSPATH=$PATH_RO_JDBC_DRIVER_JAR
126125
```
127126

128-
### 启动 JVM
127+
#### 启动 JVM
129128
在引用 `dj_db_conn_pool.backends.jdbc.xxx` 前,调用 jpype 启动 JVM
130129

131130
```python
@@ -134,8 +133,8 @@ jvm_path = jpype.getDefaultJVMPath()
134133
jpype.startJVM(jvm_path)
135134
```
136135

137-
### 更新 settings.DATABASES 配置
138-
#### JDBC Oracle
136+
#### 更新 settings.DATABASES 配置
137+
##### Oracle
139138

140139
将 ENGINE `django.db.backends.oracle` 更改为 `dj_db_conn_pool.backends.jdbc.oracle`:
141140
```python
@@ -146,5 +145,12 @@ DATABASES = {
146145
}
147146
```
148147

149-
#### MySQL 等
150-
将陆续补充
148+
##### OceanBase
149+
使用 `dj_db_conn_pool.backends.jdbc.oceanbase` 作为 Django 数据库后端:
150+
```python
151+
DATABASES = {
152+
'default': {
153+
'ENGINE': 'dj_db_conn_pool.backends.jdbc.oceanbase'
154+
}
155+
}
156+
```

0 commit comments

Comments
 (0)