Django v1.0 documentation

モデルフィールドリファレンス

revision-up-to:8961 (1.0)

このドキュメントは、 Django が提供している フィールドのオプションフィールド型 の雑多で細かい解説です。

See also

組み込みのフィールド型で不足なことがあれば、簡単に 独自のカスタム モデルフィールドを作成できます

Note

技術的には、モデルフィールドは django.db.models.fields モジュー ルで定義されていますが、便宜上、 django.db.models 内で import さ れています。モデルフィールドを使うときは、慣習的に from django.db import models として、 models.<Foo>Field のよう に参照します。

フィールドオプション

全てのフィールド型で、以下の引数を指定できます。これらの引数はすべてオプショ ンです。

null

Field.null

True にすると、 Django は空の値を NULL としてデータベースに入れます。 デフォルト値は False です。

空の文字列値は NULL ではなく空文字列として保存されることに注意して下さ い。 null=True が使えるのは、整数型やブール型、日付のような、文字列では ないフィールド型の場合だけです。 null はデータベースでの記録 操作にのみかかわるパラメタなので、フォーム上で空の値を入力できるようにした ければ blank=True も指定する必要があるでしょう (blank も 参照してください)。

特別な理由のない限り、 CharFieldTextField のような、 文字列ベースのフィールドには null を指定しないでください。 文字列ベースのフィールドが nill=True であるということは、「データがない」 ことを表すのに NULL と空文字列という二つの値が存在することを示します。 多くの場合、「データがない」ことを表すのに二つのを取り得るのは冗長でしかあ りません。 Django の慣習では、データのない文字列フィールドの値は NULL ではなく空文字列です。

Note

Oracle バックエンドを使っている場合、データベースの制約のため、 空文字列を許すような文字列ベースのフィールドは、 null=True オプショ ンが強制的に付加され、 NULL は空の文字列を指します。

blank

Field.blank

True にすると、フィールドの値を空白 (blank) にできます。デフォルト値は False です。

null とは違うことに注意してください。 null が 純粋にデータベース上の表現に関わる概念であるのに対し、 blank とは値の検証 (validation) に関わる概念です。あるフィールドに blank=True を指定すると、 Django の admin サイト上で、空の値のエントリを作成できます。 blank=False にすると、そのフィールドには必ず値を入れねばなりません。

choices

Field.choices

2 要素のタプルからなる iterable (リストまたはタプル) を、フィールドの値の選 択肢にします。

この値を指定すると、 Django の admin には標準的なテキストフィールドの代わり に選択ボックスが表示され、指定された選択肢だけをえらべます。

選択肢リストは以下のように指定します:

YEAR_IN_SCHOOL_CHOICES = (
    ('FR', 'Freshman'),
    ('SO', 'Sophomore'),
    ('JR', 'Junior'),
    ('SR', 'Senior'),
    ('GR', 'Graduate'),
)

各タプルの最初の要素は、データベースに実際に保存される値です。二つ目の値は 各オプションに対する人間可読な名前です。

選択肢リストは、モデルクラスの一部として定義できます:

class Foo(models.Model):
    GENDER_CHOICES = (
        ('M', 'Male'),
        ('F', 'Female'),
    )
    gender = models.CharField(max_length=1, choices=GENDER_CHOICES)

また、モデルクラスの外でも定義できます:

GENDER_CHOICES = (
    ('M', 'Male'),
    ('F', 'Female'),
)
class Foo(models.Model):
    gender = models.CharField(max_length=1, choices=GENDER_CHOICES)

また、選択肢をグループごとに集めて、名前をつけられます:

MEDIA_CHOICES = (
    ('Audio', (
            ('vinyl', 'Vinyl'),
            ('cd', 'CD'),
        )
    ),
    ('Video', (
            ('vhs', 'VHS Tape'),
            ('dvd', 'DVD'),
        )
    ),
    ('unknown', 'Unknown'),
)

各タプルの最初の要素は、選択肢グループの名前です。二つ目の要素は、2 要素の タプルからなるイテレーション可能なオブジェクトです。各 2 要素タプルには、 選択肢の値と、人間可読な名前を指定します。(上の例の unknown オプション のように) グループ化されたオプションとされていないオプションを混ぜても構い ません。

