关联代理

associationproxy 用于跨关系创建目标属性的读/写视图。它本质上隐藏了在两个端点之间使用“middle”属性，并可用于从相关对象集合中挑选字段，或减少使用关联对象模式的冗长性。通过创造性地应用，关联代理允许构建几乎所有几何图形的复杂集合和字典视图，并使用标准的、透明配置的关系模式持久化到数据库中。

简化标量集合

考虑两个类之间的多对多映射， User 和 Keyword .每个 User 可以有任何数量的 Keyword 对象，反之亦然（多对多模式在 多对多 ）：

from sqlalchemy import Column, Integer, String, ForeignKey, Table
from sqlalchemy.orm import declarative_base, relationship

Base = declarative_base()

class User(Base):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String(64))
    kw = relationship("Keyword", secondary=lambda: userkeywords_table)

    def __init__(self, name):
        self.name = name

class Keyword(Base):
    __tablename__ = 'keyword'
    id = Column(Integer, primary_key=True)
    keyword = Column('keyword', String(64))

    def __init__(self, keyword):
        self.keyword = keyword

userkeywords_table = Table('userkeywords', Base.metadata,
    Column('user_id', Integer, ForeignKey("user.id"),
           primary_key=True),
    Column('keyword_id', Integer, ForeignKey("keyword.id"),
           primary_key=True)
)

读取和操作与 User 需要从每个集合元素遍历到 .keyword 属性，这可能会很尴尬：

>>> user = User('jek')
>>> user.kw.append(Keyword('cheese inspector'))
>>> print(user.kw)
[<__main__.Keyword object at 0x12bf830>]
>>> print(user.kw[0].keyword)
cheese inspector
>>> print([keyword.keyword for keyword in user.kw])
['cheese inspector']

这个 association_proxy 应用于 User 类生成的“视图” kw 关系，它只公开 .keyword 与每个 Keyword 对象：

from sqlalchemy.ext.associationproxy import association_proxy

class User(Base):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String(64))
    kw = relationship("Keyword", secondary=lambda: userkeywords_table)

    def __init__(self, name):
        self.name = name

    # proxy the 'keyword' attribute from the 'kw' relationship
    keywords = association_proxy('kw', 'keyword')

我们现在可以参考 .keywords 集合作为字符串列表，既可读又可写。新的 Keyword 对象是透明地为我们创建的：

>>> user = User('jek')
>>> user.keywords.append('cheese inspector')
>>> user.keywords
['cheese inspector']
>>> user.keywords.append('snack ninja')
>>> user.kw
[<__main__.Keyword object at 0x12cdd30>, <__main__.Keyword object at 0x12cde30>]

这个 AssociationProxy 对象生成的 association_proxy() 函数是 Python descriptor 。它始终使用要映射的用户定义类声明，而不管是通过 mapper() 函数被使用。

代理通过对底层映射属性或集合进行操作来响应操作，以及通过代理所做的更改，在映射属性中立即可见，反之亦然。基础属性保持完全可访问。

首次访问时，关联代理对目标集合执行自省操作，以便其行为正确对应。详细信息，例如本地代理属性是集合（通常是这样）还是标量引用，以及集合的行为是否类似于集合、列表或字典，以便代理的行为与基础集合或属性的行为相同。

创造新的价值观

当关联代理截获一个list append（）事件（或set add（）、dictionary_u setitem_uuuu（）或scalar assignment事件）时，它使用其构造函数实例化一个“中间”对象的新实例，将给定值作为单个参数传递。在上面的示例中，一个操作如下：

user.keywords.append('cheese inspector')

由关联代理转换为操作：：

user.kw.append(Keyword('cheese inspector'))

这个例子在这里有效，因为我们已经为 Keyword 接受一个位置参数， keyword . 对于单参数构造函数不可行的情况，可以使用 creator 参数，它引用一个可调用的（即python函数），该函数将在给定奇异参数的情况下生成一个新的对象实例。下面我们使用lambda来说明这一点，这是典型的：

class User(Base):
    # ...

    # use Keyword(keyword=kw) on append() events
    keywords = association_proxy('kw', 'keyword',
                    creator=lambda kw: Keyword(keyword=kw))

这个 creator 函数在基于列表或集合的集合或标量属性的情况下接受单个参数。对于基于字典的集合，它接受两个参数“key”和“value”。下面的示例 代理到基于字典的集合 .

简化关联对象

“关联对象”模式是多对多关系的一种扩展形式，其描述如下： 关联对象 . 关联代理对于在正常使用期间防止“关联对象”妨碍使用非常有用。

假设我们 userkeywords 上面的表有一些额外的列，我们希望显式映射这些列，但在大多数情况下，我们不需要直接访问这些属性。下面，我们演示了一个新的映射，它介绍了 UserKeyword 类，它映射到 userkeywords 表如前所示。此类添加了一个附加列 special_key ，我们偶尔想要访问的值，但在通常情况下不是。我们在 User 类称为 keywords 这将弥补 user_keywords 收藏 User 到 .keyword 每个属性都存在 UserKeyword ：：

from sqlalchemy import Column, Integer, String, ForeignKey
from sqlalchemy.ext.associationproxy import association_proxy
from sqlalchemy.orm import backref, declarative_base, relationship

Base = declarative_base()

class User(Base):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String(64))

    # association proxy of "user_keywords" collection
    # to "keyword" attribute
    keywords = association_proxy('user_keywords', 'keyword')

    def __init__(self, name):
        self.name = name

class UserKeyword(Base):
    __tablename__ = 'user_keyword'
    user_id = Column(Integer, ForeignKey('user.id'), primary_key=True)
    keyword_id = Column(Integer, ForeignKey('keyword.id'), primary_key=True)
    special_key = Column(String(50))

    # bidirectional attribute/collection of "user"/"user_keywords"
    user = relationship(User,
                backref=backref("user_keywords",
                                cascade="all, delete-orphan")
            )

    # reference to the "Keyword" object
    keyword = relationship("Keyword")

    def __init__(self, keyword=None, user=None, special_key=None):
        self.user = user
        self.keyword = keyword
        self.special_key = special_key

class Keyword(Base):
    __tablename__ = 'keyword'
    id = Column(Integer, primary_key=True)
    keyword = Column('keyword', String(64))

    def __init__(self, keyword):
        self.keyword = keyword

    def __repr__(self):
        return 'Keyword(%s)' % repr(self.keyword)

通过上述配置，我们可以在 .keywords 每个的集合 User 对象，以及 UserKeyword 隐蔽：

>>> user = User('log')
>>> for kw in (Keyword('new_from_blammo'), Keyword('its_big')):
...     user.keywords.append(kw)
...
>>> print(user.keywords)
[Keyword('new_from_blammo'), Keyword('its_big')]

在上面，每个 .keywords.append() 操作等效于：

>>> user.user_keywords.append(UserKeyword(Keyword('its_heavy')))

这个 UserKeyword 关联对象在这里有两个填充的属性；关联对象 .keyword 由于传递 Keyword 对象作为第一个参数。这个 .user 然后将参数指定为 UserKeyword 对象附加到 User.user_keywords 集合，其中双向关系配置在 User.user_keywords 和 UserKeyword.user 结果在一个群体中 UserKeyword.user 属性。这个 special_key 上面的参数的默认值为 None .

