python - 使い - sqlalchemy 読み方




SQLAlchemyにはDjangoのget_or_createと同等の機能がありますか? (6)

@ 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

これで、私は自分のモデルの任意のオブジェクトをget_or_createできます。

私のモデルオブジェクトを以下のようにします:

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

オブジェクトを取得または作成するには、次のように記述します。

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

私は、すでに存在する場合(提供されたパラメータに基づいて)データベースからオブジェクトを取得したい場合、または存在しない場合は作成します。

Djangoのget_or_create (またはsource )がこれを行います。 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

このSQLALchemyレシピは、すばらしい優雅な仕事をします。

最初に行うべきことは、動作するセッションが与えられている関数を定義し、現在の一意のキーを追跡する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

この機能を利用する例は、ミックスインにあります:

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()

レシピはアイデアの深いところに入り、さまざまなアプローチを提供しますが、私はこれを大きな成功を収めて使用しました。


エリクの優れたanswerの修正版

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でネストされたトランザクションを使用するにはこのanswerを参照してください)
  • create_method移動しcreate_method 。 作成されたオブジェクトにリレーションがあり、リレーションを介してメンバーが割り当てられている場合は、自動的にセッションに追加されます。 例えば、対応する関係としてuser_iduserを持つbook作成すると、 book.user=<user object>create_methodすることで、 bookがセッションに追加されます。 つまり、最終的なロールバックの恩恵を受けるには、 create_methodがinside withなければなりません。 begin_nested自動的にフラッシュをトリガーすることに注意してください。

MySQLを使用している場合、トランザクション分離レベルはREPEATABLE READではなくREAD COMMITTED設定されていなければならないことに注意してください。 Djangoのget_or_create (そしてhere )は同じget_or_create使いhere get_or_create documentationも参照してください。


意味的に最も近いのはおそらく次のようなものです:

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

sqlalchemyでグローバルに定義されたSessionにどのように頼るのか正直ではありませんが、Djangoのバージョンでは接続できません。

返されるタプルには、インスタンスと、インスタンスが作成されたかどうかを示すブール値が含まれます(つまり、インスタンスをdbから読み込むとFalseです)。

Djangoのget_or_createは、グローバルデータが利用可能であることを確認するためによく使われるので、できるだけ早くコミットします。


私は@ケビンをやや簡略化した。 if / elseステートメントで関数全体をラップするのを避けるためのソリューションelse 。 このようにして、 returnは1つしかありません。

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

私はこの問題に取り組んできましたが、かなり頑強な解決策に終わったのです。

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@classmethodされた作成者関数(およびそれらに固有の属性)を@classmethodことができます。

  3. このソリューションは、データストアに複数のプロセスが接続されている場合、競合条件を保護します。

編集:私はsession.commit()このブログの記事で説明したようにsession.commit()を変更しました。 これらの決定は、使用されるデータストア(この場合はPostgres)に固有のものであることに注意してください。

編集2:これは典型的なPythonの問題であるので、{}を関数のデフォルト値として使用して更新しました。 コメントありがとう、ナイジェル! あなたの興味があったらこのの質問このブログ記事をチェックしてください。





sqlalchemy