Class quoted_name

lib/sqlalchemy/sql/elements.py:5681–5775

Represent a SQL identifier combined with quoting preferences. :class:`.quoted_name` is a Python unicode/str subclass which represents a particular identifier name along with a ``quote`` flag. This ``quote`` flag, when set to ``True`` or ``False``, overrides automatic quoting behavi

class quoted_name(util.MemoizedSlots, str):
    class="st">"""Represent a SQL identifier combined with quoting preferences.

    :class:`.quoted_name` is a Python unicode/str subclass which
    represents a particular identifier name along with a
    ``quote`` flag.  This ``quote`` flag, when set to
    ``True`` or ``False``, overrides automatic quoting behavior
    for this identifier in order to either unconditionally quote
    or to not quote the name.  If left at its default of ``None``,
    quoting behavior is applied to the identifier on a per-backend basis
    based on an examination of the token itself.

    A :class:`.quoted_name` object with ``quote=True`` is also
    prevented from being modified in the case of a so-called
    class="st">"name normalize" option.  Certain database backends, such as
    Oracle Database, Firebird, and DB2 class="st">"normalize" case-insensitive names
    as uppercase.  The SQLAlchemy dialects for these backends
    convert from SQLAlchemy&class="cm">#x27;s lower-case-means-insensitive convention
    to the upper-case-means-insensitive conventions of those backends.
    The ``quote=True`` flag here will prevent this conversion from occurring
    to support an identifier that&class="cm">#x27;s quoted as all lower case against
    such a backend.

    The :class:`.quoted_name` object is normally created automatically
    when specifying the name for key schema constructs such as
    :class:`_schema.Table`, :class:`_schema.Column`, and others.
    The class can also be
    passed explicitly as the name to any function that receives a name which
    can be quoted, such as :meth:`.Inspector.has_table` with an
    unconditionally quoted name::

        from sqlalchemy import create_engine
        from sqlalchemy import inspect
        from sqlalchemy.sql import quoted_name

        engine = create_engine(class="st">"oracle+oracledb://some_dsn")
        print(inspect(engine).has_table(quoted_name(class="st">"some_table", True)))

    The above logic will run the class="st">"has table" logic against the Oracle Database
    backend, passing the name exactly as ``class="st">"some_table"`` without converting to
    upper case.

    A :class:`.quoted_name` object with ``quote=False`` may be passed to APIs
    that apply automatic quoting in order to keep the given name unquoted,
    such as when a PostgreSQL ``INHERITS`` option refers to a schema-qualified
    table name like ``my_schema.some_table``.

    class="st">"""

    __slots__ = class="st">"quote", class="st">"lower", class="st">"upper"

    quote: Optional[bool]

    @overload
    @classmethod
    def construct(cls, value: str, quote: Optional[bool]) -> quoted_name: ...

    @overload