Class Uuid

lib/sqlalchemy/sql/sqltypes.py:3780–3969

Represent a database agnostic UUID datatype. For backends that have no "native" UUID datatype, the value will make use of ``CHAR(32)`` and store the UUID as a 32-character alphanumeric hex string. For backends which are known to support ``UUID`` directly or a similar uuid-stori

class Uuid(Emulated, TypeEngine[_UUID_RETURN]):
    """Represent a database agnostic UUID datatype.

    For backends that have no "native" UUID datatype, the value will
    make use of ``CHAR(32)`` and store the UUID as a 32-character alphanumeric
    hex string.

    For backends which are known to support ``UUID`` directly or a similar
    uuid-storing datatype such as SQL Server's ``UNIQUEIDENTIFIER``, a
    "native" mode enabled by default allows these types will be used on those
    backends.

    In its default mode of use, the :class:`_sqltypes.Uuid` datatype expects
    **Python uuid objects**, from the Python
    `uuid <https://docs.python.org/3/library/uuid.html>`_
    module::

        import uuid

        from sqlalchemy import Uuid
        from sqlalchemy import Table, Column, MetaData, String

        metadata_obj = MetaData()

        t = Table(
            "t",
            metadata_obj,
            Column("uuid_data", Uuid, primary_key=True),
            Column("other_data", String),
        )

        with engine.begin() as conn:
            conn.execute(
                t.insert(), {"uuid_data": uuid.uuid4(), "other_data": "some data"}
            )

    To have the :class:`_sqltypes.Uuid` datatype work with string-based
    Uuids (e.g. 32 character hexadecimal strings), pass the
    :paramref:`_sqltypes.Uuid.as_uuid` parameter with the value ``False``.

    .. versionadded:: 2.0

    .. seealso::

        :class:`_sqltypes.UUID` - represents exactly the ``UUID`` datatype
        without any backend-agnostic behaviors.

    """  # noqa: E501

    __visit_name__ = "uuid"

    operator_classes = OperatorClass.BASE | OperatorClass.COMPARISON

    length: Optional[int] = None
    collation: Optional[str] = None

    @overload
    def __init__(