Указание mySQL ENUM в модели Django

Как я могу определить и использовать ENUM в модели Django?

Ответ 1

MAYBECHOICE = (
    ('y', 'Yes'),
    ('n', 'No'),
    ('u', 'Unknown'),
)

И вы определяете charfield в своей модели:

married = models.CharField(max_length=1, choices=MAYBECHOICE)

Вы можете сделать то же самое с целыми полями, если вам не нравятся буквы в вашем db.

В этом случае перепишите свой выбор:

MAYBECHOICE = (
    (0, 'Yes'),
    (1, 'No'),
    (2, 'Unknown'),
)

Ответ 2

from django.db import models

class EnumField(models.Field):
    """
    A field class that maps to MySQL ENUM type.

    Usage:

    class Card(models.Model):
        suit = EnumField(values=('Clubs', 'Diamonds', 'Spades', 'Hearts'))

    c = Card()
    c.suit = 'Clubs'
    c.save()
    """
    def __init__(self, *args, **kwargs):
        self.values = kwargs.pop('values')
        kwargs['choices'] = [(v, v) for v in self.values]
        kwargs['default'] = self.values[0]
        super(EnumField, self).__init__(*args, **kwargs)

    def db_type(self):
        return "enum({0})".format( ','.join("'%s'" % v for v in self.values) )

Ответ 3

Использование параметра choices не будет использовать тип ENUM db; он просто создаст VARCHAR или INTEGER, в зависимости от того, используете ли вы choices с CharField или IntegerField. Как правило, это нормально. Если для вас важно, чтобы тип ENUM использовался на уровне базы данных, у вас есть три варианта:

Используйте "./manage.py sql appname", чтобы увидеть, как SQL Django генерирует, вручную модифицирует его, чтобы использовать тип ENUM, и запускайте его самостоятельно. Если сначала создать таблицу вручную, "./manage.py syncdb" не будет с ней работать.
Если вы не хотите делать это вручную каждый раз, когда вы создаете свою БД, поместите некоторый пользовательский SQL в appname/sql/modelname.sql, чтобы выполнить соответствующую команду ALTER TABLE.
Создайте настраиваемый тип поля и определите метод db_type соответствующим образом.

При любом из этих вариантов вы несете ответственность за последствия для перекрестной базы данных. В варианте 2 вы можете использовать настраиваемый SQL-сервер, специфичный для базы данных, чтобы гарантировать, что ALTER TABLE работает только в MySQL. В варианте 3 ваш метод db_type должен проверить механизм базы данных и установить тип столбца db для типа, который фактически существует в этой базе данных.

UPDATE. Поскольку в Django 1.7 была добавлена структура миграции, параметры 1 и 2 выше полностью устарели. Вариант 3 всегда был лучшим вариантом. Новая версия опций 1/2 будет включать сложную пользовательскую миграцию с помощью SeparateDatabaseAndState - но вам действительно нужна опция 3.

Ответ 4

http://www.b-list.org/weblog/2007/nov/02/handle-choices-right-way/

class Entry(models.Model):
    LIVE_STATUS = 1
    DRAFT_STATUS = 2
    HIDDEN_STATUS = 3
    STATUS_CHOICES = (
        (LIVE_STATUS, 'Live'),
        (DRAFT_STATUS, 'Draft'),
        (HIDDEN_STATUS, 'Hidden'),
    )
    # ...some other fields here...
    status = models.IntegerField(choices=STATUS_CHOICES, default=LIVE_STATUS)

live_entries = Entry.objects.filter(status=Entry.LIVE_STATUS)
draft_entries = Entry.objects.filter(status=Entry.DRAFT_STATUS)

if entry_object.status == Entry.LIVE_STATUS:

Это еще один приятный и простой способ реализации перечислений, хотя он действительно не сохраняет перечисления в базе данных.

Однако это позволяет вам ссылаться на "метку" всякий раз, когда вы запрашиваете или задаете значения по умолчанию, в отличие от ответа с наивысшим рейтингом, в котором вам нужно использовать "значение" (которое может быть числом).

