經常使用字段和參數

經常使用字段

AutoField

int 自增列，必須填入參數 primary_key=True 。當 model 中若是沒有自增列，則自動會建立一個列名爲 id 的列。

IntegerField

一個整數類型，範圍在 -2147483648 ~ 2147483647 。

CharField

字符類型，必須提供 max_length 參數， max_length 表示字符長度。

DateField

日期字段，日期格式 YYYY-MM-DD，至關於 Python 中的 datetime.date() 實例。

DateTimeField

日期時間字段，格式 YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ] ，至關於 Python 中的 datetime.datetime() 實例。

字段合集

AutoField(Field)
    - int自增列，必須填入參數 primary_key=True

BigAutoField(AutoField)
    - bigint自增列，必須填入參數 primary_key=True

    注：當model中若是沒有自增列，則自動會建立一個列名爲id的列
        from django.db import models

        class UserInfo(models.Model):
            # 自動建立一個列名爲id的且爲自增的整數列
            username = models.CharField(max_length=32)

        class Group(models.Model):
            # 自定義自增列
            nid = models.AutoField(primary_key=True)
            name = models.CharField(max_length=32)

SmallIntegerField(IntegerField):
    - 小整數 -32768 ～ 32767

PositiveSmallIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
    - 正小整數 0 ～ 32767
IntegerField(Field)
    - 整數列(有符號的) -2147483648 ～ 2147483647

PositiveIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
    - 正整數 0 ～ 2147483647

BigIntegerField(IntegerField):
    - 長整型(有符號的) -9223372036854775808 ～ 9223372036854775807

BooleanField(Field)
    - 布爾值類型

NullBooleanField(Field):
    - 能夠爲空的布爾值

CharField(Field)
    - 字符類型
    - 必須提供max_length參數， max_length表示字符長度

TextField(Field)
    - 文本類型

EmailField(CharField)：
    - 字符串類型，Django Admin以及ModelForm中提供驗證機制

IPAddressField(Field)
    - 字符串類型，Django Admin以及ModelForm中提供驗證 IPV4 機制

GenericIPAddressField(Field)
    - 字符串類型，Django Admin以及ModelForm中提供驗證 Ipv4和Ipv6
    - 參數：
        protocol，用於指定Ipv4或Ipv6， 'both',"ipv4","ipv6"
        unpack_ipv4， 若是指定爲True，則輸入::ffff:192.0.2.1時候，可解析爲192.0.2.1，開啓此功能，須要protocol="both"

URLField(CharField)
    - 字符串類型，Django Admin以及ModelForm中提供驗證 URL

SlugField(CharField)
    - 字符串類型，Django Admin以及ModelForm中提供驗證支持 字母、數字、下劃線、鏈接符（減號）

CommaSeparatedIntegerField(CharField)
    - 字符串類型，格式必須爲逗號分割的數字

UUIDField(Field)
    - 字符串類型，Django Admin以及ModelForm中提供對UUID格式的驗證

FilePathField(Field)
    - 字符串，Django Admin以及ModelForm中提供讀取文件夾下文件的功能
    - 參數：
        path,                      文件夾路徑
        match=None,                正則匹配
        recursive=False,           遞歸下面的文件夾
        allow_files=True,          容許文件
        allow_folders=False,       容許文件夾

FileField(Field)
    - 字符串，路徑保存在數據庫，文件上傳到指定目錄
    - 參數：
        upload_to = ""      上傳文件的保存路徑
        storage = None      存儲組件，默認django.core.files.storage.FileSystemStorage

ImageField(FileField)
    - 字符串，路徑保存在數據庫，文件上傳到指定目錄
    - 參數：
        upload_to = ""      上傳文件的保存路徑
        storage = None      存儲組件，默認django.core.files.storage.FileSystemStorage
        width_field=None,   上傳圖片的高度保存的數據庫字段名（字符串）
        height_field=None   上傳圖片的寬度保存的數據庫字段名（字符串）

DateTimeField(DateField)
    - 日期+時間格式 YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]

DateField(DateTimeCheckMixin, Field)
    - 日期格式      YYYY-MM-DD

TimeField(DateTimeCheckMixin, Field)
    - 時間格式      HH:MM[:ss[.uuuuuu]]