choices セットを持つモデルフィールド各々について、 Django は 特殊なメソッドを追加し、フィールドの現在値を人間可読な形式で取得できるよう にします。データベース API ドキュメントの get_FOO_display() を参照してください。

最後に、 choices はリストやタプルでなくてもよく、任意の iterable オブジェク トでかまわないことに注意してください。つまり、 choices は動的生成できるので す。とはいえ、 choices を動的生成するようなハックをするくら いなら、適当なデータベーステーブルを ForeignKey で参照した方がよい でしょう。というのも、 choices はあまり変更のない静的な選択 肢のためのオプションだからです。

db_column

Field.db_column

フィールドに使うデータベースカラム名です。この値を指定しなければ、 Django はフィールド名を使います。

データベースカラム名が SQL の予約語であったり、 Python で変数名として使えな い文字を含んでいる (よくあるのはハイフンです) 場合でも問題ありません。 Django は必要に応じてカラム名やテーブル名をクオートします。

db_index

Field.db_index

True にすると django-admin.py sqlindexes を実行した時に、フィールドに対して CREATE INDEX 文を出力します。

db_tablespace

Field.db_tablespace
Django 1.0 で新たに登場しました.

フィールドの値をインデクス化する際、フィールドのインデクスとして使うデータ ベースのテーブル空間 (tablespace) の名前です。デフォルトの値は、プロジェク トで設定されている DEFAULT_INDEX_TABLESPACE です。この値がなけれ ば、モデルの db_tablespace を使います。データベースバックエ ンドがテーブルスペースをサポートしていなければ、このオプションは無視されま す。

default

Field.default

フィールドのデフォルト値です。この値は、何らかの値でも、呼び出し可能オブジェ クトでもかまいません。呼び出し可能オブジェクトの場合、新たなオブジェクトが 生成されるたびに呼び出されます。

editable

Field.editable

False にすると、 admin 上や、モデルクラスから生成したフォームの上でフィー ルドの値を編集できなくなります。デフォルト値は True です。

help_text

Field.help_text

オブジェクトの admin フォームの下に表示される、追加の「ヘルプ」テキストです。 とはいえ、オブジェクトが admin のフォームを持っていなくてもドキュメントとし て有用でしょう。

この値は admin インタフェース上に表示されるときに HTML エスケープされ ない ので注意してください。必要ならば、下記の例のように help_text にHTML を含めてもかまいません:

help_text="Please use the following format: <em>YYYY-MM-DD</em>."

プレーンテキストを使って、 django.utils.html.escape() でHTML の特殊文字 をエスケープしてもかまいません。

primary_key

Field.primary_key

True に指定すると、フィールドをモデルの主キーにします。

モデルのどのフィールドにも primary_key=True を指定しなければ、Django は 自動的に IntegerField を追加して主キーを保存します。従って、デフォ ルトの主キーの振舞いを変更したいのでないかぎり、 primary_key=True をフィー ルドに指定しておく必要はありません。詳しくは 自動的な主キーフィールド を参照してください。

primary_key=True であるということは、 null=False かつ unique=True であることを指します。一つのオブジェ クトには一つしか主キーを指定できません。

unique

Field.unique

True であれば、フィールドはテーブル全体で一意の値を取らねばなりません。

この制約は、データベースレベルと Django の admin のレベルで適用されます。 重複した値を持つ unique フィールドを含んだモデルを保存しよう とすると、モデルの save() メソッドによって django.db.IntegrityError が送出されます。

このオプションは、 ManyToManyField 以外の全てのフィールドで利用で きます。

unique_for_date

Field.unique_for_date

DateFieldDateTimeField 型のフィールドの名前を指定して おくと、そのフィールドの日付に対して一意な値になるように制約します。

例えば、 title という名前のフィールドがあり、 unique_for_date="pub_date" が指定されていたとすると、 Django は同じ titlepub_date の値を持つようなエントリを受け入れません。

この制約は Django の admin フォームのレベルで適用され、データベースレベルで は適用されません。

unique_for_month

Field.unique_for_month

unique_for_date と同様ですが、フィールドの値が月ごとに一意で あるように制約します。

unique_for_year

Field.unique_for_year

unique_for_dateunique_for_month と同じで す。

Field types

