Flask中sqlalchemy模組的例項用法

阿新 • • 發佈：2020-08-04

一、安裝

$pipinstallflask-sqlalchemy

二、配置

配置選項列表 :

SQLALCHEMY_NATIVE_UNICODE | 可以用於顯式禁用原生 unicode 支援。當使用不合適的指定無編碼的資料庫預設值時，這對於一些資料庫介面卡是必須的（比如 Ubuntu 上某些版本的 PostgreSQL ）。|

| SQLALCHEMY_POOL_SIZE | 資料庫連線池的大小。預設是引擎預設值（通常是 5 ） |

| SQLALCHEMY_POOL_TIMEOUT | 設定連線池的連線超時時間。預設是 10 。 |

| SQLALCHEMY_POOL_RECYCLE | 多少秒後自動回收連線。這對 MySQL 是必要的，它預設移除閒置多於 8 小時的連線。注意如果使用了 MySQL ， Flask-SQLALchemy 自動設定這個值為 2 小時。|

app.config["SQLALCHEMY_DATABASE_URI"]=DATABASE_URI
app.config["SQLALCHEMY_COMMIT_ON_TEARDOWN"]=True/False#每次請求結束後都會自動提交資料庫中的變動.

app.config[""]=
app.config[""]=
app.config[""]=
app.config[""]=

DATABASE_URI:
mysql:mysql://username:password@hostname/database

pgsql:postgresql://username:password@hostname/database

sqlite(linux):sqlite:////absolute/path/to/database

sqlite(windows):sqlite:///c:/absolute/path/to/database

三、初始化示例

fromflaskimportFlask
fromflask_sqlalchemyimportSQLAlchemy
base_dir=os.path.abspath(os.path.dirname(__file__))

app=Flask(__name__)

app.config["SQLALCHEMY_DATABASE_URI"]='sqlite:///'+os.path.join(base_dir,'data.sqlite')
app.config["SQLALCHEMY_COMMIT_ON_TEARDOWN"]=True

db=SQLAlchemy(app)

四、定義模型

模型表示程式使用的持久化實體. 在 ORM 中,模型一般是一個 Python 類,類中的屬性對應資料庫中的表.

Flaks-SQLAlchemy 建立的資料庫例項為模型提供了一個基類以及一些列輔助類和輔助函式,可用於定義模型的結構.

db.Model#建立模型,db.Column#建立模型屬性.

模型屬性型別 :

常用 SQLAlchemy 列選項

示例 :

classRole(db.Model):
__tablename__="roles"
id=db.Column(db.Integer,primary_key=True)
name=db.Column(db.String(64),unique=True)

def__repr__(self):
"""非必須,用於在除錯或測試時,返回一個具有可讀性的字串表示模型."""
return'<Role%r>'%self.name

classUser(db.Model):
__tablename__='users'
id=db.Column(db.Integer,primary_key=True)
username=db.Column(db.String(64),unique=True,index=True)

def__repr__(self):
"""非必須,返回一個具有可讀性的字串表示模型."""
return'<Role%r>'%self.username

五、關係

關係型資料庫使用關係把不同表中的行聯絡起來。

常用 SQLAlchemy 關係選項：

（1）一對多

原理 : 在 “多” 這一側加入一個外來鍵,指定 “一” 這一側聯結的記錄.

示例程式碼 : 一個角色可屬於多個使用者,而每個使用者只能有一個角色.

classRole(db.Model):
#...
users=db.relationship('User',backref='role')

classUser(db.Model):
#...
role_id=db.Column(db.Integer,db.ForeignKey('roles.id'))#外來鍵關係.


###############
db.ForeignKey('roles.id'):外來鍵關係,Role.users=db.relationship('User',backref='role'):代表外來鍵關係的面向物件視角.對於一個Role類的例項,其users屬性將返回與角色相關聯的使用者組成的列表.
db.relationship()第一個引數表示這個關係的另一端是哪個模型.
backref引數,向User模型添加了一個role資料屬性,從而定義反向關係.這一屬性可替代role_id訪問Role模型,此時獲取的是模型物件,而不是外來鍵的值.

