13 Star 38 Fork 7

CallMeE / dophon-db

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

dophon-db

项目介绍

dophon框架的数据库模块,也可单独作为一个与数据库模块交互的部件

支持mysql数据库连接

支持orm形式的数据操作

如有疑问请发送邮件联系作者:ealohu@163.com

软件架构

模块架构分为以组件:

  1. mysql连接组件(包括连接池,连接封装类,分页,结果输出过滤器,远程接收器,增量检测)

  2. orm映射组件(包括映射基础结构定义,映射封装工具,映射操作定义)

  3. 抽象工具集(包括结果集文件读取,解析,热更新,动态赋值等)

  4. 多数据源(xml,orm)管理器,已内嵌到相应模块中

安装教程

pip安装:

pip install dophon-db [--user]

使用说明

0. 配置相关
# 此处为数据库配置
pool_conn_num = 5 # size of db connect pool() # 数据库连接池连接数(默认5个)
pydc_host = 'localhost' # 数据库连接地址
pydc_port = 3306 # 数据库连接端口
pydc_user = 'username' # 数据库连接用户名
pydc_password = 'password' # 数据库连接密码
pydc_database = 'database' # 连接数据库名(可在后面跟连接参数)
pydc_xmlupdate_sech = False # 结果集映射调度开关
db_pool_exe_time = False # 连接池执行时间调试开关

# 多数据源配置(数据库表创建请看test/test.sql)
db_cluster = [
    {
        'alias': 'data-a',
        'host': 'localhost',
        'port': 3306,
        'database': 'test1',
        'user': 'root',
        'password': 'root'
    }, {
        'alias': 'data-b',
        'host': 'localhost',
        'port': 3306,
        'database': 'test2',
        'user': 'root',
        'password': 'root'
    }, {
        'alias': 'data-c',
        'host': 'localhost',
        'port': 3306,
        'database': 'test3',
        'user': 'root',
        'password': 'root',
        'tables':['a','user']
    }, {
        'alias': 'data-d',
        'host': 'localhost',
        'port': 3306,
        'database': 'test4',
        'user': 'root',
        'password': 'root'
    }
]


1. 结果集映射方式

结果集:sql执行脚本的一个集合,由于在实际开发中查询居多,简称结果集

通过xml文件规范若干结果集组成

mysql.xml
<select id="findAll">
    SELECT
    *
    FROM
    table
</select>

通过代码关联xml文件,初始化结果集

from dophon.mysql import *

_cursor=db_obj(mysql.xml,auto_fix=True)

# 根路径为配置文件路径
# 文件路径必须以/开头

通过代码获取xml文件其中某一个结果集(以id区分)

result= _cursor.exe_sql(methodName='findAll')