在我们想要的情况下 special_key 为了有价值，我们创造 UserKeyword 对象。下面我们将分配所有三个属性，其中 .user 具有 UserKeyword 被附加到 User.user_keywords 收藏：

>>> UserKeyword(Keyword('its_wood'), user, special_key='my special key')

关联代理向我们返回 Keyword 所有这些操作表示的对象：

>>> user.keywords
[Keyword('new_from_blammo'), Keyword('its_big'), Keyword('its_heavy'), Keyword('its_wood')]

代理到基于字典的集合

关联代理也可以代理到基于字典的集合。SQLAlchemy映射通常使用 attribute_mapped_collection() 用于创建字典集合的集合类型，以及中描述的扩展技术 自定义基于词典的集合 .

关联代理在检测到基于字典的集合的使用时调整其行为。当新值添加到字典中时，关联代理通过将两个参数传递给创建函数而不是一个参数（键和值）来实例化中间对象。和往常一样，这个创建函数默认为中间类的构造函数，并且可以使用 creator 争论。

下面，我们修改了 UserKeyword 示例如下： User.user_keywords 现在将使用字典映射集合，其中 UserKeyword.special_key 参数将用作字典的键。然后我们应用 creator 论据 User.keywords 代理，以便在将新元素添加到字典时适当地分配这些值：：

from sqlalchemy import Column, Integer, String, ForeignKey
from sqlalchemy.ext.associationproxy import association_proxy
from sqlalchemy.orm import backref, declarative_base, relationship
from sqlalchemy.orm.collections import attribute_mapped_collection

Base = declarative_base()

class User(Base):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String(64))

    # proxy to 'user_keywords', instantiating UserKeyword
    # assigning the new key to 'special_key', values to
    # 'keyword'.
    keywords = association_proxy('user_keywords', 'keyword',
                    creator=lambda k, v:
                                UserKeyword(special_key=k, keyword=v)
                )

    def __init__(self, name):
        self.name = name

class UserKeyword(Base):
    __tablename__ = 'user_keyword'
    user_id = Column(Integer, ForeignKey('user.id'), primary_key=True)
    keyword_id = Column(Integer, ForeignKey('keyword.id'), primary_key=True)
    special_key = Column(String)

    # bidirectional user/user_keywords relationships, mapping
    # user_keywords with a dictionary against "special_key" as key.
    user = relationship(User, backref=backref(
                    "user_keywords",
                    collection_class=attribute_mapped_collection("special_key"),
                    cascade="all, delete-orphan"
                    )
                )
    keyword = relationship("Keyword")

class Keyword(Base):
    __tablename__ = 'keyword'
    id = Column(Integer, primary_key=True)
    keyword = Column('keyword', String(64))

    def __init__(self, keyword):
        self.keyword = keyword

    def __repr__(self):
        return 'Keyword(%s)' % repr(self.keyword)

我们举例说明 .keywords 集合作为字典，映射 UserKeyword.special_key 价值到 Keyword 物体：：

>>> user = User('log')

>>> user.keywords['sk1'] = Keyword('kw1')
>>> user.keywords['sk2'] = Keyword('kw2')

>>> print(user.keywords)
{'sk1': Keyword('kw1'), 'sk2': Keyword('kw2')}

复合关联代理

在前面的示例中，从关系代理到标量属性、跨关联对象代理和代理字典，我们可以将这三种技术结合起来 User 一 keywords 严格处理字符串值的字典 special_key 映射到字符串 keyword . 两个 UserKeyword 和 Keyword 课程是完全隐藏的。这是通过在上建立关联代理来实现的 User 指出现在 UserKeyword ：：

from sqlalchemy import Column, Integer, String, ForeignKey
from sqlalchemy.ext.associationproxy import association_proxy
from sqlalchemy.orm import backref, declarative_base, relationship
from sqlalchemy.orm.collections import attribute_mapped_collection

Base = declarative_base()

class User(Base):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String(64))

    # the same 'user_keywords'->'keyword' proxy as in
    # the basic dictionary example.
    keywords = association_proxy(
        'user_keywords',
        'keyword',
        creator=lambda k, v: UserKeyword(special_key=k, keyword=v)
    )

    # another proxy that is directly column-targeted
    special_keys = association_proxy("user_keywords", "special_key")

    def __init__(self, name):
        self.name = name

class UserKeyword(Base):
    __tablename__ = 'user_keyword'
    user_id = Column(ForeignKey('user.id'), primary_key=True)
    keyword_id = Column(ForeignKey('keyword.id'), primary_key=True)
    special_key = Column(String)
    user = relationship(
        User,
        backref=backref(
            "user_keywords",
            collection_class=attribute_mapped_collection("special_key"),
            cascade="all, delete-orphan"
        )
    )

    # the relationship to Keyword is now called
    # 'kw'
    kw = relationship("Keyword")

    # 'keyword' is changed to be a proxy to the
    # 'keyword' attribute of 'Keyword'
    keyword = association_proxy('kw', 'keyword')

class Keyword(Base):
    __tablename__ = 'keyword'
    id = Column(Integer, primary_key=True)
    keyword = Column('keyword', String(64))

    def __init__(self, keyword):
        self.keyword = keyword

User.keywords 现在是字符串到字符串的字典，其中 UserKeyword 和 Keyword 使用关联代理为我们透明地创建和删除对象。在下面的示例中，我们演示了赋值运算符的用法，它也是由关联代理适当处理的，可以立即将字典值应用于集合：

>>> user = User('log')
>>> user.keywords = {
...     'sk1':'kw1',
...     'sk2':'kw2'
... }
>>> print(user.keywords)
{'sk1': 'kw1', 'sk2': 'kw2'}

>>> user.keywords['sk3'] = 'kw3'
>>> del user.keywords['sk2']
>>> print(user.keywords)
{'sk1': 'kw1', 'sk3': 'kw3'}

>>> # illustrate un-proxied usage
... print(user.user_keywords['sk3'].kw)
<__main__.Keyword object at 0x12ceb90>

上面示例的一个警告是，因为 Keyword 对象是为每个字典集操作创建的，因此该示例无法维护 Keyword 对象的字符串名称，这是像这样的标记场景的典型要求。对于此用例，食谱 UniqueObject 或类似的创建策略，该策略将“先查找，然后创建”策略应用于 Keyword 类，以便现有的 Keyword 如果给定的名称已经存在，则返回。

使用关联代理查询

这个 AssociationProxy 具有简单的SQL构造功能，这些功能在类级别的工作方式与其他ORM映射属性类似。类绑定属性，例如 User.keywords 和 User.special_keys 在前面的示例中，将提供在类级别访问时的SQL生成构造。

注解

关联代理扩展的主要目的是允许使用已加载的映射对象实例改进持久性和对象访问模式。类绑定查询特性的用途是有限的，在使用联接、预先加载选项等构造SQL查询时，不能取代引用底层属性的需要。

生成的SQL采用针对EXISTS SQL运算符的相关子查询的形式，这样就可以在WHERE子句中使用它，而无需对封闭查询进行其他修改。如果关联代理的直接目标是 映射列表达式 ，可以使用将嵌入子查询中的标准列运算符。例如，直线相等运算符：

