sqlitemodel 0.1.3

例子

构建一个继承 Model 类的用户类来展示它是如何工作的。

class User(Model):
    def __init__(self, id=None):
        Model.__init__(self, id, dbfile=None, foreign_keys=False, parse_decltypes=False)

        self.firstname = ''
        self.lastname = ''
        self.age = ''

        # Tries to fetch the object by its rowid from the database
        self.getModel()


    # Tells the database class the name of the database table
    def tablename(self):
        return 'users'


    # Tells the database class more about the table columns in the database
    def columns(self):
        return [
            {
              'name': 'firstname',
              'type': 'TEXT'
            },
            {
              'name': 'lastname',
              'type': 'TEXT'
            },
            {
              'name': 'age',
              'type': 'INTEGER'
            }
        ]

需要两个方法tablename()和columns()来将表列与模型对象映射。

构造函数中的id参数和getModel()方法是可选的。

也可以使用selectCopy()方法查询数据库表中的任何数据，并用结果填充模型对象。

selectCopy(SQL() | raw_sql_query_string)

前任：

class User(Model):
    def __init__(self, id=None, email=None):
        Model.__init__(self, id)
        if(email):
            self.selectCopy(SQL().WHERE('email', '=', email))

``Model`` 类构造函数有一个可选的 ``dbfile`` 参数。如果已设置，则忽略静态变量“Database.DB_FILE”。

使用 User 类

创建新用户

# create a new user
user = User()

# creating the table inside the database
user.createTable()

# add infos about the user
user.firstname = 'Rene'
user.lastname = 'Tanczos'
user.age = 25

# save the user into the database
user.save()

从数据库中检索用户

# get it by id
user = User(1)

# get the user by his firstname and lastname
# User().selectOne(SQL())
user = User().selectOne(SQL().WHERE('firstname', '=', 'Rene').AND().WHERE( 'lastname', '=', 'Tanczos'))

# Or get more the one user
# this method will return an array of matching users
users = User().select(SQL().WHERE('age', '=', 25))

设置数据库路径

建议在启动应用程序后通过Database类中的静态变量设置数据库的路径。

Database.DB_FILE = 'path/to/database.db'

db = Database()

但也可以在对象初始化时在Database构造函数中设置路径。

db = Database('path/to/database.db')

与声明

Database类支持with语句，推荐使用。

with Database() as db:
    users = db.select(SQL().SELECT().FROM('users'))

处理完with块后，数据库连接会自动关闭。

方法

所有这些方法都使用Model对象作为第一个参数，以便 Database对象知道如何使用它。

close()
# close connection

createTable(model)
# create the database table if not exists by the the model object

save(model)
# create or update a model object and return it id

delete(model)
# delete a model object and return True/False

select(model, SQL() | sql query , values=())
# return a array of the given model

selectOne(model, SQL() | sql query, values=())
# return the first matching entry of the given model

selectById(model, id)
# return the a model object by his id

如果有一些数据没有Model，则可以将其作为列表或Dict对象列表的原始数据进行检索。

getRaw(SQL() | sql query, values=(), max=-1)
# return an array of results.
# index 0 is the header of the table

getDict(SQL() | sql query, values=(), max=-1)
# return a list array with a Dict object.
# the key of the Dict object is the column name

要计算查询的结果，可以使用方法zeroZero() 。

zeroZero(SQL() | sql query)
# It return the the first column of the first line ( result[0][0] )
# That why the method is called zeroZero()

要检查表或列是否存在，可以使用函数table_exists() 和column_exists()。如果找到表/列，两者都将返回一个布尔值。

table_exists('tablename')
# True or False

column_exists('tablename', 'column_name')
# True or False