支持动态参数传入(#{}形式)以及骨架参数传入(${形式})

动态参数传入:

<select id="findAllById">
    SELECT
    *
    FROM
    table
    WHERE
    id=#{id}
</select>
result= _cursor.exe_sql(methodName='findAllById',args={'id':'12345678'})

骨架参数传入:

<select id="findAllByTableName">
    SELECT
    *
    FROM
    ${table_name}
</select>
result= _cursor.exe_sql(methodName='findAllByTableName',args={'table_name':'test_table'})

支持单条查询,列表查询,队列查询(结果集id与参数列表的列表形式和字典形式)

单条查询:

<select id="findAllById">
    SELECT
    *
    FROM
    table
    WHERE
    id=#{id}
</select>
result= _cursor.exe_sql_single(methodName='findAllById',args={'id':'12345678'})


# result<dict>

列表查询:

<select id="findAllById">
    SELECT
    *
    FROM
    table
    WHERE
    id=#{id}
</select>
result= _cursor.exe_sql(methodName='findAllById',args={'id':'12345678'})

# result<list>

队列查询:

1.列表形式:

result= _cursor.exe_sql_queue(
    method_queue=['test1','test2'],
    args_queue=[
        {'id':'123456','name':'tom'},
        {}
    ]
)

# result<dict>
# {
#   method_name:exec_result
# }

2.字典形式:

result= _cursor.exe_sql_obj_queue(
    queue_obj={
        'test1':{
            'id':'123456'
        },
        'test2':{}
    }
)

# result<dict>
# {
#   method_name:exec_result
# }

支持结果集文件热更新

update_round(_cursor,1)

# update_round(<cursor>,second:int)

支持远程维护结果集文件

# remote_path为xml文件下载地址
remote_cell = remote.get_cell('test.xml', remote_path='http://127.0.0.1:8400/member/export/xml/test.xml')
_cursor = db_obj(remote_cell.getPath(), debug=True)
# 或者
_cursor = db_obj(remote_cell, debug=True)

2. 表模型映射方式

暂时支持单条事务操作

通过初始化模型管理器获取数据库表映射骨架

from dophon import orm
manager = orm.init_orm_manager(['user'])

通过实例化映射骨架获取表操作缓存实例(操作实例)

user = manager.user()

通过对操作实例赋值进行对对应表模拟操作

print('打印对象变量域')
for attr in dir(user):
    print(attr, ":", eval("user." + attr))
print('开始对对象赋值')
user.user_id = 'id'
user.info_id = 'info_id'
user.user_name = 'user_name'
user.user_pwd = 'user_pwd'
user.user_status = 123
user.create_time = datetime.datetime.now().strftime('%y-%m-%d')
user.update_time = datetime.datetime.now().strftime('%y-%m-%d')
print('对象赋值完毕')
print('打印对象变量域')
for attr in dir(user):
    print(attr, ":", eval("user." + attr))
print('打印对象参数表')
print(user([]))

print('user([]):', user([]))
print("user(['user_id','info_id']):", user(['user_id', 'info_id']))
print("user.get_field_list():", user.get_field_list())
print("user.alias('user_table').get_field_list():", user.alias('user_table').get_field_list())


通过对操作实例结构化操作对数据库对应表结构进行数据落地操作

# 打印对象操作语句(内部方法)
print(user.where())
print(user.values())

user.select()  # 执行对象查询操作(未赋值对象执行全部查询)
user.user_name = '111' # 对对象某一属性赋值
user.select_one() # 执行单条条件查询(条件为对象已有值),复数结果时抛出异常
user.select_all() # 执行全部条件查询(条件为对象已有值)

user = manager.user() # 获取另一个模型对象
user.alias('u').select() # 对对象赋予别名并执行全部查询操作
user.user_name = '111' # 对对象某一属性赋值
user.alias('us').select_one() # 对对象赋予另一个别名并执行全部查询操作
user.alias('userr').select_all() # 对对象赋予另一个别名并执行全部查询操作

# 对对象某一属性赋值(属性类型与数据库类型相对应)
user.user_id='test_id' # 字符串类型
user.info_id='test_info_id'
user.user_name='test_user_name'
user.user_pwd='test_user_pwd'
user.user_status=1 # 数字类型
user.create_time = datetime.datetime.now().strftime('%y-%m-%d') # 日期类型
user.update_time = datetime.datetime.now().strftime('%y-%m-%d')

print(user.insert()) # 执行对象插入操作并打印操作结果

# 对对象某一属性赋值并选择其中某部分属性进行更新,其中指定了执行更新查询条件
user.user_id = 'test_id'
user.info_id = 'info_id'
user.user_name = '柯李艺'
user.user_pwd = '333'
user.user_status = 123
print(user.update(update=['user_name','user_pwd'],where=['user_id']))

# 对对象某一属性赋值并指定删除条件进行删除操作
user.user_id = 'test_id'
user.info_id = 'info_id'
user.user_name = 'user_name'
user.user_pwd = 'user_pwd'
user.user_status = 123
print(user.delete(where=['user_id']))

# 获取两个新的模型对象
user1=manager.user()
user2=manager.user()
# 打印对象1的全部查询结果
print(user1.select())
# 对对象1属性赋值
user1.user_name='early'
# 执行对象1左关联对象2,并指定关联关系(user1.user_id = user2.user_id)
user1.left_join(user2,['user_id'],['user_id'])
# 执行对象1左关联对象2,指定对象1别名(u1),对象2别名(u2),并指定关联关系(user1.user_id = user2.user_id)
user1.alias('u1').left_join(user2.alias('u2'),['user_id'],['user_id'])
# print(user1.exe_join())
# 打印对象1关联后的全部查询结果
print(user1.select())

"""
模型对象的复制与生成
"""
# 获取新的模型操作对象
user1 = manager.user()
print('user1', '---', id(user1)) # 打印对象1的id
user2 = user1.copy_to_obj(manager.user) # 利用对象管理器实例中的模型模板进行对象获取
print('user2', '---', id(user2)) # 打印对象2的id
print(user1('user_id'))
user3 = user1.read_from_dict({
    'user_id': '111'
})  # 利用模型对象中的翻译方法将字典生成一个新的模型对象
print('user3', '---', id(user3)) # 打印对象3的id
# 对比两者id
print(user1('user_id')) 
print(user3('user_id'))

参与贡献

若有意向参与贡献,请留言或发送邮件至ealohu@163.com

  1. Fork 本项目
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

dophon框架的数据库模块,支持mysql,sqlite数据库,带有orm持久化功能与链式操作实例,贴近逻辑习惯,支持mysql多数据源配置 展开 收起
Python
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/callmee/dophon-db.git
git@gitee.com:callmee/dophon-db.git
callmee
dophon-db
dophon-db
master

搜索帮助

14c37bed 8189591 565d56ea 8189591