Django的數(shù)據(jù)庫(kù)層從Python代碼生成SQL schemas—但是對(duì)于遺留數(shù)據(jù)庫(kù)，你已經(jīng)擁有SQL schemas. 這種情況,你需要為已經(jīng)存在的數(shù)據(jù)表創(chuàng)建model. 為此,Django自帶了一個(gè)可以通過讀取您的數(shù)據(jù)表結(jié)構(gòu)來生成model的工具. 該輔助工具稱為inspectdb,你可以通過執(zhí)行manage.py inspectdb來調(diào)用它.
使用 inspectdb

inspectdb工具自省你配置文件指向的數(shù)據(jù)庫(kù)，針對(duì)每一個(gè)表生成一個(gè)Django模型，然后將這些Python模型的代碼顯示在系統(tǒng)的標(biāo)準(zhǔn)輸出里面。

下面是一個(gè)從頭開始的針對(duì)一個(gè)典型的遺留數(shù)據(jù)庫(kù)的整合過程。 兩個(gè)前提條件是安裝了Django和一個(gè)傳統(tǒng)數(shù)據(jù)庫(kù)。

    通過運(yùn)行django-admin.py startproject mysite (這里 mysite 是你的項(xiàng)目的名字)建立一個(gè)Django項(xiàng)目。 好的，那我們?cè)谶@個(gè)例子中就用這個(gè) mysite 作為項(xiàng)目的名字。

    編輯項(xiàng)目中的配置文件, mysite/settings.py ,告訴Django你的數(shù)據(jù)庫(kù)連接參數(shù)和數(shù)據(jù)庫(kù)名。 具體的說，要提供 DATABASE_NAME , DATABASE_ENGINE , DATABASE_USER , DATABASE_PASSWORD , DATABASE_HOST , 和 DATABASE_PORT 這些配置信息.。 (請(qǐng)注意其中的一些設(shè)置是可選的。 更多信息參見第5章)

    通過運(yùn)行 python mysite/manage.py startapp myapp (這里 myapp 是你的應(yīng)用的名字)創(chuàng)建一個(gè)Django應(yīng)用。 這里我們使用myapp 做為應(yīng)用名。

    運(yùn)行命令 python mysite/manage.py inspectdb。這將檢查DATABASE_NAME 數(shù)據(jù)庫(kù)中所有的表并打印出為每張表生成的模型類。 看一看輸出結(jié)果以了解inspectdb能做些什么。

    將標(biāo)準(zhǔn)shell的輸出重定向，保存輸出到你的應(yīng)用的 models.py 文件里：

python mysite/manage.py inspectdb > mysite/myapp/models.py

    編輯 mysite/myapp/models.py 文件以清理生成的 models 并且做一些必要的自定義。

清理生成的Models

如你可能會(huì)預(yù)料到的，數(shù)據(jù)庫(kù)自省不是完美的，你需要對(duì)產(chǎn)生的模型代碼做些許清理。 這里提醒一點(diǎn)關(guān)于處理生成 models 的要點(diǎn):

    數(shù)據(jù)庫(kù)的每一個(gè)表都會(huì)被轉(zhuǎn)化為一個(gè)model類 (也就是說，數(shù)據(jù)庫(kù)的表和model 類之間是一對(duì)一的映射)。 這意味著你需要為多對(duì)多連接的表，重構(gòu)其models 為 ManyToManyField 的對(duì)象。

    所生成的每一個(gè)model中的每個(gè)字段都擁有自己的屬性，包括id主鍵字段。 但是，請(qǐng)注意，如果某個(gè)model沒有主鍵的話，那么Django會(huì)自動(dòng)為其增加一個(gè)id主鍵字段。 這樣一來，你也許希望移除這樣的代碼行。

id = models.IntegerField(primary_key=True)

    這樣做并不是僅僅因?yàn)檫@些行是冗余的，而且如果當(dāng)你的應(yīng)用需要向這些表中增加新記錄時(shí)，這些行會(huì)導(dǎo)致某些問題。

    每一個(gè)字段類型，如CharField、DateField， 是通過查找數(shù)據(jù)庫(kù)列類型如VARCHAR,DATE來確定的。如果inspectdb無法把某個(gè)數(shù)據(jù)庫(kù)字段映射到model字段上，它會(huì)使用TextField字段進(jìn)行代替，并且會(huì)在所生成model字段后面加入Python注釋“該字段類型是猜的”。 對(duì)這要當(dāng)心，如果必要的話，更改字段類型。

    如果你的數(shù)據(jù)庫(kù)中的某個(gè)字段在Django中找不到合適的對(duì)應(yīng)物，你可以放心的略過它。 Django模型層不要求必須導(dǎo)入你數(shù)據(jù)庫(kù)表中的每個(gè)列。

    如果數(shù)據(jù)庫(kù)中某個(gè)列的名字是Python的保留字（比如pass、class或者for等），inspectdb會(huì)在每個(gè)屬性名后附加上_field，并將db_column屬性設(shè)置為真實(shí)的字段名（也就是pass,class或者for等）。

    例如，某張表中包含一個(gè)INT類型的列，其列名為for，那么所生成的model將會(huì)包含如下所示的一個(gè)字段：

for_field = models.IntegerField(db_column='for')

    inspectdb 會(huì)在該字段后加注 ‘字段重命名，因?yàn)樗且粋€(gè)Python保留字' 。

    如果數(shù)據(jù)庫(kù)中某張表引用了其他表（正如大多數(shù)數(shù)據(jù)庫(kù)系統(tǒng)所做的那樣），你需要適當(dāng)?shù)男薷乃蒻odel的順序，以使得這種引用能夠正確映射。 例如，model Book擁有一個(gè)針對(duì)于model Author的外鍵，那么后者應(yīng)該先于前者被定義。如果你想創(chuàng)建一個(gè)指向尚未定義的model的關(guān)系，那么可以使用包含model名的字符串，而不是model對(duì)象本身。

    對(duì)于PostgreSQL,MySQL和SQLite數(shù)據(jù)庫(kù)系統(tǒng)，inspectdb能夠自動(dòng)檢測(cè)出主鍵關(guān)系。 也就是說，它會(huì)在合適的位置插入primary_key=True。 而對(duì)于其他數(shù)據(jù)庫(kù)系統(tǒng)，你必須為每一個(gè)model中至少一個(gè)字段插入這樣的語句，因?yàn)镈jango的model要求必須擁有一個(gè)primary_key=True的字段。

    外鍵檢測(cè)僅對(duì)PostgreSQL，還有MySQL表中的某些特定類型生效。 至于其他數(shù)據(jù)庫(kù)，外鍵字段將在假定其為INT列的情況下被自動(dòng)生成為IntegerField。

最新評(píng)論