>>> print(session.query(User).filter(User.special_keys == "jek"))
SELECT "user".id AS user_id, "user".name AS user_name
FROM "user"
WHERE EXISTS (SELECT 1
FROM user_keyword
WHERE "user".id = user_keyword.user_id AND user_keyword.special_key = :special_key_1)

一个相似的接线员：

>>> print(session.query(User).filter(User.special_keys.like("%jek")))
SELECT "user".id AS user_id, "user".name AS user_name
FROM "user"
WHERE EXISTS (SELECT 1
FROM user_keyword
WHERE "user".id = user_keyword.user_id AND user_keyword.special_key LIKE :special_key_1)

对于直接目标为 相关对象或集合，或相关对象上的其他关联代理或属性 ，可以改为使用面向关系的运算符，例如 PropComparator.has() 和 PropComparator.any() . 这个 User.keywords 属性实际上是链接在一起的两个关联代理，因此当使用此代理生成SQL短语时，我们得到两个级别的EXISTS子查询：

>>> print(session.query(User).filter(User.keywords.any(Keyword.keyword == "jek")))
SELECT "user".id AS user_id, "user".name AS user_name
FROM "user"
WHERE EXISTS (SELECT 1
FROM user_keyword
WHERE "user".id = user_keyword.user_id AND (EXISTS (SELECT 1
FROM keyword
WHERE keyword.id = user_keyword.keyword_id AND keyword.keyword = :keyword_1)))

这不是最有效的SQL形式，因此，尽管关联代理可以方便地快速生成WHERE条件，但为了最佳使用，应该检查SQL结果并将其“展开”为显式连接条件，尤其是将关联代理链接在一起时。

在 1.3 版更改: 关联代理根据目标类型具有不同的查询模式。看到了吗 AssociationProxy现在为面向列的目标提供标准列运算符 .

级联标量删除

1.3 新版功能.

给定映射为：

class A(Base):
    __tablename__ = 'test_a'
    id = Column(Integer, primary_key=True)
    ab = relationship(
        'AB', backref='a', uselist=False)
    b = association_proxy(
        'ab', 'b', creator=lambda b: AB(b=b),
        cascade_scalar_deletes=True)


class B(Base):
    __tablename__ = 'test_b'
    id = Column(Integer, primary_key=True)
    ab = relationship('AB', backref='b', cascade='all, delete-orphan')


class AB(Base):
    __tablename__ = 'test_ab'
    a_id = Column(Integer, ForeignKey(A.id), primary_key=True)
    b_id = Column(Integer, ForeignKey(B.id), primary_key=True)

分配给 A.b 将生成一个 AB 对象：

a.b = B()

这个 A.b 关联是标量的，包括对标志的使用 AssociationProxy.cascade_scalar_deletes . 设置时，设置 A.b 到 None 将移除 A.ab 也：：

a.b = None
assert a.ab is None

什么时候？ AssociationProxy.cascade_scalar_deletes 未设置，关联对象 a.ab 以上将保持不变。

请注意，这不是基于集合的关联代理的行为；在这种情况下，当移除代理集合的成员时，始终移除中间关联对象。是否删除行取决于关系级联设置。

参见

级联

API文档

function sqlalchemy.ext.associationproxy.association_proxy(target_collection, attr, **kw)¶

返回一个python属性，该属性实现一个目标属性的视图，该视图引用目标成员上的属性。

返回的值是的实例 AssociationProxy .

实现一个python属性，将关系表示为简单值或标量值的集合。代理属性将模拟目标的集合类型（list、dict或set），或者在一对一关系的情况下，模拟简单的标量值。

参数

• target_collection¶ -- 将代理到的属性的名称。此属性通常由 relationship() 链接到目标集合，但也可以是多对一或非标量关系。

• attr¶ -- 我们将代理的一个或多个关联实例的属性。例如，给定一个目标集合 [Obj1，Obj2] ，此代理属性创建的列表如下 [getattr(obj1, attr), getattr(obj2, attr)] 如果关系是一对一或其他uselist=false，那么只需：getattr（obj， attr ）

• creator¶ -- 可选的。将新项添加到此代理集合时，将创建由目标集合收集的类的新实例。对于列表和集合集合，将使用新实例的“value”调用目标类构造函数。对于dict类型，传递两个参数：key和value。如果要以不同的方式构造实例，请提供 造物主 函数，它接受上述参数并返回实例。对于标量关系，如果目标为“无”，则将调用creator（）。如果目标存在，则在关联的对象上将set操作代理为setattr（）。如果有一个具有多个属性的关联对象，则可以设置映射到不同属性的多个关联代理。有关示例，请参见单元测试，以及有关如何使用creator（）函数在这种情况下按需构造标量关系的示例。

• **kw¶ -- 将任何其他关键字参数传递给 AssociationProxy .

class sqlalchemy.ext.associationproxy.AssociationProxy(target_collection, attr, creator=None, getset_factory=None, proxy_factory=None, proxy_bulk_set=None, info=None, cascade_scalar_deletes=False)¶

表示对象属性的读/写视图的描述符。

类签名

class sqlalchemy.ext.associationproxy.AssociationProxy (sqlalchemy.orm.base.InspectionAttrInfo)

method sqlalchemy.ext.associationproxy.AssociationProxy.__init__(target_collection, attr, creator=None, getset_factory=None, proxy_factory=None, proxy_bulk_set=None, info=None, cascade_scalar_deletes=False)¶

构建新的 AssociationProxy .

这个 association_proxy() 不过，函数在这里作为通常的入口点提供 AssociationProxy 可以直接实例化和/或子类化。

参数

• target_collection¶ -- 我们要代理的集合的名称，通常使用 relationship() .

• attr¶ -- 我们将代理的已收集实例的属性。例如，给定一个目标集合 [Obj1，Obj2] ，此代理属性创建的列表如下 [getattr（obj1，attr），getattr（obj2，attr）]

• creator¶ -- 可选的。将新项添加到此代理集合时，将创建由目标集合收集的类的新实例。对于列表和集合集合，将使用新实例的“value”调用目标类构造函数。对于dict类型，传递两个参数：key和value。如果要以不同的方式构造实例，请提供一个“creator”函数，该函数接受上述参数并返回实例。

• cascade_scalar_deletes¶ -- 如果为真，则指示将代理值设置为 None ，或通过删除 del ，还应删除源对象。仅适用于标量属性。通常，删除代理目标不会删除代理源，因为此对象可能具有其他仍要保留的状态。…添加的版本：1.3..参阅： 级联标量删除 -完整用法示例

• getset_factory¶ -- 可选的。代理属性访问由基于 attr 此代理的参数。如果要自定义此行为，可以提供 getset_factory 可调用，产生一个元组 getter 和 setter 功能。使用两个参数调用工厂，即基础集合的抽象类型和此代理实例。

• proxy_factory¶ -- 可选的。要模拟的集合类型是通过嗅探目标集合来确定的。如果您的集合类型不能通过duck类型来确定，或者您希望使用不同的集合实现，那么您可以提供一个工厂函数来生成这些集合。仅适用于非标量关系。

• proxy_bulk_set¶ -- 可选，与代理工厂一起使用。有关详细信息，请参阅_set（）方法。

• info¶ -- 可选，将分配给 AssociationProxy.info 如果存在。…添加的版本：1.0.9

attribute sqlalchemy.ext.associationproxy.AssociationProxy.extension_type = symbol('ASSOCIATION_PROXY')¶

