如何在 SQLAlchemy 中使用 UUID？

Question

如果使用PostgreSQL (Postgres)，有没有办法在SQLAlchemy 中将列（主键）定义为UUID？

Answer 1

sqlalchemy postgres 方言支持 UUID 列。这很容易（而且问题特别是 postgres）——我不明白为什么其他答案都这么复杂。

这是一个例子：

from sqlalchemy.dialects.postgresql import UUID
from flask_sqlalchemy import SQLAlchemy
import uuid

db = SQLAlchemy()

class Foo(db.Model):
    id = db.Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)

注意不要错过将callable uuid.uuid4 传递到列定义中，而不是使用uuid.uuid4() 调用函数本身。否则，对于此类的所有实例，您将拥有相同的标量值。更多详情here：

表示此列默认值的标量、Python 可调用或 ColumnElement 表达式，如果在插入的 VALUES 子句中未指定此列，则将在插入时调用。

Answer 2

I wrote this 域名消失了，但胆子在这里....

无论我真正关心正确数据库设计的同事如何看待用于关键字段的 UUID 和 GUID。我经常发现我需要这样做。我认为它比自动增量有一些优势，这使它值得。

过去几个月我一直在优化 UUID 列类型，我想我终于把它搞定了。

from sqlalchemy import types
from sqlalchemy.dialects.mysql.base import MSBinary
from sqlalchemy.schema import Column
import uuid


class UUID(types.TypeDecorator):
    impl = MSBinary
    def __init__(self):
        self.impl.length = 16
        types.TypeDecorator.__init__(self,length=self.impl.length)

    def process_bind_param(self,value,dialect=None):
        if value and isinstance(value,uuid.UUID):
            return value.bytes
        elif value and not isinstance(value,uuid.UUID):
            raise ValueError,'value %s is not a valid uuid.UUID' % value
        else:
            return None

    def process_result_value(self,value,dialect=None):
        if value:
            return uuid.UUID(bytes=value)
        else:
            return None

    def is_mutable(self):
        return False


id_column_name = "id"

def id_column():
    import uuid
    return Column(id_column_name,UUID(),primary_key=True,default=uuid.uuid4)

# Usage
my_table = Table('test',
         metadata,
         id_column(),
         Column('parent_id',
            UUID(),
            ForeignKey(table_parent.c.id)))

我相信存储为二进制（16 字节）最终应该比字符串表示（36 字节？）更有效，而且似乎有迹象表明在 mysql 中索引 16 字节块应该比字符串更有效。无论如何，我不认为情况会更糟。

我发现的一个缺点是，至少在 phpymyadmin 中，您不能编辑记录，因为它隐式地尝试对“select * from table where id =...”进行某种字符转换，而且还有杂项显示问题。

除此之外，一切似乎都运行良好，所以我把它扔掉了。如果您看到明显的错误，请发表评论。我欢迎任何改进它的建议。

除非我遗漏了什么，否则如果底层数据库具有 UUID 类型，上述解决方案将有效。如果没有，您可能会在创建表时遇到错误。我想出的解决方案最初是针对 MSSqlServer，然后最终使用了 MySql，所以我认为我的解决方案更灵活一些，因为它似乎在 mysql 和 sqlite 上运行良好。还没有打扰检查postgres。

Answer 3

如果您对具有 UUID 值的“字符串”列感到满意，这里有一个简单的解决方案：

def generate_uuid():
    return str(uuid.uuid4())

class MyTable(Base):
    __tablename__ = 'my_table'

    uuid = Column(String, name="uuid", primary_key=True, default=generate_uuid)

Answer 4

我使用了SQLAlchemy-Utils package 中的UUIDType。

Answer 5

由于您使用的是 Postgres，这应该可以：

from app.main import db
from sqlalchemy.dialects.postgresql import UUID

class Foo(db.Model):
    id = db.Column(UUID(as_uuid=True), primary_key=True)
    name = db.Column(db.String, nullable=False)

Answer 6

这是一种基于 SQLAlchemy 文档中的 Backend agnostic GUID 的方法，但使用 BINARY 字段将 UUID 存储在非 postgresql 数据库中。

import uuid

from sqlalchemy.types import TypeDecorator, BINARY
from sqlalchemy.dialects.postgresql import UUID as psqlUUID

class UUID(TypeDecorator):
    """Platform-independent GUID type.

    Uses Postgresql's UUID type, otherwise uses
    BINARY(16), to store UUID.

    """
    impl = BINARY

    def load_dialect_impl(self, dialect):
        if dialect.name == 'postgresql':
            return dialect.type_descriptor(psqlUUID())
        else:
            return dialect.type_descriptor(BINARY(16))

    def process_bind_param(self, value, dialect):
        if value is None:
            return value
        else:
            if not isinstance(value, uuid.UUID):
                if isinstance(value, bytes):
                    value = uuid.UUID(bytes=value)
                elif isinstance(value, int):
                    value = uuid.UUID(int=value)
                elif isinstance(value, str):
                    value = uuid.UUID(value)
        if dialect.name == 'postgresql':
            return str(value)
        else:
            return value.bytes

    def process_result_value(self, value, dialect):
        if value is None:
            return value
        if dialect.name == 'postgresql':
            return uuid.UUID(value)
        else:
            return uuid.UUID(bytes=value)

Answer 7

如果有人感兴趣，我一直在使用 Tom Willis 的答案，但发现在 process_bind_param 方法中将字符串添加到 uuid.UUID 转换很有用

class UUID(types.TypeDecorator):
    impl = types.LargeBinary

    def __init__(self):
        self.impl.length = 16
        types.TypeDecorator.__init__(self, length=self.impl.length)

    def process_bind_param(self, value, dialect=None):
        if value and isinstance(value, uuid.UUID):
            return value.bytes
        elif value and isinstance(value, basestring):
            return uuid.UUID(value).bytes
        elif value:
            raise ValueError('value %s is not a valid uuid.UUId' % value)
        else:
            return None

    def process_result_value(self, value, dialect=None):
        if value:
            return uuid.UUID(bytes=value)
        else:
            return None

    def is_mutable(self):
        return False

Answer 8

我们可以使用UUIDType，

from sqlalchemy_utils import UUIDType
from sqlalchemy import VARCHAR,
class User(Base):
    __tablename__ = "user"
    id = Column(UUIDType(binary=False), primary_key=True, default=uuid.uuid4())
    name = Column(VARCHAR(length=30))
    first_name = Column(VARCHAR(length=30))
    last_name = Column(VARCHAR(length=30))

更多详情我们可以参考official documentation。

Answer 9

您可以尝试写一个custom type，例如：

import sqlalchemy.types as types

class UUID(types.TypeEngine):
    def get_col_spec(self):
        return "uuid"

    def bind_processor(self, dialect):
        def process(value):
            return value
        return process

    def result_processor(self, dialect):
        def process(value):
            return value
        return process

table = Table('foo', meta,
    Column('id', UUID(), primary_key=True),
)