Django model中的 class Meta 詳解

Model 的 Meta 選項

本文介紹你能在model中使用的 class Meta 內嵌類的所有 元數據選項 (meta options)

可用的 Meta 選項

abstract

Options. abstract

如果 abstract = True ，這個 model 就是一個 抽象基類 。

app_label

Options. app_label

如果一個 model 定義在默認的 models.py 之外 (例如，如果你的 app 的 models 在 myapp.models 子模塊下)，你必須定義 app_label 讓 Django 知道它屬於哪一個 app

app_label = 'myapp' 

db_table

Options. db_table

定義該 model 在數據中的表名稱:

db_table = 'music_album' 

數據庫中的表名稱

為了節省時間，Django 會自動的使用你的 model class 的名稱和包含這個 model 的 app 名稱來構建 數據庫的表名稱。一個 model 的數據庫表名稱是通過將 “app label” – 你在 manage.py startapp 中使用的名稱 – 和 model 的類名稱，加上一個下划線在他們之間來構成。

例如，如果你有一個 app 叫做 bookstore (使用 manage.py startapp bookstore 創建)，以 及一個 model 定義為 class Book 這樣將會創建一個名為 bookstore_book 的數據庫表。

如果想自定義數據庫的表名稱，需要在 class Meta 使用 db_table 參數來自定義。

如果你的數據庫表名稱是一個SQL保留字，或者它包含不允許出現在 Python 變量中的字符 (比如連字 符)這是沒問題的。這是因為 Django 會自動給列名和表名添加引號。

在 MySQL 中使用小寫字母作為數據庫表名稱

強烈建議你在通過 db_table 重載數據庫表名稱時，使用小寫字母，特別是當你在使用 MySQL 作為后台數據庫時。查看 MySQL notes 了解更多細節。

db_tablespace

Options. db_tablespace

定義這個 model 所使用的 數據庫 表空間 。如果在項目的 setting 中定義了 DEFAULT_TABLESPACE 那么它會使用這個值。如果后台數據庫不支持 表空間，這個選項會被忽略。

get_latest_by

Options. get_latest_by

在 model 中指定一個 DateField 或者 DateTimeField 。這個設置讓你在使用 model 的 Manager 上的 latest 方法時，默認使用指定字段來排序。

例如:

get_latest_by = "order_date" 

詳見 latest() 。

managed

Options. managed

默認值為 True ，這意味着 Django 可以使用 syncdb 和 reset 命令 來創建或移除對應的數據庫。換句話說， Django 管理 了數據庫的生命周期。

如果設置為 False ，Django 將不會為當前 model 創建或者刪除數據庫表。 通常在表示某個 通過其他方法創建的現有數據表時這會非常有用。這是當 managed=False 時 僅有 的不同之 處。model 在處理所有其他方面的事情時是完全一致的。這包括

1. 如果沒有聲明主鍵字段，Django 將自動的為 model 增加一個自增的主鍵字段。當你使用不被* 管理* 的 models 時，為了避免讓將來閱讀代碼的人迷惑，建議指明所有所有托管在 model 中的字 段與數據庫表的關系。

2. 如果兩個非托管的 models (managed=False) 之間，使用了 ManyToManyField 關聯，就不會創建多對多關系的中間表。然而 如果是一個托管的 model 與另一個非托管的 model 的話，多對多關系 將會 被創建。

   如果你需要改變默認的行為，就的顯示的定義中間 model 來在數據庫中創建中間表(要將 managed 設置為 True)，然后在你的原 model 上使用 ManyToManyField.through 屬性指向中間 model，就能實現自定義的多對多關系。

如果你的測試中包含非托管 model (managed=False)，那么在測試之前，你應該要確保在測試 創建時已經創建了正確的數據表。

如果你想更改 model 類中某個 Python 層級的行為，你 可以 令 managed=False ，然后創 建該 model 的拷貝，在拷貝中定義新的行為。不過在面對這種情況時還有個更好的辦法就是使 用 Proxy models 。

order_with_respect_to

Options. order_with_respect_to

根據給定的字段對 model 排序。在關聯關系中,它經常用在根據目標對象對源對象排序的場合。舉 個例子，一個 Answer 只關聯一個 Question 對象，而一個 question 對象卻可以關聯多 個 answer 對象。根據 question 對 answer 排序，你應該這么做:

class Answer(models.Model): question = models.ForeignKey(Question) # ... class Meta: order_with_respect_to = 'question' 

當 order_with_respect_to 被設置時，會提供兩個附加的方法用於獲取和設置關聯對象的排序：get_RELATED_order() 和 set_RELATED_order() ，這其中的 RELATED 是 model 的小 寫名字。例如，假定一個 Question 對象關聯到多個 Answer 對象，這將返回一個包含 Answer 對象主鍵的列表:

>>> question = Question.objects.get(id=1) >>> question.get_answer_order() [1, 2, 3] 

可以通過傳入一個 Answer 主鍵的列表的方式來設置 Question 對象關聯的 Answer 對象的順序:

>>> question.set_answer_order([3, 1, 2]) 

關聯的對象同樣有兩個方法, get_next_in_order() 和 get_previous_in_order() ， 可 以用來訪問那些特定的對象。假定 Answer 對象是以 id 排序的:

>>> answer = Answer.objects.get(id=2) >>> answer.get_next_in_order() <Answer: 3> >>> answer.get_previous_in_order() <Answer: 1> 

改變 order_with_respect_to 時注意

order_with_respect_to 增加了一個名為 _order 的字段(數據庫字段)，因此在你進 行 syncdb 操作后，如果你增加或者改變了 order_with_respect_to 請確保 處理得當。

ordering

Options. ordering

定義了當獲取對象的列表時，對象的默認排序:

ordering = ['-order_date'] 

這是一個字符串的元組或列表。沒一個字符串都是由一個字段名和一個可選的表明降序的 “-” 前綴構成。 當字段名前面沒有 “-” 時，將默認使用升序排列。使用 ”?” 將會隨機排列。

例如，以 pub_date 字段升序排序，可用:

ordering = ['pub_date'] 

以 pub_date 降序排列時，可用:

ordering = ['-pub_date'] 

以 pub_date 降序排列，然后再以 author 升序排列，可用:

ordering = ['-pub_date', 'author'] 

Django admin 將采用列表/元組中所有的元素; 在 1.4 版之前, 只有第一個元素被采用。

permissions

Options. permissions

在創建對象時，添加到權限表當中的附加權限信息。Django 自動為每個設置了 admin 的對象創建了添 加，刪除和修改的權限。下面這個例子展示了如何添加一個附加的權限 can_deliver_pizzas:

permissions = (("can_deliver_pizzas", "Can deliver pizzas"),) 

該項可以是一個列表或一個由兩個元組構成的元組，以這樣的格式 (permission_code, human_readable_permission_name) 。

proxy

Options. proxy

如果 proxy = True ，表示該 model 是其父類的代理 model proxy model 。

unique_together

Options. unique_together

用來設置的不重復的字段組合，必須唯一(將兩個字段做聯合唯一):

unique_together = (("driver", "restaurant"),) 

它是一個字段名稱的列表，列表內的字段組合在數據庫中是唯一，不重復的，也就是說不可以有兩 個對象，它們在列表中的字段值是完全相同的。它被用在 Django admin 后台，在數據庫層級約束 數據。(比如，在 CREATE TABLE 語句中包含 UNIQUE 關鍵字)

為了使用方便，你可以賦給該項一個單獨的字段列表的元組:

unique_together = ("driver", "restaurant") 

一個 ManyToManyField 不能包含在 unique_together 中。 (這 將會導致它看起來不明不白！) 如果你需要驗證關聯到ManyToManyField 字段的唯一性驗證，嘗試使用 signal(信號) 或者 明確指定 model 的 through 屬性。

verbose_name

Options. verbose_name

指明一個易於理解和表述的對象名稱，單數形式:

verbose_name = "pizza" 

如果這個值沒有設置， Django 將會使用該 model 的類名的分詞形式作為他的對象表述名: CamelCase 將會轉換為 camel case 。

verbose_name_plural

Options. verbose_name_plural

對象的復數表述名:

verbose_name_plural = "stories" 

如果沒有指定，Django 會使用 verbose_name + "s" 的形式作為對象的表述名。