分机类型(如果有)。默认为 NOT_EXTENSION

参见

HYBRID_METHOD

HYBRID_PROPERTY

ASSOCIATION_PROXY

method sqlalchemy.ext.associationproxy.AssociationProxy.for_class(class_, obj=None)¶

返回特定映射类的本地内部状态。

例如，给一个班 User ：：

class User(Base):
    # ...

    keywords = association_proxy('kws', 'keyword')

如果我们访问这个 AssociationProxy 从 Mapper.all_orm_descriptors ，我们希望查看由映射的此代理的目标类 User ：：

inspect(User).all_orm_descriptors["keywords"].for_class(User).target_class

这将返回 AssociationProxyInstance 这是特定于 User 班级。这个 AssociationProxy 对象仍不可知其父类。

参数

• class_¶ -- 我们返回状态的类。

• obj¶ -- 可选，如果属性引用多态目标（例如，我们必须查看实际目标对象的类型才能获得完整路径），则需要的类实例。

1.3 新版功能: - AssociationProxy no longer stores any state specific to a particular parent class; the state is now stored in per-class AssociationProxyInstance objects.

attribute sqlalchemy.ext.associationproxy.AssociationProxy.info¶

inherited from the InspectionAttrInfo.info attribute of InspectionAttrInfo

与对象关联的信息字典，允许用户定义的数据与此关联 InspectionAttr .

字典在第一次访问时生成。或者，可以将其指定为 column_property() ， relationship() 或 composite() 功能。

在 1.0.0 版更改: MapperProperty.info 也可以通过 InspectionAttrInfo.info 属性，以便它可以应用于更广泛的ORM和扩展构造。

参见

QueryableAttribute.info

SchemaItem.info

attribute sqlalchemy.ext.associationproxy.AssociationProxy.is_aliased_class = False¶

inherited from the InspectionAttr.is_aliased_class attribute of InspectionAttr

如果此对象是 AliasedClass 。

attribute sqlalchemy.ext.associationproxy.AssociationProxy.is_attribute = True¶

如果此对象是Python，则为True descriptor 。

这可以指许多类型中的一种。通常情况下， QueryableAttribute 它代表 MapperProperty 。但也可以是扩展类型，如 AssociationProxy 或 hybrid_property 。这个 InspectionAttr.extension_type 将引用标识特定子类型的常量。

参见

Mapper.all_orm_descriptors

attribute sqlalchemy.ext.associationproxy.AssociationProxy.is_bundle = False¶

inherited from the InspectionAttr.is_bundle attribute of InspectionAttr

如果此对象是 Bundle 。

attribute sqlalchemy.ext.associationproxy.AssociationProxy.is_clause_element = False¶

inherited from the InspectionAttr.is_clause_element attribute of InspectionAttr

如果此对象是 ClauseElement 。

attribute sqlalchemy.ext.associationproxy.AssociationProxy.is_instance = False¶

inherited from the InspectionAttr.is_instance attribute of InspectionAttr

如果此对象是 InstanceState 。

attribute sqlalchemy.ext.associationproxy.AssociationProxy.is_mapper = False¶

inherited from the InspectionAttr.is_mapper attribute of InspectionAttr

如果此对象是 Mapper 。

attribute sqlalchemy.ext.associationproxy.AssociationProxy.is_property = False¶

inherited from the InspectionAttr.is_property attribute of InspectionAttr

如果此对象是 MapperProperty 。

attribute sqlalchemy.ext.associationproxy.AssociationProxy.is_selectable = False¶

inherited from the InspectionAttr.is_selectable attribute of InspectionAttr

如果此对象是的实例，则返回True Selectable 。

class sqlalchemy.ext.associationproxy.AssociationProxyInstance(parent, owning_class, target_class, value_attr)¶

为特定于类和对象的结果提供服务的每个类对象。

这是由 AssociationProxy 当它以一个特定的类或类的实例来调用时，即当它被用作一个常规的Python描述符时。

当提到 AssociationProxy 作为普通的python描述符， AssociationProxyInstance 是实际服务于信息的对象。在正常情况下，其存在是透明的：

>>> User.keywords.scalar
False

在特殊情况下， AssociationProxy 正在直接访问对象，以便对 AssociationProxyInstance 使用 AssociationProxy.for_class() 方法：

proxy_state = inspect(User).all_orm_descriptors["keywords"].for_class(User)

# view if proxy object is scalar or not
>>> proxy_state.scalar
False

1.3 新版功能.

method sqlalchemy.ext.associationproxy.AssociationProxyInstance.any(criterion=None, **kwargs)¶

使用exists生成代理的“any”表达式。

此表达式将是使用 Comparator.any() 和/或 Comparator.has() 基本代理属性的运算符。

attribute sqlalchemy.ext.associationproxy.AssociationProxyInstance.attr¶

返回的元组 (local_attr, remote_attr) .

当使用 Query.join() 两种关系：

sess.query(Parent).join(*Parent.proxied.attr)

参见

AssociationProxyInstance.local_attr

AssociationProxyInstance.remote_attr

method sqlalchemy.ext.associationproxy.AssociationProxyInstance.delete(obj)¶

method sqlalchemy.ext.associationproxy.AssociationProxyInstance.classmethod for_proxy(parent, owning_class, parent_instance)¶

method sqlalchemy.ext.associationproxy.AssociationProxyInstance.get(obj)¶

method sqlalchemy.ext.associationproxy.AssociationProxyInstance.has(criterion=None, **kwargs)¶

使用exists生成代理的“has”表达式。

此表达式将是使用 Comparator.any() 和/或 Comparator.has() 基本代理属性的运算符。

attribute sqlalchemy.ext.associationproxy.AssociationProxyInstance.info¶

attribute sqlalchemy.ext.associationproxy.AssociationProxyInstance.local_attr¶

此引用的“local”类属性 AssociationProxyInstance .

参见

AssociationProxyInstance.attr

AssociationProxyInstance.remote_attr

attribute sqlalchemy.ext.associationproxy.AssociationProxyInstance.remote_attr¶

此引用的“remote”类属性 AssociationProxyInstance .

参见

AssociationProxyInstance.attr

AssociationProxyInstance.local_attr

attribute sqlalchemy.ext.associationproxy.AssociationProxyInstance.scalar¶

返回 True 如果这样 AssociationProxyInstance 在本地端代理一个标量关系。

method sqlalchemy.ext.associationproxy.AssociationProxyInstance.set(obj, values)¶

attribute sqlalchemy.ext.associationproxy.AssociationProxyInstance.target_class = None¶

这个处理的中介类 AssociationProxyInstance .

截获的append/set/assignment事件将导致生成此类的新实例。

class sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance(parent, owning_class, target_class, value_attr)¶

一个 AssociationProxyInstance 以对象为目标的。

类签名

class sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance (sqlalchemy.ext.associationproxy.AssociationProxyInstance)

method sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance.any(criterion=None, **kwargs)¶

inherited from the AssociationProxyInstance.any() method of AssociationProxyInstance

使用exists生成代理的“any”表达式。

此表达式将是使用 Comparator.any() 和/或 Comparator.has() 基本代理属性的运算符。

attribute sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance.attr¶

inherited from the AssociationProxyInstance.attr attribute of AssociationProxyInstance

返回的元组 (local_attr, remote_attr) .

