Python使用cx_Oracle的几个小坑
引言
cx_Oracle是Python环境下的一个(好像也是唯一的一个)用于操作Oracle的第三方模块。
最近在写某个对帐程序时,不得已要连接一台Oracle库,于是用到了cx_Oracle,总的来说还是比较顺利的,期间遇到几个有意思的小坑写出来分享一下。
RHEL 6.4下安装cx_Oracle
RHEL6.4和cx_Oracle比较搭,安装时应该不会遇到什么挫折,使用RPM安装好instantclient后,直接用pip3安装cx_Oracle即可。
需要注意地方:
- 尽量使用RPM方式安装instantclient,安装更方便,而且比zip更好管理。
- instantclient的版本选择的是11.2.0.4.0,没有选择12。对于Oracle/WebLogic这类闭源的东西,还是选择次最新版本的比较稳妥。
安装步骤:
-
下载Linux版本的instantclient
这里是 Oracle官网 instantclient下载页面 ,下载以下3个RPM包:
oracle-instantclient11.2-basic-11.2.0.4.0-1.x86_64.rpm
oracle-instantclient11.2-devel-11.2.0.4.0-1.x86_64.rpm
oracle-instantclient11.2-sqlplus-11.2.0.4.0-1.x86_64.rpm -
安装instantclient并设置环境变量
yum -y install libaio bc flex
rpm -ivh oracle-instantclient11.2-basic-11.2.0.4.0-1.x86_64.rpm
rpm -ivh oracle-instantclient11.2-devel-11.2.0.4.0-1.x86_64.rpm
rpm -ivh oracle-instantclient11.2-sqlplus-11.2.0.4.0-1.x86_64.rpm
- 设置环境变量
echo 'export ORACLE_VERSION="11.2"' >> $HOME/.bashrc
echo 'export ORACLE_HOME="/usr/lib/oracle/$ORACLE_VERSION/client64/"' >> $HOME/.bashrc
echo 'export PATH=$PATH:"$ORACLE_HOME/bin"' >> $HOME/.bashrc
echo 'export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:"$ORACLE_HOME/lib"' >> $HOME/.bashrc
source $HOME/.bashrc
- 使用pip安装cx_Oracle
pip3 install cx_Oracle
macOS 12下安装cx_Oracle
macOS下,安装cx_Oracle后的编译过程有可能会报错,一般是因为instantclient安装有误造成的。
需要注意的地方:
- mac下的instantclient只有zip包一种安装方式,要注意手工建两个软链接。
- pip安装前,注意导入LD_LIBRARY_PATH与DYLD_LIBRARY_PATH两个环境变量。
安装过程:
-
下载Mac版本的instantclient
下载以下3个zip包,并unzip
解压至同一目录:
instantclient-basic-macos.x64-11.2.0.4.0.zip
instantclient-sdk-macos.x64-11.2.0.4.0.zip
instantclient-sqlplus-macos.x64-11.2.0.4.0.zip -
建立软链接
cd /path/to/instant
ln -s libclntsh.dylib.11.2 libclntsh.dylib
ln -s libocci.dylib.11.2 libocci.dylib
- 设置环境变量
export ORACLE_VERSION="11.2"
export ORACLE_HOME="/path/to/instantclient_11_2"
export PATH=$PATH:"$ORACLE_HOME"
- 使用pip安装cx_Oracle,注意提前导入DYLD_LIBRARY_PATH与LD_LIBRARY_PATH
export DYLD_LIBRARY_PATH="$ORACLE_HOME"
export LD_LIBRARY_PATH="$ORACLE_HOME"
pip3 install cx_Oracle
中文乱码问题
Oracle中文乱码问题存在已久,使用cx_Oracle时也不例外,解决方法还是设置NLS_LANG环境变量。
有两种方式,一是在系统中设置永久环境变量,二是直接在代码中使用os.environ
设置环境变量,这里推荐后者。
- 方法一:在Shell中设置环境变量
export NLS_LANG="SIMPLIFIED CHINESE_CHINA.UTF8"
- 方法二:直接在代码中加入:
import os
os.environ['NLS_LANG'] = 'SIMPLIFIED CHINESE_CHINA.UTF8'
PyCharm下不识别cx_Oracle问题
安装安成后,在python的console中已经可以import cx_Oracle
了,但在PyCharm中却提示找不到cx_Oracle。这是一个比较大的坑,可以详细讲一下处理过程。
首先初步定位到原因,是由于PyCharm中没有定义LD_LIBRARY_PATH与DYLD_LIBRARY_PATH两个环境变量造成的。
PyCharm会自动读取系统中的环境变量设置并导入,但唯独这两个没有导进来。不深究原因,先尝试手工在PyCharm中配置这两个环境变量,总共有两处可以配置:
第一处:
CMD+,
打开Preference,找到 Build,Execution,Deployment -> Console -> Python Console ->Enviroment Variables
此处的配置会修复PyCharm中的Console。
第二处:
右上角 Run -> Edit Configurations,添加两条环境变量
此处的配置会修复PyCharm中
Ctrl+Shift+R
运行代码时的报错。
在以上两处手工添加环境变量:
DYLD_LIBRARY_PATH=/path/to/instantclient
LD_LIBRARY_PATH/path/to/instantclient
两处的环境变量配置完成后,虽然console中可以正常使用cx_Oracle了,代码也可以正常运行了,但编辑界面中的inspection还是有问题的,提示有Error,并且不能使用自动完成功能。
于是回到之前的问题,为什么明明已经定义了,但PyCharm却没有找到LD_LIBRARY_PATH与DYLD_LIBRARY_PATH?
同时偶然发现,在执行env
命令查看已定义的环境变量时,也是找不到LD_LIBRARY_PATH与DYLD_LIBRARY_PATH的。
这貌似已经不是PyCharm自身的问题了,需要从macOS系统来着手了。
于是在stackoverflow上找到了这么一段话:
El Capitan added system integrity protection (SIP), and one side effect of that is that exporting DYLD_LIBRARY_PATH doesn't work. That could affect running SQL*Plus from a shell script, for example. There are workarounds for the 11g instant client. The installation notes at the bottom of the download page have changed since I last did this, and it now says to hard link the library files to the user's ~/lib directory to avoid that issue. Fortunately it looks like you don't need to worry about that with the 12c client - they've fixed the way it's built.
看来根本原因是OSX 10.11之后加入的这个SIP引发的了。
首先想到的最简单的方法,将所有的.dylib
和.h
都拷贝到系统默认的目录就可以了。
但很杯具,/usr/lib
和/usr/include
这两个目录也被SIP保护了。因为不想强制关闭SIP,继续再想别的办法。
接着发现/usr/local/lib
和/usr/local/include
目录还是可以操作的,于是拷到这两个目录:
cd /path/to/instantclient
cp *.dylib /usr/local/lib
cp ./sdk/include/*.h /usr/local/include
再将cx_Oracle卸载后重新编译安装:
sudo pip3 uninstall cx_Oracle
sudo pip3 install cx_Oracle
重启PyCharm后,问题解决。
cx_Oracle的简单使用
cx_Oracle的使用上没有什么问题,一切按套路来写就可以了。贴一个简单的示例:
import cx_Oracle
conn = cx_Oracle.connect('username', 'password','host:port/sid')
cursor = conn.cursor()
cursor.execute('select column from table')
result = cursor.fetchall()
for row in result:
print(row)
cursor.close()
conn.close()
更加详细的内容请参考官方文档:
https://cx-oracle.readthedocs.io/en/latest/
https://oracle.github.io/python-cx_Oracle/
参考文档
https://gist.github.com/thom-nic/6011715
http://stackoverflow.com/questions/37711482/how-to-install-oracle-instant-client-on-a-mac