sqlalchemy的常用數據類型怎么使用

SQLAlchemy的常用數據類型怎么使用

SQLAlchemy 是一個強大的 Python ORM（對象關系映射）工具，它允許開發者通過 Python 對象來操作數據庫。SQLAlchemy 提供了豐富的數據類型，用于在 Python 和數據庫之間進行數據映射。本文將詳細介紹 SQLAlchemy 中常用的數據類型及其使用方法。

1. SQLAlchemy 數據類型概述

SQLAlchemy 的數據類型主要分為兩大類：

• Python 數據類型：這些類型與 Python 的內置數據類型相對應，例如 Integer、String、Float 等。
• SQL 數據類型：這些類型與數據庫中的數據類型相對應，例如 VARCHAR、INTEGER、FLOAT 等。

SQLAlchemy 的數據類型通常用于定義模型中的列（Column），以便在數據庫中創建相應的表結構。

2. 常用數據類型

2.1 數值類型

2.1.1 Integer

Integer 類型用于表示整數。它可以映射到數據庫中的 INTEGER 類型。

from sqlalchemy import Column, Integer

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    age = Column(Integer)

2.1.2 Float

Float 類型用于表示浮點數。它可以映射到數據庫中的 FLOAT 類型。

from sqlalchemy import Column, Float

class Product(Base):
    __tablename__ = 'products'
    id = Column(Integer, primary_key=True)
    price = Column(Float)

2.1.3 Numeric

Numeric 類型用于表示高精度的十進制數。它可以映射到數據庫中的 NUMERIC 或 DECIMAL 類型。

from sqlalchemy import Column, Numeric

class Account(Base):
    __tablename__ = 'accounts'
    id = Column(Integer, primary_key=True)
    balance = Column(Numeric(10, 2))  # 10位數字，其中2位小數

2.2 字符串類型

2.2.1 String

String 類型用于表示字符串。它可以映射到數據庫中的 VARCHAR 或 TEXT 類型。

from sqlalchemy import Column, String

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    name = Column(String(50))  # 最大長度為50的字符串

2.2.2 Text

Text 類型用于表示長文本。它可以映射到數據庫中的 TEXT 類型。

from sqlalchemy import Column, Text

class Article(Base):
    __tablename__ = 'articles'
    id = Column(Integer, primary_key=True)
    content = Column(Text)

2.3 日期和時間類型

2.3.1 DateTime

DateTime 類型用于表示日期和時間。它可以映射到數據庫中的 DATETIME 或 TIMESTAMP 類型。

from sqlalchemy import Column, DateTime
from datetime import datetime

class Event(Base):
    __tablename__ = 'events'
    id = Column(Integer, primary_key=True)
    start_time = Column(DateTime, default=datetime.utcnow)

2.3.2 Date

Date 類型用于表示日期。它可以映射到數據庫中的 DATE 類型。

from sqlalchemy import Column, Date
from datetime import date

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    birthdate = Column(Date)

2.3.3 Time

Time 類型用于表示時間。它可以映射到數據庫中的 TIME 類型。

from sqlalchemy import Column, Time
from datetime import time

class Schedule(Base):
    __tablename__ = 'schedules'
    id = Column(Integer, primary_key=True)
    start_time = Column(Time)

2.4 布爾類型

2.4.1 Boolean

Boolean 類型用于表示布爾值（True 或 False）。它可以映射到數據庫中的 BOOLEAN 或 TINYINT 類型。

from sqlalchemy import Column, Boolean

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    is_active = Column(Boolean, default=True)

2.5 二進制類型

2.5.1 LargeBinary

LargeBinary 類型用于表示二進制數據。它可以映射到數據庫中的 BLOB 或 BYTEA 類型。

from sqlalchemy import Column, LargeBinary

class File(Base):
    __tablename__ = 'files'
    id = Column(Integer, primary_key=True)
    data = Column(LargeBinary)

2.6 枚舉類型

2.6.1 Enum

Enum 類型用于表示枚舉值。它可以映射到數據庫中的 ENUM 類型。

from sqlalchemy import Column, Enum

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    role = Column(Enum('admin', 'user', 'guest'))

2.7 JSON 類型

2.7.1 JSON

JSON 類型用于表示 JSON 數據。它可以映射到數據庫中的 JSON 類型。

from sqlalchemy import Column, JSON

class Config(Base):
    __tablename__ = 'configs'
    id = Column(Integer, primary_key=True)
    settings = Column(JSON)

2.8 數組類型

2.8.1 ARRAY

ARRAY 類型用于表示數組。它可以映射到數據庫中的 ARRAY 類型（例如 PostgreSQL 中的 ARRAY）。

from sqlalchemy import Column, ARRAY, Integer

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    scores = Column(ARRAY(Integer))

2.9 UUID 類型

2.9.1 UUID

UUID 類型用于表示 UUID（通用唯一標識符）。它可以映射到數據庫中的 UUID 類型（例如 PostgreSQL 中的 UUID）。

from sqlalchemy import Column, UUID
import uuid

class User(Base):
    __tablename__ = 'users'
    id = Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)

3. 自定義數據類型

SQLAlchemy 允許開發者定義自己的數據類型。通過繼承 TypeDecorator 類，可以創建自定義的數據類型。

from sqlalchemy import TypeDecorator, String

