Method filter_by

lib/sqlalchemy/orm/query.py:1985–2024

r"""Apply the given filtering criterion to a copy of this :class:`_query.Query`, using keyword expressions. e.g.:: session.query(MyClass).filter_by(name="some name") Multiple criteria may be specified as comma separated; the effect is that they will be

(self, **kwargs: Any)

        return self._raw_columns[0]

    def filter_by(self, **kwargs: Any) -> Self:
        r"""Apply the given filtering criterion to a copy
        of this :class:`_query.Query`, using keyword expressions.

        e.g.::

            session.query(MyClass).filter_by(name="some name")

        Multiple criteria may be specified as comma separated; the effect
        is that they will be joined together using the :func:`.and_`
        function::

            session.query(MyClass).filter_by(name="some name", id=5)

        The keyword expressions are extracted from the primary
        entity of the query, or the last entity that was the
        target of a call to :meth:`_query.Query.join`.

        .. note::

            :class:`_query.Query` is a legacy construct as of SQLAlchemy 2.0.
            See :meth:`_sql.Select.filter_by` for the comparable method on
            2.0-style :func:`_sql.select` constructs, where the behavior has
            been enhanced in version 2.1 to search across all FROM clause
            entities. See :ref:`change_8601` for background.

        .. seealso::

            :meth:`_query.Query.filter` - filter on SQL expressions.

            :meth:`_sql.Select.filter_by` - v2 comparable method.

        """
        from_entity = self._filter_by_zero()

        clauses = [
            _entity_namespace_key(from_entity, key) == value
            for key, value in kwargs.items()
        ]
        return self.filter(*clauses)

    @_generative
    def order_by(