AutoField

class AutoField(**options)

IntegerField の一種で、利用可能な ID の中から自動的にインクリメン トしていきます。通常、このフィールドが直接必要になることはないでしょう。主 キーのフィールドは、特に指定しない限り自動的に追加されます。 自動的な主キーフィールド を参照してください。

BooleanField

class BooleanField(**options)

真偽 (true/false) 値を表すフィールドです。

admin ではこのフィールドはチェックボックスとして表現されます。

MySQL ユーザへの注意

MySQL では、ブール型のフィールドの値を TINYINT カラムに 0 または 1 で保存します (ほとんどのデータベースでは、適切な BOOLEAN 型を使いま す)。従って、 MySQL に限って、 BooleanField の値をデータベースから 取り出してモデルの属性に保存すると、その値は TrueFalse では なく 1 や 0 になります。 Python は 1 == True かつ 0 == False を 保証しているので、通常、この動作が問題になることはありません。ただし、 obj is True のような式を書いていて、 obj がモデルのブール型属性 を指してるときには注意してください。 mysql バックエンドを使ってモデ ルを構築すると、この is テストは常に失敗します。 (== を使って) 等値比較を行ってください。

CharField

class CharField(max_length=None[, **options])

文字列フィールドで、短い文字列からやや長いものに適しています。

大量のテキストを入れたい場合には TextField を使っ て下さい。

admin では <input type="text"> (一行の入力フィールド) で表現されます。

CharField 必須の引数があります:

CharField.max_length
フィールドの (文字数で表した) 最大長です。 max_length への制約はデー タベースと Django 内の検証の両方のレベルで行われます。

MySQL ユーザへの注意

MySQLdb 1.2.2 でこのフィールドを使っていて、コレーションを (デフォルト 設定 でない) utf8_bin に設定していると、いろいろと問題を引き起こ します。詳しくは MySQL データベースに関する注意 を参照してください。

CommaSeparatedIntegerField

class CommaSeparatedIntegerField(max_length=None[, **options])

カンマで区切った整数からなるフィールドです。 CharField と同じく、 max_length 引数が必要です。

DateField

class DateField([auto_now=False, auto_now_add=False, **options])

日付フィールドです。オプションの引数がいくつかあります:

DateField.auto_now
オブジェクトを保存する度に、その時の時刻を自動的に設定します。 "last-modified" タイムスタンプの実現に便利です。この値はオーバライドで きるデフォルト値ではなく、 常に 現在の日付になるので注意してください。
DateField.auto_now_add
オブジェクトを生成した時の時刻を自動的に設定します。タイムスタンプの生 成に便利です。この値はオーバライドできるデフォルト値ではなく、 常に 現在の日付になるので注意してください。

admin では、 JavaScript のカレンダーと 「今日」へのショートカットのついた <input type="text"> として表現されます。 JavaScript カレンダーは常に日 曜日から週が始まります。

DateTimeField

class DateTimeField([auto_now=False, auto_now_add=False, **options])

日付と時刻のフィールドです。 DateField と同じオプションを取ります。

admin では JavaScript のショートカットのついた <input type="text"> フィールドで表現されます。

DecimalField

Django 1.0 で新たに登場しました.
class DecimalField(max_digits=None, decimal_places=None[, **options])

固定精度の 10 進小数です。 Python の Decimal 型インスタン スとして表現されます。 必須の 引数が 2 つあります:

DecimalField.max_digits
値を表現するのに使える最大桁数です。
DecimalField.decimal_places
小数部の保存に使われる桁数です。

例えば、小数部が 2 桁で、 999 までの数を表現できるようなフィールドを作成す るには、以下のようにします:

models.DecimalField(..., max_digits=5, decimal_places=2)

小数部の精度が 10 桁で、 10 億までの数を表現できるようにしたければ、以下の ようにします:

models.DecimalField(..., max_digits=19, decimal_places=10)

admin では、 <input type="text"> (一行のテキスト入力) で表現されます。

EmailField

class EmailField([max_length=75, **options])

値が有効な e-mail アドレスであるかチェックする CharField です。

Django 0.96 では、 max_length を指定できません。 max_length は常に 75 にセットされるからです。 バージョン 1.0 の Django では、 max_length はデフォルト で 75 にセットされますが、デフォルト値を書き換えるよう指定できます。

