Python使用DBUtils连接部分主流数据库

需要了解的知识

首先呢,你需要了解下DBUtils,我的描述肯定没官网解释来的清晰,自行阅读后,你就会发现我为什么会选用PooledDB而不是其他作为连接池了。

其次,DBUtils支持所有遵循DP-API 2规范的数据库连接模块,也就是说除了我示例中所提供的几个数据库连接方式外,各位可以探索其他遵循此标准的连接模块,从而在此基础上拓展,成为连接更多种类数据库的通用工具类。

最后,以下内容均基于python3。

---------------------------------------------------------

10.23增补内容:支持hbase,更新字典返回方式以及部分方法扩展。

 

准备工作

首先,pip下支持DB-API 2规范的相关数据库连接模块和DBUtils。

pip install DBUtils
pip install pymysql(mysql)
pip install pymssql(sqlserver)
pip install cx_Oracle(oracle)
pip install phoenixdb(hbase)
pip install sqlite3(sqlite3 python自带)

 

其次,需要准备一份配置文件,姑且命名为pdbc.properties,以下是示例,根据数据库的连接信息进行修改即可。

 

# 数据库类型,支持mysql,oracle,sqlserver,sqlite3,hbase
# --------------------------------------------------------------
# mysql
# 连接数据库host
host_mysql=ip
# 连接数据库port
port_mysql=3306
# 连接数据库库名
database_mysql=dbname
# 用户
user_mysql=username
# 密码
password_mysql=password
# 字符集
charset_mysql=utf8
# --------------------------------------------------------------
# oracle
# 连接数据库host
host_orc=ip
# 连接数据库port
port_orc=1521
# 连接数据库库名
database_orc=dbname
# 用户
user_orc=username
# 密码
password_orc=password
# 字符集
nencoding_orc=utf8
# --------------------------------------------------------------
# sqlserver
# 连接数据库host
host_ms=ip
# 连接数据库port
port_ms=1433
# 连接数据库库名
database_ms=dbname
# 用户
user_ms=username
# 密码
password_ms=password
# 字符集
charset_ms=utf8
# --------------------------------------------------------------
# sqlite3
# 连接数据库文件名,sqlite不支持加密,不使用用户名和密码
database_sqlite3=path/to/your/dbname.db
# --------------------------------------------------------------
# hbase
# 连接数据库host
host_hb=ip
# 连接数据库port,phoenixdb连接使用8765端口而非2181等其他端口
port_hb=8765
# 用户
user_hb=username
# 密码
password_hb=password

 

然后,准备一份读取properties文件的工具类,姑且称为PropertiesUtil.py,可以寻找网上的,也可以参考我写的。

# -*- coding:utf-8 -*-


class PropertiesUtil(object):
    # 缓存配置
    __file_dict = {}

    def get_config_dict(self, file_path="pdbc.properties"):
        """
        获取资源文件,形成字典
        :param file_path: 文件路径
        :return:字典内容的key、value均为字符串
        """
        if file_path not in self.__file_dict:
            properties = {}
            with open(file_path, 'r', encoding='UTF-8') as pro_file:
                for line in pro_file.readlines():
                    line = line.strip().replace('\n', '')
                    if line.find('=') > 0 and not line.startswith('#'):
                        strs = line.split('=')
                        value = line[len(strs[0]) + 1:]
                        self.__get_dict(strs[0].strip(), properties, value.strip())
            self.__file_dict[file_path] = properties
        return self.__file_dict[file_path]

    def get_config_value(self, file_path, prop_name):
        """
        获取资源文件,形成字典,获取属性值
        :param file_path: 文件路径
        :param prop_name: 属性名称
        :return: 返回字符串格式的属性值
        """
        return self.get_config_dict(file_path)[prop_name]

    def __get_dict(self, dict_name, properties, value):
        """
        递归获取配置字典
        :param dict_name:键
        :param properties: 字典
        :param value: 值
        :return:
        """
        if dict_name.find('.') > 0:
            key = dict_name.split('.')[0]
            properties.setdefault(key, {})
            self.__get_dict(dict_name[len(key) + 1:], properties[key], value)
        else:
            properties[dict_name] = value