当使用 Query.join() 两种关系：

sess.query(Parent).join(*Parent.proxied.attr)

参见

AssociationProxyInstance.local_attr

AssociationProxyInstance.remote_attr

method sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance.contains(obj)¶

使用exists生成代理的“contains”表达式。

此表达式将是使用 Comparator.any() ， Comparator.has() 和/或 Comparator.contains() 基本代理属性的运算符。

method sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance.has(criterion=None, **kwargs)¶

inherited from the AssociationProxyInstance.has() method of AssociationProxyInstance

使用exists生成代理的“has”表达式。

此表达式将是使用 Comparator.any() 和/或 Comparator.has() 基本代理属性的运算符。

attribute sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance.local_attr¶

inherited from the AssociationProxyInstance.local_attr attribute of AssociationProxyInstance

此引用的“local”类属性 AssociationProxyInstance .

参见

AssociationProxyInstance.attr

AssociationProxyInstance.remote_attr

attribute sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance.remote_attr¶

inherited from the AssociationProxyInstance.remote_attr attribute of AssociationProxyInstance

此引用的“remote”类属性 AssociationProxyInstance .

参见

AssociationProxyInstance.attr

AssociationProxyInstance.local_attr

attribute sqlalchemy.ext.associationproxy.ObjectAssociationProxyInstance.scalar¶

inherited from the AssociationProxyInstance.scalar attribute of AssociationProxyInstance

返回 True 如果这样 AssociationProxyInstance 在本地端代理一个标量关系。

class sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance(parent, owning_class, target_class, value_attr)¶

一个 AssociationProxyInstance 以数据库列为目标的。

类签名

class sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance (sqlalchemy.sql.expression.ColumnOperators, sqlalchemy.ext.associationproxy.AssociationProxyInstance)

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.__le__(other)¶

inherited from the sqlalchemy.sql.expression.ColumnOperators.__le__ method of ColumnOperators

实施 <= 操作员。

在列上下文中，生成子句 a <= b .

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.__lt__(other)¶

inherited from the sqlalchemy.sql.expression.ColumnOperators.__lt__ method of ColumnOperators

实施 < 操作员。

在列上下文中，生成子句 a < b .

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.__ne__(other)¶

inherited from the sqlalchemy.sql.expression.ColumnOperators.__ne__ method of ColumnOperators

实施 != 操作员。

在列上下文中，生成子句 a != b . 如果目标是 None 生产 a IS NOT NULL .

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.all_()¶

inherited from the ColumnOperators.all_() method of ColumnOperators

制作一个 all_() 子句对父对象执行操作。

请参阅的文档 all_() 举个例子。

注解

一定不要把新的弄糊涂了 ColumnOperators.all_() 方法及其较旧的 ARRAY -特定的对应方，即 Comparator.all() 方法，该方法使用不同的调用语法和使用模式。

1.1 新版功能.

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.any(criterion=None, **kwargs)¶

inherited from the AssociationProxyInstance.any() method of AssociationProxyInstance

使用exists生成代理的“any”表达式。

此表达式将是使用 Comparator.any() 和/或 Comparator.has() 基本代理属性的运算符。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.any_()¶

inherited from the ColumnOperators.any_() method of ColumnOperators

制作一个 any_() 子句对父对象执行操作。

请参阅的文档 any_() 举个例子。

注解

一定不要把新的弄糊涂了 ColumnOperators.any_() 方法及其较旧的 ARRAY -特定的对应方，即 Comparator.any() 方法，该方法使用不同的调用语法和使用模式。

1.1 新版功能.

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.asc()¶

inherited from the ColumnOperators.asc() method of ColumnOperators

产生一个 asc() 针对父对象的子句。

attribute sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.attr¶

inherited from the AssociationProxyInstance.attr attribute of AssociationProxyInstance

返回的元组 (local_attr, remote_attr) .

当使用 Query.join() 两种关系：

sess.query(Parent).join(*Parent.proxied.attr)

参见

AssociationProxyInstance.local_attr

AssociationProxyInstance.remote_attr

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.between(cleft, cright, symmetric=False)¶

inherited from the ColumnOperators.between() method of ColumnOperators

产生一个 between() 在给定上下限的情况下，针对父对象的子句。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.bool_op(opstring, precedence=0)¶

inherited from the Operators.bool_op() method of Operators

返回自定义布尔运算符。

这个方法是调用 Operators.op() 并通过 Operators.op.is_comparison 标记为真。

参见

Operators.op()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.collate(collation)¶

inherited from the ColumnOperators.collate() method of ColumnOperators

产生一个 collate() 在给定排序规则字符串的情况下，对父对象执行子句。

参见

collate()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.concat(other)¶

inherited from the ColumnOperators.concat() method of ColumnOperators

实现“concat”运算符。

在列上下文中，生成子句 a || b 或使用 concat() mysql上的操作符。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.contains(other, **kwargs)¶

inherited from the ColumnOperators.contains() method of ColumnOperators

实现“contains”运算符。

生成一个类似表达式，该表达式根据字符串值中间的匹配项进行测试：

column LIKE '%' || <other> || '%'

例如。：：

stmt = select(sometable).\
    where(sometable.c.column.contains("foobar"))

因为操作员使用 LIKE ，通配符 "%" 和 "_" 存在于<other>表达式中的也将表现为通配符。对于文本字符串值， ColumnOperators.contains.autoescape 标志可以设置为 True 将转义应用于字符串值中出现的这些字符，以便它们与自身匹配，而不是作为通配符匹配。或者， ColumnOperators.contains.escape 参数将建立一个给定字符作为转义字符，当目标表达式不是文本字符串时可以使用该字符。

参数

• other¶ -- 要比较的表达式。这通常是一个纯字符串值，但也可以是任意的SQL表达式。类似通配符 % 和 _ 默认情况下不转义，除非 ColumnOperators.contains.autoescape 标志设置为真。

• autoescape¶ -- 布尔值；如果为true，则在like表达式中建立转义符，然后将其应用于 "%" ， "_" 以及比较值中的转义字符本身，该值被假定为文本字符串而不是SQL表达式。例如：：somecolumn.包含（“foo%bar”，autoescape=True）将呈现为：：somecolumn，如“%”| |：param |‘%‘ESCAPE’/”，值为 :param 作为 "foo/%bar" .

• escape¶ -- 一个字符，当给定时将用 ESCAPE 关键字将该字符建立为转义字符。然后可以将此字符置于 % 和 _ 允许它们充当自己而不是通配符。表达式如：：somecolumn.contains（“foo/%bar”，escape=“^”）将呈现为：：somecolumn，如“%”。|| :param || '%' ESCAPE '^' The parameter may also be combined with ColumnOperators.contains.autoescape ：：someColumn.contains（“foo%bar^bat”，escape=“^”，autoescape=true），其中，给定的文本参数将转换为 "foo^%bar^^bat" 在被传递到数据库之前。

参见

ColumnOperators.startswith()

ColumnOperators.endswith()

ColumnOperators.like()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.desc()¶

inherited from the ColumnOperators.desc() method of ColumnOperators

产生一个 desc() 针对父对象的子句。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.distinct()¶

inherited from the ColumnOperators.distinct() method of ColumnOperators

产生一个 distinct() 针对父对象的子句。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.endswith(other, **kwargs)¶