FileField

class FileField(upload_to=None[, max_length=100, **options])

ファイルアップロードのためのフィールドです。 必須の 引数を一つ持ちます:

FileField.upload_to

ローカルのファイルシステム上のパスです。このパスは MEDIA_ROOT に設定したパスの後ろにつけられ、 url 属性の値を決める際に使われます。

パスには strftime によるフォーマット を入れてもかまいません、フォー マット文字列が入っていれば、(ディレクトリが同名のアップロードファイルで 埋まらないように)ファイルのアップロード日時に置き換わります。

Django 1.0 で変更されました.

upload_to には、関数のような呼び出し可能オブジェクトも指定できます。 呼び出し可能オブジェクトを指定すると、ファイル名を含むアップロードパス を決めるために呼び出されます。この呼び出し可能オブジェクトを定義する場 合、二つの引数をとり、 (スラッシュで始まる) Unix 形式のパスを返さねば なりません。返したパスはストレージシステムで使われます。二つの引数の説 明を以下に示します:

引数 説明
instance FileField を定義しているモデルのインス タンスです。もっと正確には、ファイルを添付 しようとしているインスタンスです。ほとんど の場合、このオブジェクトはまだデータベース に保存されていないので、デフォルトの AutoField を使っている場合、 まだ主キーフィールドの値が決まっていない ことがあります。
filename もともとファイルに付けられていたファイル名 です。最終的なファイルの保存パスを決めると きに考慮してもよいですし、しなくてもかまい ません。

また、オプションの引数を一つとります:

FileField.storage
Django 1.0 で新たに登場しました.

省略可能です。ストレージの操作と、ファイルの取得を行うストレージオブジェ クトです。このオブジェクトの作り方は、 ファイルの管理 を参照してく ださい。

admin では、 <input type="file"> (ファイルアップロードウィジェット) で表現されます。

モデル中で FileFieldImageField (下記参照) を使うには、 以下のようなステップが必要です:

  1. Django にアップロードされたファイルを保存させたい場所のフルパスを設 定ファイル中の MEDIA_ROOT に指定します。(パフォーマンス上 の理由から、アップロードされたファイルはデータベースに保存されませ ん。) 保存場所への公開 URL を MEDIA_URL に指定します。 ディレクトリが Web サーバのユーザアカウントによって書き込み可能であ るか確認してください。
  2. FileFieldImageField をモデルに定義します。この とき、 upload_to オプションを指定して、 MEDIA_ROOT 下のサブディレクトリのどこにアップロードされた ファイルを置くべきかを Django に教えます。
  3. データベースに保存されるのはファイルへのパス (MEDIA_ROOT からの相対) です。Django の提供している url を使うことになるでしょう。例えば、 mug_shot という名前の ImageField があれば、画像への絶対 URL は {{ object.get_mug_shot_url }} で取得できます。

例えば、 MEDIA_ROOT'/home/media' にして、 upload_to'photos/%Y/%m/%d' に設定したとします。 upload_to'%Y/%m/%d' の部分は strftime と同じフォーマット文字を 使っています。すなわち、 '%Y' が 4 桁の年号、 '%m' が 2 桁の月、 '%d' が 2 桁の日を表します。従って、ファイルを 2007 年の 1 月 15 日にアッ プロードすると、 /home/media/photos/2007/01/15 に保存されます。

アップロードファイルのディスク上でのファイル名を取得したい場合や、ファイル にアクセスするための URL を調べたい場合、ファイルのサイズを知りたい場合は、 それぞれ name, url, size メソッドを使えます。詳しくは ファイルの管理 を参照してください。

ファイルのアップロードを処理するときには、常にアップロード先の場所やアップ ロードされるファイルに注意して、セキュリティホールを避けるようにしてくださ い。 アップロードされる全てのファイルをチェックして 、予想外のファイルが アップロードされないようにしましょう。例えば、バリデーションを行わずに Web サーバのドキュメントルート下へのファイルのアップロードを盲目的に受け入れる と、そこに誰かが CGI や PHP スクリプトをアップロードして、あなたのサイト上 の URL を訪問した人にスクリプトを実行させられてしまいます。そんなことを許し てはなりません。