class MyCustomType(TypeDecorator):
    impl = String

    def process_bind_param(self, value, dialect):
        # 在將數據存儲到數據庫之前進行處理
        return value.upper()

    def process_result_value(self, value, dialect):
        # 在從數據庫讀取數據之后進行處理
        return value.lower()

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    custom_field = Column(MyCustomType(50))

4. 數據類型的參數

許多數據類型都支持參數，用于指定數據的長度、精度、默認值等。

4.1 長度參數

例如，String 類型可以指定最大長度：

name = Column(String(50))  # 最大長度為50的字符串

4.2 精度參數

例如，Numeric 類型可以指定精度和小數位數：

balance = Column(Numeric(10, 2))  # 10位數字，其中2位小數

4.3 默認值

可以為列指定默認值：

is_active = Column(Boolean, default=True)

4.4 可空性

默認情況下，列是可空的?？梢酝ㄟ^ nullable 參數指定列是否允許為空：

name = Column(String(50), nullable=False)

5. 數據類型的映射

SQLAlchemy 的數據類型會自動映射到數據庫中的相應類型。例如，Integer 類型會映射到 INTEGER，String 類型會映射到 VARCHAR 或 TEXT。

5.1 數據庫特定的映射

不同的數據庫可能對同一數據類型有不同的實現。SQLAlchemy 會根據所使用的數據庫自動選擇合適的映射。

例如，Boolean 類型在 PostgreSQL 中映射到 BOOLEAN，而在 MySQL 中映射到 TINYINT。

5.2 自定義映射

如果需要自定義數據類型在特定數據庫中的映射，可以使用 TypeEngine.with_variant 方法。

from sqlalchemy import Integer, TypeEngine

class MyCustomType(TypeEngine):
    impl = Integer

    def load_dialect_impl(self, dialect):
        if dialect.name == 'postgresql':
            return dialect.type_descriptor(Integer)
        elif dialect.name == 'mysql':
            return dialect.type_descriptor(Integer)
        else:
            return dialect.type_descriptor(Integer)

custom_type = MyCustomType().with_variant(Integer, 'postgresql')

6. 數據類型的驗證

SQLAlchemy 提供了多種方式來驗證數據的有效性。

6.1 約束

可以在列上添加約束，例如 unique、primary_key、foreign_key 等。

email = Column(String(100), unique=True)

6.2 校驗器

可以使用 validates 裝飾器來定義自定義的校驗邏輯。

from sqlalchemy.orm import validates

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    email = Column(String(100))

    @validates('email')
    def validate_email(self, key, address):
        assert '@' in address, 'Invalid email address'
        return address

6.3 事件監聽

可以使用 SQLAlchemy 的事件系統來監聽數據的變化，并在數據變化時執行自定義的校驗邏輯。

from sqlalchemy import event

@event.listens_for(User.email, 'set')
def validate_email(target, value, oldvalue, initiator):
    if '@' not in value:
        raise ValueError('Invalid email address')

7. 數據類型的轉換

SQLAlchemy 提供了多種方式來轉換數據類型。

7.1 類型裝飾器

可以使用 TypeDecorator 來定義自定義的數據類型轉換邏輯。

from sqlalchemy import TypeDecorator, String

class MyCustomType(TypeDecorator):
    impl = String

    def process_bind_param(self, value, dialect):
        return value.upper()

    def process_result_value(self, value, dialect):
        return value.lower()

7.2 類型強制轉換

可以使用 cast 函數來強制轉換數據類型。

from sqlalchemy import cast, Integer

query = session.query(cast(User.age, Integer))

8. 數據類型的性能考慮

選擇合適的數據類型對數據庫性能有重要影響。

8.1 索引

為經常查詢的列創建索引可以顯著提高查詢性能。

name = Column(String(50), index=True)

8.2 數據類型的大小

選擇合適的數據類型大小可以減少存儲空間并提高查詢性能。例如，使用 SmallInteger 而不是 Integer 可以減少存儲空間。

age = Column(SmallInteger)

8.3 數據類型的精度

對于 Numeric 類型，選擇合適的精度和小數位數可以減少存儲空間并提高計算性能。

balance = Column(Numeric(10, 2))

9. 數據類型的遷移

在數據庫遷移過程中，可能需要修改數據類型。SQLAlchemy 提供了 alembic 工具來管理數據庫遷移。

9.1 修改數據類型

可以使用 alter_column 來修改列的數據類型。

from alembic import op

def upgrade():
    op.alter_column('users', 'age', type_=SmallInteger)

def downgrade():
    op.alter_column('users', 'age', type_=Integer)

9.2 數據遷移

在修改數據類型時，可能需要遷移現有數據?？梢允褂?batch_alter_table 來批量修改表結構。

from alembic import op

def upgrade():
    with op.batch_alter_table('users') as batch_op:
        batch_op.alter_column('age', type_=SmallInteger)

def downgrade():
    with op.batch_alter_table('users') as batch_op:
        batch_op.alter_column('age', type_=Integer)

10. 總結

SQLAlchemy 提供了豐富的數據類型，用于在 Python 和數據庫之間進行數據映射。通過合理選擇和使用這些數據類型，可以有效地管理數據庫中的數據，并提高應用程序的性能和可維護性。

在實際開發中，應根據具體的業務需求選擇合適的數據類型，并注意數據類型的性能影響和遷移問題。通過掌握 SQLAlchemy 的數據類型，開發者可以更加靈活地操作數據庫，構建高效、可靠的應用程序。