inherited from the ColumnOperators.endswith() method of ColumnOperators

实现“endswith”运算符。

生成一个类似表达式，该表达式根据字符串值末尾的匹配项进行测试：

column LIKE '%' || <other>

例如。：：

stmt = select(sometable).\
    where(sometable.c.column.endswith("foobar"))

因为操作员使用 LIKE ，通配符 "%" 和 "_" 存在于<other>表达式中的也将表现为通配符。对于文本字符串值， ColumnOperators.endswith.autoescape 标志可以设置为 True 将转义应用于字符串值中出现的这些字符，以便它们与自身匹配，而不是作为通配符匹配。或者， ColumnOperators.endswith.escape 参数将建立一个给定字符作为转义字符，当目标表达式不是文本字符串时可以使用该字符。

参数

• other¶ -- 要比较的表达式。这通常是一个纯字符串值，但也可以是任意的SQL表达式。类似通配符 % 和 _ 默认情况下不转义，除非 ColumnOperators.endswith.autoescape 标志设置为真。

• autoescape¶ -- 布尔值；如果为true，则在like表达式中建立转义符，然后将其应用于 "%" ， "_" 以及比较值中的转义字符本身，该值被假定为文本字符串而不是SQL表达式。例如：：somecolumn.endswith（“foo%bar”，autoescape=True）将呈现为：：somecolumn，如“%”| |：param ESCAPE“/”值为 :param 作为 "foo/%bar" .

• escape¶ -- 一个字符，当给定时将用 ESCAPE 关键字将该字符建立为转义字符。然后可以将此字符置于 % 和 _ 允许它们充当自己而不是通配符。表达式如：：somecolumn.endswith（“foo/%bar”，escape=“^”）将呈现为：：somecolumn，如“%”。|| :param ESCAPE '^' The parameter may also be combined with ColumnOperators.endswith.autoescape ：：someColumn.endsWith（“foo%bar^bat”，escape=“^”，autoescape=true），其中，给定的文本参数将转换为 "foo^%bar^^bat" 在被传递到数据库之前。

参见

ColumnOperators.startswith()

ColumnOperators.contains()

ColumnOperators.like()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.has(criterion=None, **kwargs)¶

inherited from the AssociationProxyInstance.has() method of AssociationProxyInstance

使用exists生成代理的“has”表达式。

此表达式将是使用 Comparator.any() 和/或 Comparator.has() 基本代理属性的运算符。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.ilike(other, escape=None)¶

inherited from the ColumnOperators.ilike() method of ColumnOperators

实施 ilike 运算符，例如不区分大小写的like。

在列上下文中，生成以下任一形式的表达式：

lower(a) LIKE lower(other)

或者在支持ilike运算符的后端：

a ILIKE other

例如。：：

stmt = select(sometable).\
    where(sometable.c.column.ilike("%foobar%"))

参数

• other¶ -- 要比较的表达式

• escape¶ -- 可选转义符，呈现 ESCAPE 关键字，例如：somecolumn.ilike（“foo/%bar”，escape=“/”）

参见

ColumnOperators.like()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.in_(other)¶

inherited from the ColumnOperators.in_() method of ColumnOperators

实施 in 操作员。

在列上下文中，生成子句 column IN <other> .

给定参数 other 可能是：

• 文字值列表，例如：

  stmt.where(column.in_([1, 2, 3]))

  在此调用表单中，项目列表将转换为一组与给定列表长度相同的绑定参数：

  WHERE COL IN (?, ?, ?)

• 如果比较与 tuple_() 包含多个表达式：

  from sqlalchemy import tuple_
  stmt.where(tuple_(col1, col2).in_([(1, 10), (2, 20), (3, 30)]))

• 空列表，例如：

  stmt.where(column.in_([]))

  在此调用形式中，表达式呈现“空集”表达式。这些表达式是针对各个后端量身定做的，通常会尝试将空的SELECT语句作为子查询。例如在SQLite上，表达式为：：

  WHERE col IN (SELECT 1 FROM (SELECT 1) WHERE 1!=1)

  在 1.4 版更改: 空IN表达式现在在所有情况下都使用生成的SELECT子查询的执行时间。

• 绑定参数，例如 bindparam() ，如果包含 bindparam.expanding 旗帜：

  stmt.where(column.in_(bindparam('value', expanding=True)))

  在此调用表单中，表达式呈现一个特殊的非SQL占位符表达式，其外观如下：

  WHERE COL IN ([EXPANDING_value])

  此占位符表达式在语句执行时被截取，以便转换为前面所示的绑定参数表单的变量号。如果语句的执行方式为：

  connection.execute(stmt, {"value": [1, 2, 3]})

  将为数据库传递每个值的绑定参数：

  WHERE COL IN (?, ?, ?)

  1.2 新版功能: 添加了“扩展”绑定参数

  如果传递空列表，将呈现一个特定于正在使用的数据库的特殊“空列表”表达式。在sqlite上：

  WHERE COL IN (SELECT 1 FROM (SELECT 1) WHERE 1!=1)

  1.3 新版功能: “expanding”绑定参数现在支持空列表

• 一 select() 构造，通常是相关的标量选择：

  stmt.where(
      column.in_(
          select(othertable.c.y).
          where(table.c.x == othertable.c.x)
      )
  )

  在这个调用表单中， ColumnOperators.in_() 按给定呈现：

  WHERE COL IN (SELECT othertable.y
  FROM othertable WHERE othertable.x = table.x)

参数

other¶ -- 文字列表，a select() 构造，或 bindparam() 构造，包括 bindparam.expanding 标志设置为真。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.is_(other)¶

inherited from the ColumnOperators.is_() method of ColumnOperators

实施 IS 操作员。

通常情况下， IS 与以下值比较时自动生成 None ，决定 NULL . 但是，明确使用 IS 如果与某些平台上的布尔值进行比较，可能是可取的。

参见

ColumnOperators.is_not()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.is_distinct_from(other)¶

inherited from the ColumnOperators.is_distinct_from() method of ColumnOperators

实施 IS DISTINCT FROM 操作员。

在大多数平台上呈现“a与b不同”；在某些平台上，例如sqlite可能呈现“a不是b”。

1.1 新版功能.

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.is_not(other)¶

inherited from the ColumnOperators.is_not() method of ColumnOperators

实施 IS NOT 操作员。

通常情况下， IS NOT 与以下值比较时自动生成 None ，决定 NULL . 但是，明确使用 IS NOT 如果与某些平台上的布尔值进行比较，可能是可取的。

在 1.4 版更改: 这个 is_not() 运算符重命名自 isnot() 在以前的版本中。以前的名称仍然可以向后兼容。

参见

ColumnOperators.is_()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.is_not_distinct_from(other)¶

inherited from the ColumnOperators.is_not_distinct_from() method of ColumnOperators

实施 IS NOT DISTINCT FROM 操作员。

在大多数平台上呈现“a与b不同”；在某些平台上，例如sqlite可能呈现“a是b”。

在 1.4 版更改: 这个 is_not_distinct_from() 运算符重命名自 isnot_distinct_from() 在以前的版本中。以前的名称仍然可以向后兼容。

1.1 新版功能.

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.isnot(other)¶

inherited from the ColumnOperators.isnot() method of ColumnOperators

实施 IS NOT 操作员。

