_meta APILink to this heading#モデルの _meta API は、Django ORM のコアにあります。これにより、ルックアップ、クエリ、フォーム、admin などのシステムの他のパーツは、各モデルの機能を理解できるようになります。API は、各モデルクラスの _meta 属性からアクセス可能で、django.db.models.options.Options オブジェクトのインスタンスとなっています。
提供されるメソッドと属性は次のことに利用できます。
\nモデルのすべてのフィールドインスタンスを取得する
モデルの単一のフィールドインスタンスを名前で取得する
モデルの主キーを構成するすべてのフィールドを取得する
与えられたフィールドの名前を持つフィールドインスタンスを返します。
\nfield_name には、モデル上のフィールド、抽象または継承モデル上のフィールド、そのモデルを指す他のモデル上に定義されたフィールドのいずれかの名前を指定できます。後者の場合、field_name は (優先順に) ユーザーが設定した related_query_name、ユーザーが設定した related_name、Django が自動生成した名前のいずれかになります。
隠しフィールド は、名前では取得できません。
与えられた名前のフィールドが見つからなかったときは、FieldDoesNotExist 例外が発生します。
>>> from django.contrib.auth.models import User\n\n# A field on the model\n>>> User._meta.get_field("username")\n<django.db.models.fields.CharField: username>\n\n# A field from another model that has a relation with the current model\n>>> User._meta.get_field("logentry")\n<ManyToOneRel: admin.logentry>\n\n# A non existent field\n>>> User._meta.get_field("does_not_exist")\nTraceback (most recent call last):\n ...\nFieldDoesNotExist: User has no field named 'does_not_exist'\nモデルに関連するフィールドのタプルを返します。get_fields() は、次のように2つの引数を受け取り、どのフィールドを返すのかを制御できます。
include_parentsデフォルトは True。親クラスで定義されたフィールドを再帰的に含めます。False に設定した場合、get_fields() は現在のモデル上で直接宣言されたフィールドだけを検索します。抽象モデルまたはプロキシークラスから直接継承したモデルからのフィールドは、親ではなくローカルなものとみなされます。
include_hiddenデフォルトでは False です。 True に設定すると、 get_fields() は 隠しフィールド を含みます。
>>> from django.contrib.auth.models import User\n>>> User._meta.get_fields()\n(<ManyToOneRel: admin.logentry>,\n <django.db.models.fields.AutoField: id>,\n <django.db.models.fields.CharField: password>,\n <django.db.models.fields.DateTimeField: last_login>,\n <django.db.models.fields.BooleanField: is_superuser>,\n <django.db.models.fields.CharField: username>,\n <django.db.models.fields.CharField: first_name>,\n <django.db.models.fields.CharField: last_name>,\n <django.db.models.fields.EmailField: email>,\n <django.db.models.fields.BooleanField: is_staff>,\n <django.db.models.fields.BooleanField: is_active>,\n <django.db.models.fields.DateTimeField: date_joined>,\n <django.db.models.fields.related.ManyToManyField: groups>,\n <django.db.models.fields.related.ManyToManyField: user_permissions>)\n\n# Also include hidden fields.\n>>> User._meta.get_fields(include_hidden=True)\n(<ManyToOneRel: auth.user_groups>,\n <ManyToOneRel: auth.user_user_permissions>,\n <ManyToOneRel: admin.logentry>,\n <django.db.models.fields.AutoField: id>,\n <django.db.models.fields.CharField: password>,\n <django.db.models.fields.DateTimeField: last_login>,\n <django.db.models.fields.BooleanField: is_superuser>,\n <django.db.models.fields.CharField: username>,\n <django.db.models.fields.CharField: first_name>,\n <django.db.models.fields.CharField: last_name>,\n <django.db.models.fields.EmailField: email>,\n <django.db.models.fields.BooleanField: is_staff>,\n <django.db.models.fields.BooleanField: is_active>,\n <django.db.models.fields.DateTimeField: date_joined>,\n <django.db.models.fields.related.ManyToManyField: groups>,\n <django.db.models.fields.related.ManyToManyField: user_permissions>)\nモデルの主キーを構成するフィールドのリストを返します。
\nモデルに 複合主キー が定義されている場合、複合主キーで参照されたすべての fields が含まれます。
from django.db import models\n\n\nclass TenantUser(models.Model):\n pk = models.CompositePrimaryKey("tenant_id", "id")\n tenant_id = models.IntegerField()\n id = models.IntegerField()\n>>> TenantUser._meta.pk_fields\n[\n <django.db.models.fields.IntegerField: tenant_id>,\n <django.db.models.fields.IntegerField: id>\n]\nそれ以外の場合、 モデルの 主キー として宣言された単一の値が含まれます。
>>> User._meta.pk_fields\n[<django.db.models.fields.AutoField: id>]\n