（2）多對多

最複雜的關係型別，需要用到第三章表，即關聯表，這樣多對多關係可以分解成原表和關聯表之間的兩個一對多關係。

查詢多對多關係分兩步 : 遍歷兩個關係來獲取查詢結果。

程式碼示例：

registrations=db.Table("registrations",db.Column("student_id",db.Integer,db.ForeignKey("students.id")),db.Column("class_id",db.ForeignKey("classes.id"))
)

classStudent(db.Model):
__tablename__="students"
id=db.Column(db.Integer,primary_key=True)
name=db.Column(db.String)
classes=db.relationship("Class",secondary=registrations,backref=db.backref("students",lazy="dynamic"),lazy="dynamic")

classClass(db.Model):
__tablename__="classes"
id=db.Column(db.Integer,primary_key=True)
name=db.Column(db.String)

多對多關係仍然使用定義一對多關係的 db.relationship() 方法進行定義,但在多對多關係中,必須把 secondary 引數設為關聯表。

多對多關係可以在任何一個類中定義,backref 引數會處理好關係的另一側。

關聯表就是一個簡單的表,不是模型,SQLAlchemy 會自動接管這個表。

classes 關係使用列表語義,這樣處理多對多關係比較簡單。

Class 模型的 students 關係有引數 db.backref() 定義. 這個關係還指定了 lazy 引數,所以,關係兩側返回的查詢都可接受額外的過濾器。

自引用關係

自引用關係可以理解為多對多關係的特殊形式 : 多對多關係的兩邊由兩個實體變為一個實體。

高階多對多關係

使用多對多關係時，往往需要儲存所聯兩個實體之間的額外資訊。這種資訊只能儲存在關聯表中，對使用者之間的關注來說，可以儲存使用者關注另一個使用者的日期，這樣就能按照時間順序列出所有關注者。

為了能在關係中處理自定義的資料，必須提升關聯表的地位，使其變成程式可訪問的模型。

關注關聯表模型實現：

classFollow(db.Model):
__tablename__="follows"
follower_id=db.Column(db.Integer,db.ForeignKey("users.id"),primary_key=True)
followed_id=db.Column(db.Integer,primary_key=True)
timestamp=db.Column(db.DateTime,default=datetime.utcnow)

#SQLAlchemy不能直接使用這個關聯表,因為如果這個做程式就無法訪問其中的自定義欄位.相反的,要把這個多對多關係的左右
兩側拆分成兩個基本的一對多關係,而且要定義成標準的關係。

使用兩個一對多關係實現的多對多關係：