通常情况下， IS NOT 与以下值比较时自动生成 None ，决定 NULL . 但是，明确使用 IS NOT 如果与某些平台上的布尔值进行比较，可能是可取的。

在 1.4 版更改: 这个 is_not() 运算符重命名自 isnot() 在以前的版本中。以前的名称仍然可以向后兼容。

参见

ColumnOperators.is_()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.isnot_distinct_from(other)¶

inherited from the ColumnOperators.isnot_distinct_from() method of ColumnOperators

实施 IS NOT DISTINCT FROM 操作员。

在大多数平台上呈现“a与b不同”；在某些平台上，例如sqlite可能呈现“a是b”。

在 1.4 版更改: 这个 is_not_distinct_from() 运算符重命名自 isnot_distinct_from() 在以前的版本中。以前的名称仍然可以向后兼容。

1.1 新版功能.

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.like(other, escape=None)¶

inherited from the ColumnOperators.like() method of ColumnOperators

实施 like 操作员。

在列上下文中，生成表达式：：

a LIKE other

例如。：：

stmt = select(sometable).\
    where(sometable.c.column.like("%foobar%"))

参数

• other¶ -- 要比较的表达式

• escape¶ -- 可选转义符，呈现 ESCAPE 关键字，例如：somecolumn.like（“foo/%bar”，escape=“/”）

参见

ColumnOperators.ilike()

attribute sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.local_attr¶

inherited from the AssociationProxyInstance.local_attr attribute of AssociationProxyInstance

此引用的“local”类属性 AssociationProxyInstance .

参见

AssociationProxyInstance.attr

AssociationProxyInstance.remote_attr

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.match(other, **kwargs)¶

inherited from the ColumnOperators.match() method of ColumnOperators

实现特定于数据库的“match”运算符。

ColumnOperators.match() 尝试解析为后端提供的类似匹配的函数或运算符。示例包括：

• PostgreSQL-呈现 x @@ to_tsquery(y)

• MySQL -渲染器 MATCH (x) AGAINST (y IN BOOLEAN MODE)

  参见

  match -具有附加功能的MySQL特定构造。

• Oracle-呈现 CONTAINS(x, y)

• 其他后端可能提供特殊的实现。

• 没有任何特殊实现的后端将发出“match”操作符。例如，这与sqlite兼容。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.not_ilike(other, escape=None)¶

inherited from the ColumnOperators.not_ilike() method of ColumnOperators

实施 NOT ILIKE 操作员。

这相当于使用否定 ColumnOperators.ilike() ，即 ~x.ilike(y) .

在 1.4 版更改: 这个 not_ilike() 运算符重命名自 notilike() 在以前的版本中。以前的名称仍然可以向后兼容。

参见

ColumnOperators.ilike()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.not_in(other)¶

inherited from the ColumnOperators.not_in() method of ColumnOperators

实施 NOT IN 操作员。

这相当于使用否定 ColumnOperators.in_() ，即 ~x.in_(y) .

在这种情况下 other 是一个空序列，编译器生成一个“empty not in”表达式。这将默认表达式“1=1”在所有情况下都生成“真”。这个 create_engine.empty_in_strategy 可用于更改此行为。

在 1.4 版更改: 这个 not_in() 运算符重命名自 notin_() 在以前的版本中。以前的名称仍然可以向后兼容。

在 1.2 版更改: 这个 ColumnOperators.in_() 和 ColumnOperators.not_in() 现在，默认情况下，运算符为空序列生成一个“静态”表达式。

参见

ColumnOperators.in_()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.not_like(other, escape=None)¶

inherited from the ColumnOperators.not_like() method of ColumnOperators

实施 NOT LIKE 操作员。

这相当于使用否定 ColumnOperators.like() ，即 ~x.like(y) .

在 1.4 版更改: 这个 not_like() 运算符重命名自 notlike() 在以前的版本中。以前的名称仍然可以向后兼容。

参见

ColumnOperators.like()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.notilike(other, escape=None)¶

inherited from the ColumnOperators.notilike() method of ColumnOperators

实施 NOT ILIKE 操作员。

这相当于使用否定 ColumnOperators.ilike() ，即 ~x.ilike(y) .

在 1.4 版更改: 这个 not_ilike() 运算符重命名自 notilike() 在以前的版本中。以前的名称仍然可以向后兼容。

参见

ColumnOperators.ilike()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.notin_(other)¶

inherited from the ColumnOperators.notin_() method of ColumnOperators

实施 NOT IN 操作员。

这相当于使用否定 ColumnOperators.in_() ，即 ~x.in_(y) .

在这种情况下 other 是一个空序列，编译器生成一个“empty not in”表达式。这将默认表达式“1=1”在所有情况下都生成“真”。这个 create_engine.empty_in_strategy 可用于更改此行为。

在 1.4 版更改: 这个 not_in() 运算符重命名自 notin_() 在以前的版本中。以前的名称仍然可以向后兼容。

在 1.2 版更改: 这个 ColumnOperators.in_() 和 ColumnOperators.not_in() 现在，默认情况下，运算符为空序列生成一个“静态”表达式。

参见

ColumnOperators.in_()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.notlike(other, escape=None)¶

inherited from the ColumnOperators.notlike() method of ColumnOperators

实施 NOT LIKE 操作员。

这相当于使用否定 ColumnOperators.like() ，即 ~x.like(y) .

在 1.4 版更改: 这个 not_like() 运算符重命名自 notlike() 在以前的版本中。以前的名称仍然可以向后兼容。

参见

ColumnOperators.like()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.nulls_first()¶

inherited from the ColumnOperators.nulls_first() method of ColumnOperators

产生一个 nulls_first() 针对父对象的子句。

在 1.4 版更改: 这个 nulls_first() 运算符重命名自 nullsfirst() 在以前的版本中。以前的名称仍然可以向后兼容。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.nulls_last()¶

inherited from the ColumnOperators.nulls_last() method of ColumnOperators

产生一个 nulls_last() 针对父对象的子句。

在 1.4 版更改: 这个 nulls_last() 运算符重命名自 nullslast() 在以前的版本中。以前的名称仍然可以向后兼容。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.nullsfirst()¶

inherited from the ColumnOperators.nullsfirst() method of ColumnOperators

产生一个 nulls_first() 针对父对象的子句。

在 1.4 版更改: 这个 nulls_first() 运算符重命名自 nullsfirst() 在以前的版本中。以前的名称仍然可以向后兼容。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.nullslast()¶

inherited from the ColumnOperators.nullslast() method of ColumnOperators

产生一个 nulls_last() 针对父对象的子句。

在 1.4 版更改: 这个 nulls_last() 运算符重命名自 nullslast() 在以前的版本中。以前的名称仍然可以向后兼容。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.op(opstring, precedence=0, is_comparison=False, return_type=None)¶

inherited from the Operators.op() method of Operators

生成泛型运算符函数。

例如。：：

somecolumn.op("*")(5)

生产：：

somecolumn * 5

此函数还可用于显式地生成位运算符。例如：：

somecolumn.op('&')(0xff)

是中的值的位与 somecolumn .

参数

• operator¶ -- 将作为该元素和传递给生成函数的表达式之间的中缀运算符输出的字符串。

