/vSQL

基于pymysql的对象关系映射数据库框架

Primary LanguagePython

vSQL

Version : v011

基于pymysql的关系映射型数据库框架

项目结构：

vSQL
|-init.py
|- vattr.py
|- vorm.py
|_ db.json 打开此文件，在对应位置输入值(host,user,password,database)。

如何使用：

0.初始化：

将vSQL放入你的项目文件目录下。
修改db.json文件内容： 

{"HOST": "<服务器名>", "USER": "<用户名>", "PWD": "<密码>", "DB": "<数据库名>"}

导入vSQL包
例:创建Model.py文件:

from vSQL.vorm import Module
from vSQL.vattr import *

1.创建

根据你想要创建的表名和列名创建相应的类(使该类继承vorm中的Module类)和类属性。

例如:(同样在Model.py)

# 创建一个名为User的表(table)
class User(Module):
    id = column(zintger(20), isAutocount=True, isPrimary=True, isNotnull=True)
    name = column(zchar(20), isNotnull=True)
    # 分别创建id，name两个列

（注意，要想编写__init__构造函数，请务必调用super().init()，否则会报错）

当创建如上述代码中的类时。 等效于SQL语句中的：

CREATE TABLE IF NOT EXISTS User(id INTEGER(20) AUTO_INCREMENT PRIMARY KEY NOT NULL, name CHAR(20) NOT NULL)

之后程序就会自动帮你创建出该表与其列。

2.插入

创建Test.py文件

from Model import *
# 从Model.py中导入
def main():
    user = User(name='VoterLin').insert()
    # 由于id被AUTO_INCREMENT修饰，在数据插入时，id将会自动生成。
    id = user.id
    # 此时需要获得插入后生成的id时，可直接调用被赋值实例的id值。

等效于SQL语句中的：

INSERT INTO User (name) VALUES ('VoterLin')

3.删除

def main():
    User().delete()
    # 清空表
    User(id=123456).delete()
    # 删除id值为123456的行
    User(name='Lin').delete(islike=True)
    # 删除name值中带有Lin的行

等效于SQL语句中的：

DELETE FROM User
DELETE FROM User WHERE id = 123456
DELETE FROM User WHERE name LIKE '%Lin%'

4.查找

def main():
    userList = User().select()
    # 获取User表所有结果(数组)
    userList = User(id=123456).select()
    # 获取对应的查询结果(数组)
    user = User(id=123456).select(getone=True)
    # select方法中定义getone为True, 获取第一个查询结果(User)
    user = User(name='Lin').select(islike=True)
    # select方法中定义islike为True，进行模糊查询。

等效于SQL语句中的：

SELECT * FROM User
SELECT * FROM User WHERE id = 123456
SELECT * FROM User WHERE name LIKE '%Lin%'

其返回值newsList的是包含查找结果的数组，其中每一项是一个User类型。 打印userList的结果:

    for user in userList：
        print(user.id, user.name)

除了上述方法以外还可以添加其他的约束条件：

    userList = User(name='Lin').select(oderby='id', isasc=True, limit=5)

等效于SQL语句中的：

SELECT * FROM User WHERE name = 'Lin' ODER BY id ASC LIMIT 5

5.分页

在实际的生产环境中经常要用到分页操作, vSQL提供Pagination这个类来完成此操作.

def main():
  pag = User().set_pagination(page=1, pageing=30).select(oderby='id', isasc=True)
  # 调用set_pagination方法.page当前访问的页面(page=1,当前访问第一页) 
  # pageing为你想要一个页面显示的条目数(pageing=30,一个页面显示30条结果)
  # 返回值为Pagination类实例. 
  pag.page          # 当前页数
  pag.item_count    # 符合查询条件的所有结果数
  pag.items         # 查询结果
  pag.pages         # 总页数
  pag.hasPrev       # 当前页面是否有前一页
  pag.hasNext       # 当前页面是否有后一页
  pag.hasItem       # 是否有符合查询条件的结果

等效于SQL语句中的：

SELECT * FROM User ODER BY id ASC LIMIT 0, 30

详细

由上述已知vSQL的基本操作。接下来是详细内容

1.column类

还是这个例子:

class User(Module):
    id = column(zintger(20), isAutocount=True, isPrimary=True, isNotnull=True)
    name = column(zchar(20), isNotnull=True)

其中给列赋值的column是一个类。 column类的构造方法中可以传入以下参数:

    参数        参数类型      默认值       对应sql
    type        method      None        CHAR / VARCHAR / INTEGER / DOUBLE / DATETIME / DATE / TIME
    isPrimary   bool        False       PRIMARY KEY
    isAutocount bool        False       AUTO_INCREMENT
    isNotnull   bool        False       NOT NULL

按上述参数全部赋值就是下面这样:

    col = column(zchar(20), isPrimary=True, isAutocount=True, isNotnull=True)

等效于SQL语句中的：

    col CHAR(20) AUTO_INCREMENT PRIMARY KEY NOT NULL

column中的type参数

按之前的代码应该可以大致知道，type就对应SQL语句中相应的类型(如 CHAR / VARCHAR / INTEGER 等等...)。 我在vSQL中现在只编写了一小部分类型。

    type        必传入参数      可传入参数                    对应sql
    zbool()                     default                     TINYINT
    zchar()     size            default                     CHAR
    zvarchar()  size            default                     VARCHAR
    zintger()                   size/default/isunsigned     INTGER
    zdouble()   size_M/size_D   default/isunsigned          DOUBLE
    zdatetime()                 default                     DATETIME
    zdate()                     default                     DATE
    ztime()                     default                     TIME
    ztext()                     default                     TEXT
    # 赋值给default，等于给该类型一个默认值
    # 赋值给isunsigned，是设 整形/浮点型 为无符号

2.Module类

通过上述代码知道继承Module后，就在可以相应的在MySQL数据库中创建表与列。 并且拥有了 select/insert 等方法 下面是继承Module类后可以调用的方法，详解:

    可调用方法                   参数
    insert()                    无
    insert_without_return()     无
    update()                    无
    select()                    islike/oderby/isasc/limit/iscount/getone
    delete()                    islike
    create()                    无(子类调用时，创建相应的表，一般是不需要调用此方法的，可以与drop()配合使用)
    drop()                      无(子类调用时，删除相应的表)
    isexists()                  无(子类调用时，判断相应的表是否存在，与前两个方法配合使用)
    listener_begin()            do
    listener_end()              do