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

Question

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

Answer 1

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

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

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

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

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

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

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

Answer 2

from django.db import models

class EnumField(models.Field):
    """
    A field class that maps to MySQL's 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) )

Answer 3

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

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

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

ОБНОВЛЕНИЕ : Так как среда миграции была добавлена ​​в Django 1.7, опции 1 и 2 выше полностью устарели. Вариант 3 всегда был лучшим вариантом в любом случае. Новая версия параметров 1/2 будет включать сложную пользовательскую миграцию с использованием SeparateDatabaseAndState - но на самом деле вам нужен вариант 3.

Answer 4

Установка 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    |                |
+--------+-----------------------------+------+-----+---------+----------------+

Answer 5

http://www.b -list.org / блог / 2007 / ноябрь / 02 / ручка-выбор-правый путь /

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:

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

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

Answer 6

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

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

Удачи!

Answer 7

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

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

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

Answer 8

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

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