# 获取实例,保持单例
prop = PropertiesUtil()

if __name__ == "__main__":
    # 调用方式,获取实例
    # from util.ConfigUtil import prop
    print(prop.get_config_dict("pdbc.properties"))
    print(prop.get_config_value("pdbc.properties", "dbtype"))

 

大概是重点来了

有几点要先提一下。

1.我这里仅提供增删改查基本功能,其他诸如存储过程、函数等内容我自己也在探索中,故不列出。

2.使用importlib来实现动态加载,因为我不太喜欢开始就导入所有需要的模块,毕竟连接池不是用来同时连接所有类型数据库的。

3.PooledDB和建立连接时的config,我仅罗列了几项基本参数,更多的烦请自行查找资料。(这点是真的不好意思,因为本人只熟悉mysql相关内容,而且还很懒~~)

4.mysql和mssql语句的参数使用%s作为占位符,oracle和sqlite使用:数字作为占位符,sqllite还可以用?作为占位符,详情可以见代码中main函数示例。

5.测试用的表名为TEST2,有两个字段,id 主键 数字类型,name 字符串类型。注意sqlserver的字符串请使用nvarchar类型,不然返回结果可能会乱码。(至于为什么不给建表语句的原因,算了,不编了,就是懒~~)

6. hbase插入语句的参数使用:数字或者?作为占位符,hbase的INSERT请使用UPSERT替换。且hbase中'autocommit': True配置一定要,否则插入删除语句执行无效。

啰嗦了这么多,下面上代码。

# -*- coding:utf-8 -*-
"""
Description: DB工具类

@author: WangLeAi
@date: 2018/9/18
"""
from util.PropertiesUtil import prop
from DBUtils.PooledDB import PooledDB
import importlib