• precedence¶ -- 在对表达式加括号时应用于运算符的优先级。当对具有更高优先级的另一个运算符应用时，较低的数字将导致表达式加括号。默认值为 0 低于除逗号之外的所有运算符 (, ） AS 运算符。值100将大于或等于所有运算符，-100将小于或等于所有运算符。

• is_comparison¶ -- 如果为真，则该运算符将被视为“比较”运算符，即计算为布尔真/假值，如 == ， > 等等。应设置此标志，以便ORM关系可以确定在自定义联接条件中使用的运算符是比较运算符。…versionAdded:：0.9.2-添加了 Operators.op.is_comparison 旗帜。

• return_type¶ -- 一 TypeEngine 类或对象，它将强制此运算符生成的表达式的返回类型为该类型。默认情况下，指定 Operators.op.is_comparison 将决心 Boolean ，而那些不属于左侧操作数的类型。

参见

重新定义和创建新的运算符

在联接条件中使用自定义运算符

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.operate(op, *other, **kwargs)¶

对参数进行运算。

这是最低级别的操作，提升 NotImplementedError 默认情况下。

在子类上覆盖此项可以允许将公共行为应用于所有操作。例如，重写 ColumnOperators 申请 func.lower() 左右两侧：

class MyComparator(ColumnOperators):
    def operate(self, op, other):
        return op(func.lower(self), func.lower(other))

参数

• op¶ -- 操作员可调用。

• *other¶ -- 操作的“另一方”。对于大多数操作，将是单个标量。

• **kwargs¶ -- 修饰语。这些可由特殊操作员通过，如 ColumnOperators.contains() .

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.regexp_match(pattern, flags=None)¶

inherited from the ColumnOperators.regexp_match() method of ColumnOperators

实现特定于数据库的“regexp match”运算符。

例如。：：

stmt = select(table.c.some_column).where(
    table.c.some_column.regexp_match('^(b|c)')
)

ColumnOperators.regexp_match() 尝试解析为后端提供的类似REGEXP的函数或运算符，但是可用的特定正则表达式语法和标志是 不是后端不可知的 .

示例包括：

• PostgreSQL-呈现 x ~ y 或 x !~ y 当被否定时。

• Oracle-呈现 REGEXP_LIKE(x, y)

• SQLite-使用SQLite的 REGEXP 占位符运算符和对Python的调用 re.match() 内置的。

• 其他后端可能提供特殊的实现。

• 没有任何特殊实现的后端将发出操作符“REGEXP”或“NOT REGEXP”。例如，这与SQLite和MySQL兼容。

正则表达式支持目前是针对Oracle、PostgreSQL、MySQL和MariaDB实现的。部分支持SQLite。第三方方言之间的支持可能会有所不同。

参数

• pattern¶ -- 正则表达式模式字符串或列子句。

• flags¶ -- 要应用的任何正则表达式字符串标志。标志往往是特定于后端的。它可以是字符串或列子句。一些后端，比如PostgreSQL和MariaDB，可以选择将标志指定为模式的一部分。在PostgreSQL中使用ignore case标志“i”时，ignore case regexp match运算符 ~* 或 !~* 将被使用。

1.4 新版功能.

参见

ColumnOperators.regexp_replace()

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.regexp_replace(pattern, replacement, flags=None)¶

inherited from the ColumnOperators.regexp_replace() method of ColumnOperators

实现特定于数据库的“regexp replace”运算符。

例如。：：

stmt = select(
    table.c.some_column.regexp_replace(
        'b(..)',
        'XY',
        flags='g'
    )
)

ColumnOperators.regexp_replace() 尝试解析为后端提供的类似REGEXP_REPLACE的函数，该函数通常发出该函数 REGEXP_REPLACE() . 但是，可用的特定正则表达式语法和标志是 不是后端不可知的 .

目前已为Oracle、PostgreSQL、MySQL8或更高版本和MariaDB实现正则表达式替换支持。第三方方言之间的支持可能会有所不同。

参数

• pattern¶ -- 正则表达式模式字符串或列子句。

• pattern¶ -- 替换字符串或列子句。

• flags¶ -- 要应用的任何正则表达式字符串标志。标志往往是特定于后端的。它可以是字符串或列子句。一些后端，比如PostgreSQL和MariaDB，可以选择将标志指定为模式的一部分。

1.4 新版功能.

参见

ColumnOperators.regexp_match()

attribute sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.remote_attr¶

inherited from the AssociationProxyInstance.remote_attr attribute of AssociationProxyInstance

此引用的“remote”类属性 AssociationProxyInstance .

参见

AssociationProxyInstance.attr

AssociationProxyInstance.local_attr

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.reverse_operate(op, other, **kwargs)¶

inherited from the Operators.reverse_operate() method of Operators

对参数进行反向运算。

用法与 operate() .

attribute sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.scalar¶

inherited from the AssociationProxyInstance.scalar attribute of AssociationProxyInstance

返回 True 如果这样 AssociationProxyInstance 在本地端代理一个标量关系。

method sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance.startswith(other, **kwargs)¶

inherited from the ColumnOperators.startswith() method of ColumnOperators

实施 startswith 操作员。

生成一个类似表达式，该表达式根据字符串值开头的匹配项进行测试：

column LIKE <other> || '%'

例如。：：

stmt = select(sometable).\
    where(sometable.c.column.startswith("foobar"))

因为操作员使用 LIKE ，通配符 "%" 和 "_" 存在于<other>表达式中的也将表现为通配符。对于文本字符串值， ColumnOperators.startswith.autoescape 标志可以设置为 True 将转义应用于字符串值中出现的这些字符，以便它们与自身匹配，而不是作为通配符匹配。或者， ColumnOperators.startswith.escape 参数将建立一个给定字符作为转义字符，当目标表达式不是文本字符串时可以使用该字符。

参数

• other¶ -- 要比较的表达式。这通常是一个纯字符串值，但也可以是任意的SQL表达式。类似通配符 % 和 _ 默认情况下不转义，除非 ColumnOperators.startswith.autoescape 标志设置为真。

• autoescape¶ -- 布尔值；如果为true，则在like表达式中建立转义符，然后将其应用于 "%" ， "_" 以及比较值中的转义字符本身，该值被假定为文本字符串而不是SQL表达式。例如：：somecolumn.startswith（“foo%bar”，autoescape=True）将呈现为：：somecolumn，类似于：param |'%'ESCAPE'/'的值为 :param 作为 "foo/%bar" .

• escape¶ -- 一个字符，当给定时将用 ESCAPE 关键字将该字符建立为转义字符。然后可以将此字符置于 % 和 _ 允许它们充当自己而不是通配符。表达式如：：somecolumn.startswith（“foo/%bar”，escape=“^”）将呈现为：：somecolumn-like :param || '%' ESCAPE '^' The parameter may also be combined with ColumnOperators.startswith.autoescape ：：somecolumn.startswith（“foo%bar^bat”，escape=“^”，autoescape=true），其中，给定的文本参数将转换为 "foo^%bar^^bat" 在被传递到数据库之前。

参见

ColumnOperators.endswith()

ColumnOperators.contains()

ColumnOperators.like()

sqlalchemy.ext.associationproxy.ASSOCIATION_PROXY = symbol('ASSOCIATION_PROXY')¶

符号表示 InspectionAttr 那是

类型的 AssociationProxy .

分配给 InspectionAttr.extension_type 属性。