Ответ 5

Параметр choices в поле допустит некоторую проверку на конец Django, но не будет определять какую-либо форму перечисляемого типа в конце базы данных.

Как уже упоминалось, решение должно указывать db_type в настраиваемом поле.

Если вы используете SQL-сервер (например, MySQL), вы можете сделать это следующим образом:

from django.db import models


class EnumField(models.Field):
    def __init__(self, *args, **kwargs):
        super(EnumField, self).__init__(*args, **kwargs)
        assert self.choices, "Need choices for enumeration"

    def db_type(self, connection):
        if not all(isinstance(col, basestring) for col, _ in self.choices):
            raise ValueError("MySQL ENUM values should be strings")
        return "ENUM({})".format(','.join("'{}'".format(col) 
                                          for col, _ in self.choices))


class IceCreamFlavor(EnumField, models.CharField):
    def __init__(self, *args, **kwargs):
        flavors = [('chocolate', 'Chocolate'),
                   ('vanilla', 'Vanilla'),
                  ]
        super(IceCreamFlavor, self).__init__(*args, choices=flavors, **kwargs)


class IceCream(models.Model):
    price = models.DecimalField(max_digits=4, decimal_places=2)
    flavor = IceCreamFlavor(max_length=20)

Запустите syncdb и проверьте свою таблицу, чтобы убедиться, что ENUM был создан правильно.

mysql> SHOW COLUMNS IN icecream;
+--------+-----------------------------+------+-----+---------+----------------+
| Field  | Type                        | Null | Key | Default | Extra          |
+--------+-----------------------------+------+-----+---------+----------------+
| id     | int(11)                     | NO   | PRI | NULL    | auto_increment |
| price  | decimal(4,2)                | NO   |     | NULL    |                |
| flavor | enum('chocolate','vanilla') | NO   |     | NULL    |                |
+--------+-----------------------------+------+-----+---------+----------------+

Ответ 6

Если вы действительно хотите использовать свои базы данных типа ENUM:

Использовать Django 1.x
Признать, что ваше приложение будет работать только в некоторых базах данных.
Голос через эту страницу документации: http://docs.djangoproject.com/en/dev/howto/custom-model-fields/#howto-custom-model-fields

Удачи!

Ответ 7

В настоящее время существует два проекта github, основанных на их добавлении, хотя я не понял, как они реализованы:

Django-EnumField:
Предоставляет поле модели Django перечисления (с использованием IntegerField) с повторными перечислениями и проверкой перехода.
Django-EnumFields:
Этот пакет позволяет использовать настоящие Python (PEP435-стиль) перечисления с Django.

Я не думаю, что я использую типы перечислений DB, но они в работах для первого.

Ответ 8

Django 3.0 имеет встроенную поддержку Enums

Из документации:

from django.utils.translation import gettext_lazy as _

class Student(models.Model):

    class YearInSchool(models.TextChoices):
        FRESHMAN = 'FR', _('Freshman')
        SOPHOMORE = 'SO', _('Sophomore')
        JUNIOR = 'JR', _('Junior')
        SENIOR = 'SR', _('Senior')
        GRADUATE = 'GR', _('Graduate')

    year_in_school = models.CharField(
        max_length=2,
        choices=YearInSchool.choices,
        default=YearInSchool.FRESHMAN,
    )

Теперь имейте в виду, что не применяет выбор на уровне базы данных, это только конструкция Python. Если вы хотите также применить это значение в базе данных, вы можете объединить его с ограничениями базы данных:

class Student(models.Model):
    ...

    class Meta:
        constraints = [
            CheckConstraint(
                check=Q(year_in_school__in=YearInSchool.values),
                name="valid_year_in_school")
        ]

Ответ 9

В верхней части вашего файла models.py добавьте эту строку после импорта:

    enum = lambda *l: [(s,_(s)) for s in l]