SQLAlchemy: Declarativeを使ったインデックス付きテーブル作成

2024-07-27

SQLAlchemy を用いたインデックス付きテーブル作成ステートメント

前提条件

SQLAlchemy 1.4 以降
Python 3.6 以降

テーブル定義

まず、sqlalchemy.Table クラスを使ってテーブルを定義します。

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

metadata = MetaData()

users = Table(
    "users",
    metadata,
    Column("id", Integer, primary_key=True),
    Column("name", String(255)),
    Column("email", String(255)),
)

上記コードでは、users という名前のテーブルを定義しています。

email カラムは、最大255文字の文字列型です。
id カラムは、主キーとして設定されています。

インデックス定義

次に、sqlalchemy.Index クラスを使ってインデックスを定義します。

index_name = "name_idx"
index = Index(index_name, users.c.name)

上記コードでは、name カラムに name_idx という名前のインデックスを定義しています。

テーブル作成

最後に、metadata.create_all() メソッドを使ってテーブルを作成します。

engine = create_engine("sqlite:///mydb.sqlite")
metadata.create_all(engine)

上記コードでは、mydb.sqlite という名前の SQLite データベースにテーブルを作成しています。

実行結果

CREATE TABLE users (
    id INTEGER NOT NULL PRIMARY KEY,
    name VARCHAR(255),
    email VARCHAR(255)
);

CREATE INDEX name_idx ON users (name);

from sqlalchemy import Table, MetaData, Column, Integer, String, Index

metadata = MetaData()

users = Table(
    "users",
    metadata,
    Column("id", Integer, primary_key=True),
    Column("name", String(255)),
    Column("email", String(255)),
)

# 複合インデックス
index_name = "name_email_idx"
index = Index(index_name, users.c.name, users.c.email)

# 一意インデックス
unique_index_name = "unique_name_idx"
unique_index = Index(unique_index_name, users.c.name, unique=True)

engine = create_engine("sqlite:///mydb.sqlite")
metadata.create_all(engine)

一意インデックス: name カラムで構成される unique_name_idx という名前の一意インデックスを作成します。
複合インデックス: name カラムと email カラムで構成される name_email_idx という名前のインデックスを作成します。

CREATE TABLE users (
    id INTEGER NOT NULL PRIMARY KEY,
    name VARCHAR(255),
    email VARCHAR(255)
);

CREATE INDEX name_email_idx ON users (name, email);

CREATE UNIQUE INDEX unique_name_idx ON users (name);

B-木インデックス: B-木インデックスは、データの検索と挿入を効率的に行うために使用されるインデックスです。
部分インデックス: 部分インデックスは、テーブルのすべての行ではなく、一部の行のみを対象としたインデックスです。

テーブルオプション

Table クラスの options キーワード引数を使用して、インデックスを定義することができます。

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

metadata = MetaData()

users = Table(
    "users",
    metadata,
    Column("id", Integer, primary_key=True),
    Column("name", String(255)),
    Column("email", String(255)),
    options={"indexes": [Index("name_idx", "name")]},
)

engine = create_engine("sqlite:///mydb.sqlite")
metadata.create_all(engine)

Declarative

Declarative を使用してインデックス付きテーブルを作成することができます。

from sqlalchemy import Column, Integer, String, Index
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    email = Column(String(255))

    # 複合インデックス
    name_email_idx = Index("name_email_idx", name, email)

    # 一意インデックス
    unique_name_idx = Index("unique_name_idx", name, unique=True)

engine = create_engine("sqlite:///mydb.sqlite")
Base.metadata.create_all(engine)

SQL クエリ

CREATE INDEX ステートメントを使用して、インデックスを手動で作成することができます。

CREATE TABLE users (
    id INTEGER NOT NULL PRIMARY KEY,
    name VARCHAR(255),
    email VARCHAR(255)
);

CREATE INDEX name_idx ON users (name);

CREATE UNIQUE INDEX unique_name_idx ON users (name);