DurationField(Field)
    - 長整數，時間間隔，數據庫中按照bigint存儲，ORM中獲取的值爲datetime.timedelta類型

FloatField(Field)
    - 浮點型

DecimalField(Field)
    - 10進制小數
    - 參數：
        max_digits，小數總長度
        decimal_places，小數位長度

BinaryField(Field)
    - 二進制類型

字段與數據庫實際字段的對應關係

對應關係：
    'AutoField': 'integer AUTO_INCREMENT',
    'BigAutoField': 'bigint AUTO_INCREMENT',
    'BinaryField': 'longblob',
    'BooleanField': 'bool',
    'CharField': 'varchar(%(max_length)s)',
    'CommaSeparatedIntegerField': 'varchar(%(max_length)s)',
    'DateField': 'date',
    'DateTimeField': 'datetime',
    'DecimalField': 'numeric(%(max_digits)s, %(decimal_places)s)',
    'DurationField': 'bigint',
    'FileField': 'varchar(%(max_length)s)',
    'FilePathField': 'varchar(%(max_length)s)',
    'FloatField': 'double precision',
    'IntegerField': 'integer',
    'BigIntegerField': 'bigint',
    'IPAddressField': 'char(15)',
    'GenericIPAddressField': 'char(39)',
    'NullBooleanField': 'bool',
    'OneToOneField': 'integer',
    'PositiveIntegerField': 'integer UNSIGNED',
    'PositiveSmallIntegerField': 'smallint UNSIGNED',
    'SlugField': 'varchar(%(max_length)s)',
    'SmallIntegerField': 'smallint',
    'TextField': 'longtext',
    'TimeField': 'time',
    'UUIDField': 'char(32)',

字段參數

null：用於表示某個字段能夠爲空。

unique：若是設置爲 unique=True 則該字段在此表中必須是惟一的 。

db_index：若是 db_index=True 則表明着爲此字段設置數據庫索引。

default：爲該字段設置默認值。

時間字段獨有

DatetimeField、DateField、TimeField 這個三個時間字段，均可以設置以下屬性。

auto_now_add：配置 auto_now_add=True ，建立數據記錄的時候會把當前時間添加到數據庫。

auto_now：配置上 auto_now=True ，每次更新數據記錄的時候會更新該字段。

關係字段

ForeignKey

外鍵類型在 ORM 中用來表示外鍵關聯關係，通常把 ForeignKey 字段設置在一對多中 「多」 的一方。

ForeignKey 能夠和其餘表做關聯關係同時也能夠和自身做關聯關係。

字段參數

to：設置要關聯的表

to_field：設置要關聯的表的字段

related_name：反向操做時，使用的字段名，用於代替原反向查詢時的 「表名_set" 。

例如：

class Classes(models.Model):
    name = models.CharField(max_length=32)

class Student(models.Model):
    name = models.CharField(max_length=32)
    theclass = models.ForeignKey(to="Classes")

當要查詢某個班級關聯的全部學生（反向查詢）時，會這麼寫：

models.Classes.objects.first().student_set.all()

當在 ForeignKey 字段中添加了參數 related_name 後，

class Student(models.Model):
    name = models.CharField(max_length=32)
    theclass = models.ForeignKey(to="Classes", related_name="students")

當要查詢某個班級關聯的全部學生（反向查詢）時，會這麼寫：

models.Classes.objects.first().students.all()

related_query_name：反向查詢操做時，使用的鏈接前綴，用於替換表名。

on_delete：當刪除關聯表中的數據時，當前表與其關聯的行的行爲。

models.CASCADE：刪除關聯數據，與之關聯也刪除

models.DO_NOTHING：刪除關聯數據，引起錯誤 IntegrityError

models.PROTECT：刪除關聯數據，引起錯誤 ProtectedError

models.SET_NULL：刪除關聯數據，與之關聯的值設置爲 null（前提 FK 字段須要設置爲可空）

models.SET_DEFAULT：刪除關聯數據，與之關聯的值設置爲默認值（前提FK字段須要設置默認值）

models.SET：刪除關聯數據
a. 與之關聯的值設置爲指定值，設置：models.SET(值)
b. 與之關聯的值設置爲可執行對象的返回值，設置：models.SET(可執行對象)