classUser(UserMixin,db.Model):
#...
followd=db.relationship("Follow",foreign_keys=[Follow.follower_id],backref=db.backref("follower",lazy="joined"),lazy="dynamic",cascade="all,delete-orphan")
followrs=db.relationship("Follow",foreign_keys=[Follow.followed_id],backref=db.backref("followed",delete-orphan")
#這段程式碼中,followed和follower關係都定義為單獨的一對多關係.
#注意:為了消除外來鍵歧義,定義關係是必須使用可選引數foreign_keys指定的外來鍵.而且db.backref()引數並不是指定這兩個
關係之間的引用關係,而是回引Follow模型.回引中的lazy="joined",該模式可以實現立即從連線查詢中載入相關物件.
#這兩個關係中,user一側設定的lazy引數作用不一樣.lazy引數都在"一"這一側設定,返回的結果是"多"這一側中的記錄.
dynamic引數,返回的是查詢物件.
#cascade引數配置在父物件上執行的操作相關物件的影響.比如,層疊物件可設定為:將使用者新增到資料庫會話後,要自定把所有
關係的物件都新增到會話中.刪除物件時,預設的層疊行為是把物件聯結的所有相關物件的外來鍵設為空值.但在關聯表中,刪除記錄
後正確的行為是把執行該記錄的實體也刪除,因為這樣才能有效銷燬聯結.這就是層疊選項值delete-orphan的作用.設為all,delete-orphan的意思是啟動所有預設層疊選項,並且還要刪除孤兒記錄。

（3）一對一

可以看做特殊的一對多關係. 但呼叫 db.relationship() 時要把 uselist 設定 False,把多變為一。

（4）多對一

將一對多關係，反過來即可，也是一對多關係。

六、資料庫操作

（1）建立資料庫及資料表

建立資料庫

db.create_all()

示例 :

$pythonmyflask.pyshell
>frommyflaskimportdb
>db.create_all()

如果使用 sqlite,會在 SQLALCHEMY_DATABASE_URI 指定的目錄下多一個檔案，檔名為該配置中的檔名。

如果資料庫表已經存在於資料庫中,那麼 db.create_all() 不會建立或更新這個表。

更新資料庫

方法一 :

先刪除,在建立 –> 原有資料庫中的資料,都會消失.

>db.drop_all()
>db.create_all()

方法二 :

資料庫遷移框架 : 可以跟自動資料庫模式的變化，然後增量式的把變化應用到資料庫中。

SQLAlchemy 的主力開發人員編寫了一個遷移框架 Alembic,除了直接使用 Alembic wait,Flask 程式還可使用 Flask-Migrate 擴充套件,該擴充套件對 Alembic 做了輕量級包裝,並整合到 Flask-Script 中,所有操作都通過 Flaks-Script 命令完成。

① 安裝 Flask-Migrate

$pipinstallflask-migrate

② 配置

fromflask_migrateimportMigrate,MigrateCommand

#...
migrate=Migrate(app,db)
manager.add_command('db',MigrateCommand)

③ 資料庫遷移

a. 使用 init 自命令建立遷移倉庫.

$ python myflask.py db init # 該命令會建立 migrations 資料夾,所有遷移指令碼都存在其中.

b.建立資料路遷移指令碼.
$pythonmyflask.pydbrevision#手動建立Alemic遷移
建立的遷移只是一個骨架,upgrade()和downgrade()函式都是空的.開發者需要使用Alembic提供的Operations物件
指令實現具體操作.

$pythonmyflask.pydbmigrate-mCOMMONT#自動建立遷移.
自動建立的遷移會根據模型定義和資料庫當前的狀態之間的差異生成upgrade()和downgrade()函式的內容.

**自動建立的遷移不一定總是正確的,有可能漏掉一些細節,自動生成遷移指令碼後一定要進行檢查.


c.更新資料庫
$pythonmyflask.pydbupgrade#將遷移應用到資料庫中.

（2）插入行

模型的建構函式，接收的引數是使用關鍵字引數指定的模型屬性初始值。注意，role 屬性也可使用，雖然他不是真正的資料庫列，但卻是一對多關係的高階表示。這些新建物件的 id 屬性並沒有明確設定，因為主鍵是由 Flask-SQLAlchemy 管理的。現在這些物件只存在於 Python 直譯器中，尚未寫入資料庫。

>>frommyflaskimportdb,User,Role
>>db.create_all()
>>admin_role=Role(name="Admin")
>>mod_role=Role(name="Moderator")
>>user_role=Role(name="User")
>>user_john=User(username="john",role=admin_role)
>>user_susan=User(username="susan",role=mod_role)
>>user_david=User(username="david",role=user_role)
>>admin_role.name
'Admin'
>>admin_role.id
None
---------
>>db.session.add_all([admin_role,mod_role,user_role,user_john,user_susan,user_david])#把物件新增到會話中.
>>db.session.commit()#把物件寫入資料庫,使用commit()提交會話.

（3）修改行

>>admin_role="Administrator"
>>db.session.add(admin_role)
>>db.session.commit()

（4）刪除行

>>db.session.delete(mod_role)
>>db.session.commit()

（5）查詢行

Flask-SQLAlchemy 為每個模型類都提供了 query 物件.

獲取表中的所有記錄

>>Role.query.all()
[<Roleu'Admin'>,<Roleu'Moderator'>,<Roleu'User'>]
>>User.query.all()
[<Roleu'john'>,<Roleu'susan'>,<Roleu'david'>]

查詢過濾器

filter_by() 等過濾器在 query 物件上呼叫,返回一個更精確的 query 物件. 多個過濾器可以一起呼叫,直到獲取到所需的結果.

>>User.query.filter_by(role=user_role).all()#以列表形式,返回所有結果,>>User.query.filter_by(role=user_role).first()#返回結果中的第一個.

filter() 對查詢結果過濾，比”filter_by()”方法更強大，引數是布林表示式

#WHEREage<20
users=User.query.filter(User.age<20)
#WHEREnameLIKE'J%'ANDage<20
users=User.query.filter(User.name.startswith('J'),User.age<20)

查詢過濾器 :

查詢執行函式 :

first_or_404() | 返回查詢的第一個結果，如果沒有結果，則終止請求，返回 404 錯誤響應 | |

| get() | 返回指定主鍵對應的行，如果沒有對應的行，則返回 None |

get_or_404() | 返回指定主鍵對應的行，如果沒找到指定的主鍵，則終止請求，返回 404 | |錯誤響應

| count() | 返回查詢結果的數量 |

| paginate() | 返回一個 Paginate 物件，它包含指定範圍內的結果 |

（6）會話管理，事務管理

單個提交

>>db.session.add(ONE)
>>db.session.commit()

多個提交

>>db.session.add_all([LIST_OF_MEMBER])
>>db.session.commit()

刪除會話

>>db.session.delete(mod_role)
>>db.session.commit()

事務回滾 : 新增到資料庫會話中的所有物件都會還原到他們在資料庫時的狀態.

>>db.session.rollback()

七、檢視函式中操作資料庫

@app.route('/',methods=['GET','POST'])
defindex():
form=NameForm()
ifform.validate_on_submit():
user=User.query.filter_by(username=form.name.data).first()
ifuserisNone:
user=User(username=form.name.data)
db.session.add(user)
session["known"]=False
else:
session["known"]=True
session["name"]=form.name.data
form.name.data=""#whyemptyit?
returnredirect(url_for("index"))
returnrender_template("index.html",current_time=datetime.utcnow(),form=form,name=session.get("name"),known=session.get("known"))

八、分頁物件 Pagination

1. paginate() 方法

paginate() 方法的返回值是一個 Pagination 類物件，該類在 Flask-SQLAlchemy 中定義，用於在模板中生成分頁連結。

paginate(頁數[,per_page=20,error_out=True])
頁數:唯一必須指定的引數,per_page:指定每頁現實的記錄數量,預設20.
error_out:True如果請求的頁數超出了返回,返回404錯誤;False頁數超出範圍時返回一個,空列表.

示例程式碼：

@main.route("/",methods=["GET","POST"])
defindex():
#...
page=request.args.get('page',1,type=int)#渲染的頁數,預設第一頁,type=int保證引數無法轉換成整數時,返回預設值.
pagination=Post.query.order_by(Post.timestamp.desc()).paginate(page,per_page=current_app.config
["FLASKY_POSTS_PER_PAGE"],error_out=False)
posts=pagination.items
returnrender_template('index.html',posts=posts,pagination=pagination)

2. 分頁物件的屬性及方法：

Flask_SQLAlchemy 分頁物件的屬性：

在分頁物件可呼叫的方法：

3. 在模板中與 BootStrap 結合使用示例

使用 Flaks-SQLAlchemy 的分頁物件與 Bootstrap 中的分頁 CSS,可以輕鬆的構造出一個分頁導航.

分頁模板巨集 _macros.html : 建立一個 Bootstrap 分頁元素,即一個有特殊樣式的無序列表.

{%macropagination_widget(pagination,endpoint)%}
<ulclass="pagination">
<li{%ifnotpagination.has_prev%}class="disabled"{%endif%}>
<ahref="{%ifpagination.has_prev%}{{url_for(endpoint,page=paginatin.page-1,**kwargs)}}{%else%}
#{%endif%}">
&laquo;
</a>
</li>
{%forpinpagination,.iter_pages()%}
{%ifp%}
{%ifp==pagination.page%}
<liclass="active">
<ahref="{{url_for(endpoint,page=p,**kwargs)}}" rel="external nofollow" >{{p}}</a>
</li>
{%else%}
<li>
<ahref="{{url_for(endpoint,**kwargs)}}" rel="external nofollow" >{{p}}</a>
</li>
{%endif%}
{%else%}
<liclass="disabled"><ahref="#" rel="external nofollow" >&hellip;</a></li>
{%endif%}
{%endfor%}
<li{%ifnotpagination.has_next%}class="disabled"{%endif%}>
<ahref="{%ifpaginatin.has_next%}{{url_for(endpoint,page=pagination.page+1,**kwargs)}}{%else%}
#{%endif%}">
&raquo;
</a>
</li>
</ul>
{%endmacro%}

匯入使用分頁導航

{%extends"base.html"%}
{%import"_macros.html"asmacros%}
...
<divclass="pagination">
{{macro.pagination_widget(pagination,".index")}}
</div>

九、監聽事件

1. set 事件

示例程式碼 :

frommarkdownimportmarkdown
importbleach
classPost(db.Model):
#...
body=db.Colume(db.Text)
body_html=db.Column(db.Text)
#...
@staticmethod
defon_changeed_body(target,value,oldvalue,initiator):
allowed_tags=["a","abbr","acronym","b","blockquote","code","em","i","li","ol","pre","strong","ul","h1","h2","h3","h4","p"]
target.body_html=bleach.linkify(bleach.clean(markdown(value,output_format="html"),tags=allowed_tags,strip=True))
db.event.listen(Post.body,"set",Post.on_changeed_body)
#on_changed_body函式註冊在body欄位上,是SQLIAlchemy"set"事件的監聽程式,#這意味著只要這個類例項的body欄位設了新值,函式就會自動被呼叫.
#on_changed_body函式把body欄位中的文字渲染成HTML格式,#結果儲存在body_html中,自動高效的完成Markdown文字到HTML的轉換

十、記錄慢查詢

十一、Binds 操作多個數據庫

十二、其他

1. ORM 在查詢時做初始化操作

當 SQLIAlchemy ORM 從資料庫查詢資料時,預設不呼叫__init__ 方法,其底層實現了 Python 類的 __new__() 方法,直接實現物件例項化,而不是通過 __init__ 來例項化物件.

如果需要在查詢時,依舊希望實現一些初始化操作,可以使用 orm.reconstructor() 裝飾器或實現 InstanceEvents.load() 監聽事件。

#orm.reconstructor
fromsqlalchemyimportorm
classMyMappedClass(object):
def__init__(self,data):
self.data=data
#weneedstuffonallinstances,butnotinthedatabase.
self.stuff=[]
@orm.reconstructor
definit_on_load(self):
self.stuff=[]
#InstanceEvents.load()
fromsqlalchemyimportevent
##standarddecoratorstyle
@event.listens_for(SomeClass,'load')
defreceive_load(target,context):
"listenforthe'load'event"
#...(eventhandlinglogic)...

如果只是希望在從資料庫查詢生成的物件中包含某些屬性,也可以使用 property 實現：

classAwsRegions(db.Model):
name=db.Column(db.String(64))
...
@property
defzabbix_api(self):
returnZabbixObj(zabbix_url)
@zabbix_api.setter
defzabbix_api(self):
raiseValueError("zabbixcannotbesetted!")

到此這篇關於Flask中sqlalchemy模組的例項用法的文章就介紹到這了,更多相關Flask中sqlalchemy模組的使用內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！

Flask中sqlalchemy模組的例項用法

Flask中sqlalchemy模組的例項用法

python中pdb模組例項用法

Python中six模組基礎用法

PHP中mysqli_get_server_version()的例項用法

Django中modelform元件例項用法總結

Python3中FuzzyWuzzy庫例項用法

python中reload過載例項用法

php中yii框架例項用法

php中yar框架例項用法講解

python中uuid模組例項淺析

python中doctest庫例項用法

python中Mako庫例項用法

php中PHPUnit框架例項用法

java中gc演算法例項用法

php中trim函式例項用法

flask中的debug的用法

php中rsort函式例項用法

PHP中strval()函式例項用法

php中intval()的例項用法

js中Object.create例項用法詳解

Flask中sqlalchemy模組的例項用法

相關推薦