Django 1.0 で新たに登場しました: max_length 引数が追加されました。

デフォルトでは、 FileField インスタンスは varchar(100) カラム をデータベースに作成します。他のフィールドと同様、 max_length 引数を使って最大長を変更できます。

FilePathField

class FilePathField(path=None[, match=None, recursive=False, max_length=100, **options])

ファイルシステム上のあるディレクトリ下のファイル名だけを選べるようになって いる CharField です。 3 つの特別な引数があり、そのうち最初の一つは 必須 です:

FilePathField.path
必須です。 FilePathField が選択肢を作成するためのディレクトリ への絶対パスです。例: "/home/images"
FilePathField.match
オプションです。正規表現を表す文字列で、 FilePathField がファ イル名のフィルタに使います。正規表現はフルパスではなくファイル名に適用 されるので注意してください。 例: "foo.*\.txt$"foo23.txt に はマッチしますが、 bar.txtfoo23.gif にはマッチしません。
FilePathField.recursive
オプションです。 True または False です。デフォルトは False で、 path のサブディレクトリを含めるかどうかを指 定します。

もちろん、これらの引数を組み合わせて使ってもかまいません。

よくある勘違いは、 match がファイル名ではなくフルパ スに適用されると思ってしまうことです。以下の例:

FilePathField(path="/home/images", match="foo.*", recursive=True)

/home/images/foo.gif にはマッチしますが、ファイル名本体 (foo.gifbar.gif) にマッチするため、 /home/images/foo/bar.gif にはマッチ しません。

Django 1.0 で新たに登場しました: max_length 引数が追加されました。

FilePathField インスタンスは varchar(100) カラムをデータベース に作成します。他のフィールドと同様、 max_length 引数を使っ て最大長を変更できます。

FloatField

class FloatField([**options])
Django 1.0 で変更されました.

浮動小数点数です。Python の float 型インスタンスで表現されます。

admin では、 <input type="text"> (一行の入力フィールド) で表現されます。

NOTE: Django 1.0 から、 FloatField の仕様が変更されています。 以前の仕様は、 Django 0.96 のドキュメント を参照してください。

ImageField

class ImageField(upload_to=None[, height_field=None, width_field=None, max_length=100, **options])

FileField に似ていますが、アップロードされたオブジェクトが有効なイ メージかどうか検証します。二つのオプション引数があります:

ImageField.height_field
モデルインスタンスを保存する際に画像の高さを自動的に入れたいモデルフィー ルドの名前です。
ImageField.width_field
モデルインスタンスを保存する際に画像の幅を自動的に入れたいモデルフィー ルドの名前です。

FileField で使える特殊属性の他に、 ImageFieldFile.height および File.width を使えます。 ファイルの管理 を参照してください。

Python Imaging Library が必要です。

Django 1.0 で新たに登場しました: max_length 引数が追加されました。

ImageField インスタンスは varchar(100) カラムをデータベースに 作成します。他のフィールドと同様、 max_length 引数を使っ て最大長を変更できます。

IntegerField

class IntegerField([**options])

整数です。 admin では、 <input type="text"> (一行の入力フィールド) で表 現されます。

IPAddressField

class IPAddressField([**options])

IP アドレスを 文字列形式で表したもの (例: "192.0.2.30") です。admin では、 <input type="text"> (一行の入力フィールド) で表現されます。

NullBooleanField

class NullBooleanField([**options])

BooleanField と同じですが、 NULL を選択肢に使えます。 null=TrueBooleanField の代わりに使って下さい。 admin では、 「不明」 ("Unknown") 「はい」 ("Yes")、「いいえ」 ("No") の選択肢をもつ <select> ボックスで表現されます。

PositiveIntegerField

class PositiveIntegerField([**options])

IntegerField と同じですが、正の数でなければなりません。

PositiveSmallIntegerField

class PositiveSmallIntegerField([**options])

PositiveIntegerField と同じですが、ある範囲以下 (データベース依存 です)の値しか使えません。

SlugField

class SlugField([max_length=50, **options])

スラグ (slug)」は新聞業界の用語で、内容を示す短いラベル です。スラグは文字、数字、アンダースコア、ハイフンだけからなります。スラグ はよく URL に使われます。

