Есть ли в SQLAlchemy эквивалент get_or_create в Django?

Я хочу получить объект из базы данных, если он уже существует (на основе предоставленных параметров), или создать его, если его нет.

Джанго get_or_create(или источник ) делает это. Есть ли эквивалентный ярлык в SQLAlchemy?

В настоящее время я пишу это явно так:

def get_or_create_instrument(session, serial_number):
    instrument = session.query(Instrument).filter_by(serial_number=serial_number).first()
    if instrument:
        return instrument
    else:
        instrument = Instrument(serial_number)
        session.add(instrument)
        return instrument

Это в основном способ сделать это, нет быстрого доступа AFAIK.

Вы можете обобщить это конечно:

def get_or_create(session, model, defaults=None, **kwargs):
    instance = session.query(model).filter_by(**kwargs).first()
    if instance:
        return instance, False
    else:
        params = dict((k, v) for k, v in kwargs.iteritems() if not isinstance(v, ClauseElement))
        params.update(defaults or {})
        instance = model(**params)
        session.add(instance)
        return instance, True

Следуя решению @WoLpH, вот код, который работал для меня (простая версия):

def get_or_create(session, model, **kwargs):
    instance = session.query(model).filter_by(**kwargs).first()
    if instance:
        return instance
    else:
        instance = model(**kwargs)
        session.add(instance)
        session.commit()
        return instance

Благодаря этому я могу получить любой объект моей модели.

Предположим, мой модельный объект:

class Country(Base):
    __tablename__ = 'countries'
    id = Column(Integer, primary_key=True)
    name = Column(String, unique=True)

Чтобы получить или создать мой объект, я пишу:

myCountry = get_or_create(session, Country, name=countryName)

Я играл с этой проблемой и в итоге получил довольно надежное решение:

def get_one_or_create(session,
                      model,
                      create_method='',
                      create_method_kwargs=None,
                      **kwargs):
    try:
        return session.query(model).filter_by(**kwargs).one(), False
    except NoResultFound:
        kwargs.update(create_method_kwargs or {})
        created = getattr(model, create_method, model)(**kwargs)
        try:
            session.add(created)
            session.flush()
            return created, True
        except IntegrityError:
            session.rollback()
            return session.query(model).filter_by(**kwargs).one(), False

Я только что написал довольно обширное сообщение в блоге обо всех деталях, но несколько довольно идей о том, почему я использовал это.

1. Распаковывается в кортеж, который сообщает вам, существовал объект или нет. Это часто может быть полезно в вашем рабочем процессе.

2. Функция дает возможность работать с @classmethodдекорированными функциями создателя (и специфичными для них атрибутами).

3. Решение защищает от условий гонки, когда к хранилищу данных подключено более одного процесса.

РЕДАКТИРОВАТЬ: я изменился session.commit()на session.flush()как объяснено в этом сообщении в блоге . Обратите внимание, что эти решения зависят от используемого хранилища данных (в данном случае Postgres).

РЕДАКТИРОВАТЬ 2: Я обновил, используя {} в качестве значения по умолчанию в функции, так как это типичная ошибка Python. Спасибо за комментарий , Найджел! Если вам интересно узнать об этом, проверьте этот вопрос StackOverflow и этот пост в блоге .

Модифицированная версия отличного ответа Эрика

def get_one_or_create(session,
                      model,
                      create_method='',
                      create_method_kwargs=None,
                      **kwargs):
    try:
        return session.query(model).filter_by(**kwargs).one(), True
    except NoResultFound:
        kwargs.update(create_method_kwargs or {})
        try:
            with session.begin_nested():
                created = getattr(model, create_method, model)(**kwargs)
                session.add(created)
            return created, False
        except IntegrityError:
            return session.query(model).filter_by(**kwargs).one(), True

• Используйте вложенную транзакцию, чтобы откатить только добавление нового элемента, а не откат всего (см. Этот ответ, чтобы использовать вложенные транзакции с SQLite)
• Переместить create_method. Если созданный объект имеет отношения и ему назначаются члены через эти отношения, он автоматически добавляется в сеанс. Например, создайте a book, который имеет user_idи userкак соответствующие отношения, затем выполнение book.user=<user object>внутри create_methodдобавит bookк сеансу. Это означает, что create_methodдолжно быть внутри, withчтобы извлечь выгоду из возможного отката. Обратите внимание, что begin_nestedавтоматически запускается сброс.

