Django - ORM字段和字段參數

目錄

• Django - ORM字段和字段參數
  • 一. Django中的ORM
    • 1. Django項目使用MySQL數據庫
    • 2.Model
    • 3.基本用法
  • Django ORM 經常使用字段和參數
    • 經常使用字段
    • 其餘字段
    • 自定義字段
    • 字段參數
  • 關係字段
    • ForeignKey
    • OneToOneField
    • ManyToManyField

Django - ORM字段和字段參數

對象關係映射（Object Relational Mapping，簡稱ORM）模式是一種爲了解決面向對象與關係數據庫存在的互不匹配的現象的技術。

簡單的說，ORM是經過使用描述對象和數據庫之間映射的元數據，將程序中的對象自動持久化到關係數據庫中。

ORM在業務邏輯層和數據庫層之間充當了橋樑的做用。

一. Django中的ORM

1. Django項目使用MySQL數據庫

1. 在Django項目的settings.py文件中，配置數據庫鏈接信息：

   DATABASES = {
   "default": {
   "ENGINE": "django.db.backends.mysql",
   "NAME": "你的數據庫名稱", # 須要本身手動建立數據庫
   "USER": "數據庫用戶名",
   "PASSWORD": "數據庫密碼",
   "HOST": "數據庫IP",
   "POST": 3306
   }
   }

2. 在Django項目的__init__.py文件中寫以下代碼，告訴Django使用pymysql模塊鏈接MySQL數據庫:

   import pymysql

   pymysql.install_as_MySQLdb()

2.Model

在Django中model是你數據的單1、明確的信息來源。它包含了你存儲的數據的重要字段和行爲。一般，一個模型（model）映射到一個數據庫表，

基本狀況：

• 每一個模型都是一個Python類，它是django.db.models.Model的子類。
• 模型的每一個屬性都表明一個數據庫字段。
• 綜上所述，Django爲您提供了一個自動生成的數據庫訪問API.

3.基本用法

下面這個例子定義了一個 Person 模型，包含 first_name 和 last_name。

from django.db import models

class Person(models.Model):
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)

first_name 和 last_name 是模型的字段。每一個字段被指定爲一個類屬性，每一個屬性映射到一個數據庫列。

上面的 Person 模型將會像這樣建立一個數據庫表：

CREATE TABLE myapp_person (
    "id" serial NOT NULL PRIMARY KEY,
    "first_name" varchar(30) NOT NULL,
    "last_name" varchar(30) NOT NULL
);

一些說明：

表myapp_person的名稱是自動生成的，若是你要自定義表名，須要在model的Meta類中指定 db_table 參數，強烈建議使用小寫表名，特別是使用MySQL做爲後端數據庫時。
id字段是自動添加的，若是你想要指定自定義主鍵，只需在其中一個字段中指定 primary_key=True 便可。若是Django發現你已經明確地設置了Field.primary_key，它將不會添加自動ID列。
本示例中的CREATE TABLE SQL使用PostgreSQL語法進行格式化，但值得注意的是，Django會根據配置文件中指定的數據庫後端類型來生成相應的SQL語句。
Django支持MySQL5.5及更高版本。

Django 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]，至關於

其餘字段

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)
        - 二進制類型

自定義字段

class UnsignedIntegerField(models.IntegerField):
    def db_type(self, connection):
        return 'integer UNSIGNED'

自定義char類型字段：

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

    def db_type(self, connection):
        """
        限定生成數據庫表的字段類型爲char，長度爲length指定的值
        """
        return 'char(%s)' % self.length


class Class(models.Model):
    id = models.AutoField(primary_key=True)
    title = models.CharField(max_length=25)
    # 使用上面自定義的char類型的字段
    cname = FixedCharField(max_length=25)

建立的表結構:

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

對應關係:

對應關係：
    '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，每次更新數據記錄的時候會更新該字段。

關係字段

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

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

元信息(Meta)

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

db_table

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

index_together

聯合索引。

unique_together

聯合惟一索引。

ordering

指定默認按什麼字段排序。

只有設置了該屬性，咱們查詢到的結果才能夠被reverse()。