CharField と同様、 max_length を指定できます。 指定しなかった場合、Django はデフォルト値の 50 を使います。

Field.db_indexTrue に設定します。

SmallIntegerField

class SmallIntegerField([**options])

IntegerField と同様ですが、ある (データベース依存の) 範囲の値しか 使えません。

TextField

class TextField([**options])

長いテキストのためのフィールドです。admin では、 <textarea> (複数行の入 力フィールド) で表現されます。

MySQL ユーザへの注意

MySQLdb 1.2.2 でこのフィールドを使っていて、コレーションを (デフォルト 設定 でない) utf8_bin に設定していると、いろいろと問題を引き起こ します。詳しくは MySQL データベースに関する注意 を参照してください。

TimeField

class TimeField([auto_now=False, auto_now_add=False, **options])

時刻です。 DateFieldDateTimeField と同じく、自動的に 値を埋めるためのオプションを使えます。admin では、JavaScript のショートカッ トがついた <input type="text"> で表現されます。

URLField

class URLField([verify_exists=True, max_length=200, **options])

URL を表すための CharField です。引数を一つとります:

URLField.verify_exists
True (デフォルト値です) にすると、指定された URL が実在する (URL は 実際にロードでき、かつ 404 応答を返さない) かどうか検証します。

admin では、 <input type="text"> (一行の入力フィールド) で表現されます。

CharField の他のサブクラスと同じく、 URLField にはオプショ ンの引数として、フィールドの最大長 (文字数) を表す max_length を指定できます。 max_length を指定しないときのデフォルトの値は 200 です。

XMLField

class XMLField(schema_path=None[, **options])

TextField と同様ですが、指定されたスキーマに従って、値が有効な XML であ るか検証します。必須の引数を一つとります:

schema_path
検証に使う RelaxNG スキーマを指すファイルシステム上のパス名です。

リレーションフィールド

Django は、リレーションを表現するためのフィールドも定義しています。

ForeignKey

class ForeignKey(othermodel[, **options])

多対一のリレーションです。必須の固定引数として、リレーションを張るモデルの クラスをとります。

再帰的なリレーションを張る、つまり自分自身への多対一のリレーションを張る場 合には、 models.ForeignKey('self') を使います。

未定義のモデルへのリレーションを作成したい場合、モデルオブジェクトではなく モデルの名前も使えます:

class Car(models.Model):
    manufacturer = models.ForeignKey('Manufacturer')
    # ...

class Manufacturer(models.Model):
    # ...

とはいえ、この指定方法を使えるのは、対象のモデルが同じ models.py ファイ ル内で定義されている場合だけです。他のアプリケーションで定義されているモデ ルや、どこかから import してきたモデルに対しては、文字列による指定はできま せん。

Django 1.0 で変更されました: 他のアプリケーションで定義されているモデルを参照する場合には、アプリケー ションラベルを入れなければならなくなりました。

他のアプリケーションで定義されているモデルを参照したければ、アプリケーショ ンラベルを明示的に指定せねばなりません。例えば、上の例の Manufacturer モデルが、 production という別のアプリケーションで定義されているのなら、 以下のように書かねばなりません:

class Car(models.Model):
    manufacturer = models.ForeignKey('production.Manufacturer')

舞台裏では、 Django はフィールド名に "_id" をつけた名前でデータベースの カラム名を生成します。上の例では、 Car モデルのデータベーステーブルには manufacturer_id カラムが入ります (このカラム名は db_column を明示的 に指定して変更できます。詳しくは db_column を参照してくださ い) 。とはいえ、カスタムのSQL 文を発行するのでないかぎり、データベースのカ ラム名をコードで直接扱う必要はありません。

ForeignKey は、他にもいくつかオプションの引数をとります。これらの 引数を使うと、リレーションの細かい動作を定義できます。

ForeignKey.limit_choices_to

データベースの照合オプション (クエリを生成する 参照) と値を対応 づけた辞書で、 admin で選択肢を表示するときに、表示するオブジェクトを絞 り込むために使えます。 Python の datetime モジュールと組み合わせれ ば、表示するオブジェクトを日付に基づいて制限できます。例えば:

limit_choices_to = {'pub_date__lte': datetime.now}