Обратите внимание, что при использовании MySQL уровень изоляции транзакции должен быть установлен, READ COMMITTEDа не REPEATABLE READчтобы это работало. Get_or_create в Django (и здесь ) использует ту же стратегию, см. Также документацию по Django .

Это рецепт SQLALchemy делает работу красивой и элегантной.

Первое, что нужно сделать, это определить функцию, которой назначен Session для работы, и связать словарь с Session (), который отслеживает текущие уникальные ключи.

def _unique(session, cls, hashfunc, queryfunc, constructor, arg, kw):
    cache = getattr(session, '_unique_cache', None)
    if cache is None:
        session._unique_cache = cache = {}

    key = (cls, hashfunc(*arg, **kw))
    if key in cache:
        return cache[key]
    else:
        with session.no_autoflush:
            q = session.query(cls)
            q = queryfunc(q, *arg, **kw)
            obj = q.first()
            if not obj:
                obj = constructor(*arg, **kw)
                session.add(obj)
        cache[key] = obj
        return obj

Пример использования этой функции был бы в mixin:

class UniqueMixin(object):
    @classmethod
    def unique_hash(cls, *arg, **kw):
        raise NotImplementedError()

    @classmethod
    def unique_filter(cls, query, *arg, **kw):
        raise NotImplementedError()

    @classmethod
    def as_unique(cls, session, *arg, **kw):
        return _unique(
                    session,
                    cls,
                    cls.unique_hash,
                    cls.unique_filter,
                    cls,
                    arg, kw
            )

И, наконец, создание уникальной модели get_or_create:

from sqlalchemy import Column, Integer, String, create_engine
from sqlalchemy.orm import sessionmaker
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

engine = create_engine('sqlite://', echo=True)

Session = sessionmaker(bind=engine)

class Widget(UniqueMixin, Base):
    __tablename__ = 'widget'

    id = Column(Integer, primary_key=True)
    name = Column(String, unique=True, nullable=False)

    @classmethod
    def unique_hash(cls, name):
        return name

    @classmethod
    def unique_filter(cls, query, name):
        return query.filter(Widget.name == name)

Base.metadata.create_all(engine)

session = Session()

w1, w2, w3 = Widget.as_unique(session, name='w1'), \
                Widget.as_unique(session, name='w2'), \
                Widget.as_unique(session, name='w3')
w1b = Widget.as_unique(session, name='w1')

assert w1 is w1b
assert w2 is not w3
assert w2 is not w1

session.commit()

Рецепт идет глубже в идею и предоставляет различные подходы, но я использовал этот с большим успехом.

Наиболее близким семантически, вероятно, является:

def get_or_create(model, **kwargs):
    """SqlAlchemy implementation of Django's get_or_create.
    """
    session = Session()
    instance = session.query(model).filter_by(**kwargs).first()
    if instance:
        return instance, False
    else:
        instance = model(**kwargs)
        session.add(instance)
        session.commit()
        return instance, True

не уверен, насколько кошерно полагаться на глобально определенный Session в sqlalchemy, но версия Django не требует подключения, так что ...

Возвращенный кортеж содержит экземпляр и логическое значение, указывающее, был ли создан экземпляр (т. Е. Это False, если мы читаем экземпляр из БД).

Django get_or_createчасто используется для обеспечения доступности глобальных данных, поэтому я делаю коммиты как можно раньше.

Я немного упростил @Kevin. решение, чтобы избежать оборачивания всей функции в оператор if/ else. Таким образом, есть только один return, который я считаю чище:

def get_or_create(session, model, **kwargs):
    instance = session.query(model).filter_by(**kwargs).first()

    if not instance:
        instance = model(**kwargs)
        session.add(instance)

    return instance

В зависимости от принятого вами уровня изоляции, ни одно из приведенных выше решений не будет работать. Лучшее решение, которое я нашел, - это RAW SQL в следующей форме:

INSERT INTO table(f1, f2, unique_f3) 
SELECT 'v1', 'v2', 'v3' 
WHERE NOT EXISTS (SELECT 1 FROM table WHERE f3 = 'v3')

Это транзакционно безопасно независимо от уровня изоляции и степени параллелизма.

Осторожно: чтобы сделать его эффективным, было бы разумно иметь ИНДЕКС для уникального столбца.