class DbPoolUtil(object):
    def __init__(self, config_file='config/pdbc.properties', db_type='mysql'):
        """
        初始化
        :param config_file:  配置文件地址
        :param db_type: 数据库类型,支持 mysql, oracle, sqlserver, sqlite, hbase
        """
        properties_dic = prop.get_config_dict(config_file)
        self.__db_type = db_type
        if self.__db_type == "mysql":
            config = {
                'host': properties_dic['host_mysql'],
                'port': int(properties_dic['port_mysql']),
                'database': properties_dic['database_mysql'],
                'user': properties_dic['user_mysql'],
                'password': properties_dic['password_mysql'],
                'charset': properties_dic['charset_mysql']
            }
            db_creator = importlib.import_module("pymysql")
            self.__pool = PooledDB(db_creator, maxcached=50, maxconnections=1000, maxusage=1000, **config)
        elif self.__db_type == "oracle":
            config = {
                'user': properties_dic['user_orc'],
                'password': properties_dic['password_orc'],
                'dsn': "/".join(
                    [":".join([properties_dic['host_orc'], properties_dic['port_orc']]),
                     properties_dic['database_orc']]),
                'nencoding': properties_dic['nencoding_orc']
            }
            db_creator = importlib.import_module("cx_Oracle")
            self.__pool = PooledDB(db_creator, maxcached=50, maxconnections=1000, maxusage=1000, **config)
        elif self.__db_type == "sqlserver":
            config = {
                'host': properties_dic['host_ms'],
                'port': int(properties_dic['port_ms']),
                'database': properties_dic['database_ms'],
                'user': properties_dic['user_ms'],
                'password': properties_dic['password_ms'],
                'charset': properties_dic['charset_ms']
            }
            db_creator = importlib.import_module("pymssql")
            self.__pool = PooledDB(db_creator, maxcached=50, maxconnections=1000, maxusage=1000, **config)
        elif self.__db_type == "sqlite":
            config = {
                'database': properties_dic['database_sqlite3']
            }
            db_creator = importlib.import_module("sqlite3")
            self.__pool = PooledDB(db_creator, maxcached=50, maxconnections=1000, maxusage=1000, **config)
        elif self.__db_type == "hbase":
            # 'autocommit': True配置一定要,否则插入删除语句执行无效
            config = {
                'url': 'http://{0}:{1}'.format(properties_dic['host_hb'], properties_dic['port_hb']),
                'user': properties_dic['user_hb'],
                'password': properties_dic['password_hb'],
                'autocommit': True
            }
            db_creator = importlib.import_module("phoenixdb")
            self.__pool = PooledDB(db_creator, maxcached=50, maxconnections=1000, maxusage=1000, **config)
        else:
            raise Exception("unsupported database type " + self.__db_type)

    def execute_query(self, sql, dict_mark=False, args=()):
        """
        执行查询语句,获取结果
        :param sql:sql语句,注意防注入
        :param dict_mark:是否以字典形式返回,默认为False
        :param args:传入参数
        :return:结果集
        """
        result = []
        conn = self.__pool.connection()
        cur = conn.cursor()
        try:
            if dict_mark:
                cur.execute(sql, args)
                # name为description的第一个内容,表示为字段名
                fields = [desc[0] for desc in cur.description]
                rst = cur.fetchall()
                if rst:
                    result = [dict(zip(fields, row)) for row in rst]
            else:
                cur.execute(sql, args)
                result = cur.fetchall()
        except Exception as e:
            print('异常信息:' + str(e))
        cur.close()
        conn.close()
        return result

    def execute_query_single(self, sql, dict_mark=False, args=()):
        """
        执行查询语句,获取单行结果
        :param sql:sql语句,注意防注入
        :param dict_mark:是否以字典形式返回,默认为False
        :param args:传入参数
        :return:结果集
        """
        result = []
        conn = self.__pool.connection()
        cur = conn.cursor()
        try:
            if dict_mark:
                cur.execute(sql, args)
                # name为description的第一个内容,表示为字段名
                fields = [desc[0] for desc in cur.description]
                rst = cur.fetchone()
                if rst:
                    result = dict(zip(fields, rst))
            else:
                cur.execute(sql, args)
                result = cur.fetchone()
        except Exception as e:
            print('异常信息:' + str(e))
        cur.close()
        conn.close()
        return result

    def execute_iud(self, sql, args=()):
        """
        执行增删改语句
        :param sql:sql语句,注意防注入
        :param args:传入参数
        :return:影响行数,mysql和sqlite有返回值
        """
        conn = self.__pool.connection()
        cur = conn.cursor()
        count = 0
        try:
            result = cur.execute(sql, args)
            conn.commit()
            if self.__db_type == "mysql":
                count = result
            if self.__db_type == "sqlite3":
                count = result.rowcount
        except Exception as e:
            print('异常信息:' + str(e))
            conn.rollback()
        cur.close()
        conn.close()
        return count

    def execute_many_iud(self, sql, args):
        """
        批量执行增删改语句
        :param sql:sql语句,注意防注入
        :param args:参数,内部元组或列表大小与sql语句中参数数量一致
        :return:影响行数,mysql和sqlite有返回值
        """
        conn = self.__pool.connection()
        cur = conn.cursor()
        count = 0
        loopK = 5000
        try:
            k = len(args)
            if k > loopK:
                n = k // loopK
                for i in range(n):
                    arg = args[(i * loopK): ((i + 1) * loopK)]
                    cur.executemany(sql, arg)
                    conn.commit()
                arg = args[(n * loopK):]
                if len(arg) > 0:
                    cur.executemany(sql, arg)
                    conn.commit()
            else:
                result = cur.executemany(sql, args)
                conn.commit()
                if self.__db_type == "mysql":
                    count = result
                if self.__db_type == "sqlite3":
                    count = result.rowcount
        except Exception as e:
            print('异常信息:' + str(e))
            conn.rollback()
        cur.close()
        conn.close()
        return count

    def execute_proc(self, proc_name, args=()):
        """
        执行存储过程,mysql适用
        :param proc_name:存储过程/函数名
        :param args:参数
        :return:result为结果集,args_out为参数最终结果(用于out,顺序与传参一致)
        """
        result = ()
        args_out = ()
        conn = self.__pool.connection()
        cur = conn.cursor()
        try:
            cur.callproc(proc_name, args)
            result = cur.fetchall()
            if args:
                sql = "select " + ",".join(["_".join(["@", proc_name, str(index)]) for index in range(len(args))])
                cur.execute(sql)
                args_out = cur.fetchone()
            conn.commit()
        except Exception as e:
            print('异常信息:' + str(e))
            conn.rollback()
        cur.close()
        conn.close()
        return result, args_out

    def loop_row(self, obj, fun_name, sql, args=()):
        """
        执行查询语句,并且对游标每行结果反射调用某个处理方法
        主要是考虑一些表记录太大时,不能一次性取出,游标式取数据
        :param obj: 对象或者模块
        :param fun_name:调用方法名
        :param sql:sql语句,注意防注入
        :param args:传入参数
        :return:
        """
        conn = self.__pool.connection()
        cur = conn.cursor()
        try:
            cur.execute(sql, args)
            fun = getattr(obj, fun_name)
            while True:
                row = cur.fetchone()
                if row is None:
                    break
                fun(row)
        except Exception as e:
            print('异常信息:' + str(e))
        cur.close()
        conn.close()

    def loop_row_custom(self, sql, args=()):
        """
        执行查询语句,并且对游标每行结果执行某些操作或者直接返回生成器
        主要是考虑一些表记录太大时,不能一次性取出,游标式取数据
        :param sql:sql语句,注意防注入
        :param args:传入参数
        :return:
        """
        conn = self.__pool.connection()
        cur = conn.cursor()
        try:
            cur.execute(sql, args)
            while True:
                row = cur.fetchone()
                if row is None:
                    break
                # 在此编写你想做的操作
                print(row)
        except Exception as e:
            print('异常信息:' + str(e))
        cur.close()
        conn.close()