def func():
    return 10

class MyModel(models.Model):
    user = models.ForeignKey(
        to="User",
        to_field="id"，
        on_delete=models.SET(func)
    )

db_constraint：是否在數據庫中建立外鍵約束，默認爲 True。

OneToOneField

一對一字段。一般一對一字段用來擴展已有字段。

示例：

class Author(models.Model):
    name = models.CharField(max_length=32)
    info = models.OneToOneField(to='AuthorInfo')
    

class AuthorInfo(models.Model):
    phone = models.CharField(max_length=11)
    email = models.EmailField()

字段參數

to：設置要關聯的表。

to_field：設置要關聯的字段。

on_delete：同 ForeignKey 字段。

ManyToManyField

用於表示多對多的關聯關係。在數據庫中經過第三張表來創建關聯關係。

字段參數

to：設置要關聯的表

related_name：同 ForeignKey 字段。

related_query_name：同 ForeignKey 字段。

symmetrical：僅用於多對多自關聯時，指定內部是否建立反向操做的字段。默認爲True。

舉個例子：

class Person(models.Model):
    name = models.CharField(max_length=16)
    friends = models.ManyToManyField("self")

此時，person 對象就沒有 person_set 屬性。

class Person(models.Model):
    name = models.CharField(max_length=16)
    friends = models.ManyToManyField("self", symmetrical=False)

此時，person 對象如今就可使用 person_set 屬性進行反向查詢。

through：在使用 ManyToManyField 字段時，Django 將自動生成一張表來管理多對多的關聯關係。但也能夠手動建立第三張表來管理多對多關係，此時就須要經過 through 來指定第三張表的表名。

through_fields：設置關聯的字段。

db_table：默認建立第三張表時，數據庫中表的名稱。

多對多關聯關係的三種方式

自行建立第三張表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="書名")

class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="做者姓名")

# 本身建立第三張表，分別經過外鍵關聯書和做者
class Author2Book(models.Model):
    author = models.ForeignKey(to="Author")
    book = models.ForeignKey(to="Book")

    class Meta:
        unique_together = ("author", "book")

經過 ManyToManyField 自動建立第三張表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="書名")

# 經過ORM自帶的ManyToManyField自動建立第三張表
class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="做者姓名")
    books = models.ManyToManyField(to="Book", related_name="authors")

設置 ManyTomanyField 並指定自行建立的第三張表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="書名")

# 本身建立第三張表，並經過ManyToManyField指定關聯
class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="做者姓名")
    books = models.ManyToManyField(to="Book", through="Author2Book", through_fields=("author", "book"))
    # through_fields接受一個2元組（'field1'，'field2'）：
    # 其中field1是定義ManyToManyField的模型外鍵的名（author），field2是關聯目標模型（book）的外鍵名。

class Author2Book(models.Model):
    author = models.ForeignKey(to="Author")
    book = models.ForeignKey(to="Book")

    class Meta:
        unique_together = ("author", "book")

注意：當須要在第三張關係表中存儲額外的字段時，就要使用第三種方式。可是當使用第三種方式建立多對多關聯關係時，就沒法使用 set、add、remove、clear 方法來管理多對多的關係了，須要經過第三張表的 model 來管理多對多關係。

元信息

ORM 對應的類裏面包含另外一個 Meta 類，而 Meta 類封裝了一些數據庫的信息。主要字段以下:

db_table：ORM 在數據庫中的表名默認是 app 類名，能夠經過 db_table 能夠重寫表名。

index_together：聯合索引。

unique_together：聯合惟一索引。

ordering：指定默認按什麼字段排序。只有設置了該屬性，查詢到的結果才能夠被 reverse() 。

class UserInfo(models.Model):
        nid = models.AutoField(primary_key=True)
        username = models.CharField(max_length=32)

        class Meta:
            # 數據庫中生成的表名稱 默認 app名稱 + 下劃線 + 類名
            db_table = "table_name"

            # 聯合索引
            index_together = [
                ("pub_date", "deadline"),
            ]

            # 聯合惟一索引
            unique_together = (("driver", "restaurant"),)
            
            ordering = ('name',)
            
            # admin中顯示的表名稱
            verbose_name='哈哈'

            # verbose_name加s
            verbose_name_plural=verbose_name