のようにすると、 pub_date が現在の日時より前のオブジェクトだけを選 べます。

辞書の代りに Q オブジェクト (get_sql() メソッドを備えたオブジェクト) も指定でき、より複雑なクエリを実現できま す。

limit_choices_to は、 admin でリレーション先のオブジェクトを表示す るときに使われるインラインフォームセットには影響を及ぼしません。

ForeignKey.related_name
リレーション先のオブジェクトから逆参照するときに使われる名前です。 詳しくは related objects documentation を参照してください。 抽象ベースクラス で リレーションを定義する場合、この値を設定せねばなりません。また、抽象ベー スクラスで定義する場合には、 特殊な表記法 を使えます。
ForeignKey.to_field
リレーション先のオブジェクトの、リレーションを張る対象のフィールド名で す。デフォルトでは、リレーション先のオブジェクトの主キーを使います。

ManyToManyField

class ManyToManyField(othermodel[, **options])

多対多のリレーションです。必須の固定引数として、リレーション先のモデルを表 すクラスをとります。 ManyToManyField の引数は、 再帰的リレーショ ン遅延型のリレーション定義 に関するオプションを含め、 ForeignKey と 全く同じです。

背後では、 Django は中間の結合テーブル (join table) を生成して、多対多のリ レーションを表現します。デフォルトの設定では、テーブル名は結合対象の二つの テーブル名をつないで作ります。データベースによっては (例えば 32 文字といっ た) テーブル名の長さ制限があるので、テーブル名が 32 文字を越える場合には、 長さを自動的に切り詰めて、一意な名前を付けます。そのため、 author_books_9cdf4 のような名前のテーブルが生成されることがあります。こ れは仕様通りの動作です。結合テーブルの名前は、 db_table オプションで手動指定できます。

ManyToManyField は、他にもいくつかオプションの引数をとります。これ らの引数を使うと、リレーションの細かい動作を定義できます。

ManyToManyField.related_name
ForeignKey.related_name と同じです。
ManyToManyFields.limit_choices_to

ForeignKey.limit_choices_to と同じです。

ManyToManyField を中間テーブル (internmediate table) と一緒に使うと、 limit_choices_to の効果はなくなります。

ManyToManyFields.symmetrical

自分自身への ManyToManyField を定義すると きにのみ使います。以下のようなモデルを考えます:

class Person(models.Model):
    friends = models.ManyToManyField("self")

Django がこのモデルを処理する際、自分自身に対する ManyToManyField が定義されていることを認識して、 Person ク ラスに person_set 属性を追加しないようにします。その代り、 ManyToManyField を対称的 (symmetrical) であるとみなします。す なわち、私があなたの友達なら、あなたは私の友達である、というようにです。

self に対する多対多の関係に対称性を望まない場合は、 symmetricalFalse にしてください。これ により、 Django に逆参照用のデスクリプタを追加させて、 ManyToManyField を非対称にできます。

ManyToManyField.db_table
多対多のリレーション情報を保存するために作成されるテーブルの名前です。 名前を指定しなければ、Django はデフォルトの名前を使います。デフォルトの 名前は、結合する二つのテーブルの名前に基づいて決められます。

OneToOneField

class OneToOneField(othermodel[, parent_link=False, **options])

一対一のリレーションです。一対一のリレーションは、概念的には unique=True であるような ForeignKey に似て いますが、リレーションの「逆」を辿ったときに、単一のオブジェクトを直接返す 点が違います。

最も OneToOneField が便利な局面は、他のモデルを何らかの形で拡張するとき のモデルの主キーとして使う場合です。例えば、 マルチテーブル継承 は、一対一のリレーションを子のモデルから親のモデルに自動的に張ることで実現 しています。

必須の固定引数として、リレーション先のモデルを表すクラスをとります。 引数は、 再帰的リレーション遅延 型のリレーション定義 に関するオプションを含め、 ForeignKey と全く同じです。

OneToOneField は、 ForeignKey で指定できる引数に加えて、以下の 引数を指定できます:

他のモデルを継承しているモデル中で True にすると、子のクラスのイン スタンスから親のクラスのインスタンスに向けたリンクのフィールドとして 使います。通常は、サブクラス化によって暗黙のうちに OneToOneField が作成されます。