# if __name__ == "__main__":
    # 使用demo,工作目录在项目目录的前提下,使用表为TEST2表
    # dbpool_util = DbPoolUtil(db_type="mysql")
    # sql1 = """DELETE FROM TEST2"""
    # result1 = dbpool_util.execute_iud(sql1)
    # print(result1)

    # mysql和mssql语句的参数使用%s作为占位符,oracle和sqlite使用:数字作为占位符(sqllite还可以用?作为占位符)
    # hbase插入语句的参数使用:数字或者?作为占位符,hbase的INSERT请使用UPSERT替换
    # sql2 = """INSERT INTO TEST2(id,name) VALUES (%s,%s)"""
    # sql2 = """INSERT INTO TEST2(id,name) VALUES (:1,:2)"""
    # sql2 = """UPSERT INTO TEST2(id,name) VALUES (?,?)"""
    # test_args2 = [(1, '王'), (2, '葬爱'), (3, 'shao'), (5, 'nian'), (8, 'wang')]
    # result2 = dbpool_util.execute_many_iud(sql2, test_args2)
    # print(result2)

    # sql3 = """SELECT id as wangleai,name as zangai FROM TEST2 """
    # result3 = dbpool_util.execute_query(sql3)
    # print(result3)
    # result3 = dbpool_util.execute_query_single(sql3)
    # print(result3)
    # result3 = dbpool_util.execute_query(sql3, dict_mark=True)
    # print(result3)
    # result3 = dbpool_util.execute_query_single(sql3, dict_mark=True)
    # print(result3)
    # dbpool_util.loop_row_custom(sql3)

    # 此处反射调用相关方法,文件就不给了,嫌麻烦
    # from util.ClassTest import ClsTest
    #  cla_test = ClsTest()
    # dbpool_util.loop_row(cla_test, "print_row", sql3)
    #
    # import util.ModuleTest as mod_test
    #
    # dbpool_util.loop_row(mod_test, "print_row", sql3)

    # sql4 = """SELECT id,name FROM TEST2 where id = %s"""
    # sql4 = """SELECT id,name FROM TEST2 where id = :1"""
    # test_args4 = (3,)
    # result4 = dbpool_util.execute_query(sql4, args=test_args4)
    # print(result4)

以上,目前支持mysql,oracle,sqlserver,sqlite3和hbase。

 

后记

啊,好久没写长的了,之前都是短、短、短,偶尔也……算了,还是短舒服~~

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章