ORM常用欄位及引數與查詢 -劉

阿新 • • 發佈：2020-12-19

1 ORM欄位

AutoField

int自增列，必須填入引數 primary_key=True。當model中如果沒有自增列，則自動會建立一個列名為id的列。

IntegerField

一個整數型別,範圍在 -2147483648 to 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)',

ORM欄位與資料庫實際欄位的對應關係

2 ORM欄位引數

null

用於表示某個欄位可以為空。

unique

如果設定為unique=True 則該欄位在此表中必須是唯一的。

db_index

如果db_index=True 則代表著為此欄位設定索引。

default

為該欄位設定預設值。

DateField和DateTimeField

auto_now_add

配置auto_now_add=True，建立資料記錄的時候會把當前時間新增到資料庫。

auto_now

配置上auto_now=True，每次更新資料記錄的時候會更新該欄位。

null                資料庫中欄位是否可以為空
    db_column           資料庫中欄位的列名
    db_tablespace
    default             資料庫中欄位的預設值
    primary_key         資料庫中欄位是否為主鍵
    db_index            資料庫中欄位是否可以建立索引
    unique              資料庫中欄位是否可以建立唯一索引
    unique_for_date     資料庫中欄位【日期】部分是否可以建立唯一索引
    unique_for_month    資料庫中欄位【月】部分是否可以建立唯一索引
    unique_for_year     資料庫中欄位【年】部分是否可以建立唯一索引

    verbose_name        Admin中顯示的欄位名稱
    blank               Admin中是否允許使用者輸入為空
    editable            Admin中是否可以編輯
    help_text           Admin中該欄位的提示資訊
    choices             Admin中顯示選擇框的內容，用不變動的資料放在記憶體中從而避免跨表操作
                        如：gf = models.IntegerField(choices=[(0, '何穗'),(1, '大表姐'),],default=1)

    error_messages      自定義錯誤資訊（字典型別），從而定製想要顯示的錯誤資訊；
                        字典健：null, blank, invalid, invalid_choice, unique, and unique_for_date
                        如：{'null': "不能為空.", 'invalid': '格式錯誤'}

    validators          自定義錯誤驗證（列表型別），從而定製想要的驗證規則
                        from django.core.validators import RegexValidator
                        from django.core.validators import EmailValidator,URLValidator,DecimalValidator,\
                        MaxLengthValidator,MinLengthValidator,MaxValueValidator,MinValueValidator
                        如：
                            test = models.CharField(
                                max_length=32,
                                error_messages={
                                    'c1': '優先錯資訊1',
                                    'c2': '優先錯資訊2',
                                    'c3': '優先錯資訊3',
                                },
                                validators=[
                                    RegexValidator(regex='root_\d+', message='錯誤了', code='c1'),
                                    RegexValidator(regex='root_112233\d+', message='又錯誤了', code='c2'),
                                    EmailValidator(message='又錯誤了', code='c3'), ]
                            )

瞭解一下

3 關係欄位

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

預設建立第三張表時，資料庫中表的名稱。

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

方式一：自行建立第三張表

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來管理多對多關係。

5 元資訊

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

瞭解

6 自定義欄位（瞭解）

自定義char型別欄位：

class FixedCharField(models.Field):
    """
    自定義的char型別的欄位類
    """
    def __init__(self, max_length, *args, **kwargs):
        self.max_length = max_length
        super(FixedCharField, self).__init__(max_length=max_length, *args, **kwargs)

    def db_type(self, connection):
        """
        限定生成資料庫表的欄位型別為char，長度為max_length指定的值
        """
        return 'char(%s)' % self.max_length


class Class(models.Model):
    id = models.AutoField(primary_key=True)
    title = models.CharField(max_length=25)
    # 使用自定義的char型別的欄位
    cname = FixedCharField(max_length=25)