mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-30 20:35:22 +08:00
docs: add database migration guide (zh/en/ja)
Document Alembic migration usage for developers: - Migration file location and naming convention - How to create new migrations - Schema change and data migration patterns - Auto-run mechanism on startup - CI testing info
This commit is contained in:
@@ -70,3 +70,93 @@ uv run pre-commit install
|
||||
## APIドキュメント
|
||||
|
||||
各インターフェースを開発する前に、APIFoxでAPIドキュメントを作成します。[APIドキュメント(中国語)](https://ok52vhsenr.apifox.cn/)を参照してください。
|
||||
|
||||
## データベースマイグレーション
|
||||
|
||||
LangBotは[Alembic](https://alembic.sqlalchemy.org/)を使用してデータベースマイグレーションを管理しており、SQLiteとPostgreSQLの両方をシームレスにサポートします。データベース固有の分岐コードは不要です。
|
||||
|
||||
### マイグレーションファイルの場所
|
||||
|
||||
```
|
||||
src/langbot/pkg/persistence/alembic/versions/
|
||||
```
|
||||
|
||||
### 新しいマイグレーションの作成
|
||||
|
||||
`versions/` ディレクトリに `NNNN_description.py` の命名規則に従ってPythonファイルを作成します:
|
||||
|
||||
```python
|
||||
"""マイグレーションの説明
|
||||
|
||||
Revision ID: 0003_add_bot_description
|
||||
Revises: 0002_sample
|
||||
Create Date: 2026-04-08
|
||||
"""
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
|
||||
revision = '0003_add_bot_description'
|
||||
down_revision = '0002_sample' # 前のマイグレーションのrevisionを指定
|
||||
branch_labels = None
|
||||
depends_on = None
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
# スキーマ変更(SQLiteとPostgreSQLの両方で動作)
|
||||
op.add_column('bots', sa.Column('description', sa.String(512), server_default=''))
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
op.drop_column('bots', 'description')
|
||||
```
|
||||
|
||||
### マイグレーションパターン
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="スキーマ変更(列の追加/削除、テーブル作成)">
|
||||
```python
|
||||
def upgrade() -> None:
|
||||
# 列を追加
|
||||
op.add_column('table_name', sa.Column('new_col', sa.String(255), server_default=''))
|
||||
|
||||
# 新しいテーブルを作成
|
||||
op.create_table(
|
||||
'new_table',
|
||||
sa.Column('id', sa.Integer, primary_key=True, autoincrement=True),
|
||||
sa.Column('name', sa.String(255), nullable=False),
|
||||
)
|
||||
```
|
||||
|
||||
<Info>
|
||||
`env.py`で`render_as_batch=True`が設定されているため、AlembicはSQLiteのALTER TABLE制限を自動的に処理します(一時テーブルによる再構築)。データベースタイプによる分岐は不要です。
|
||||
</Info>
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="データマイグレーション(データの読み取りと変更)">
|
||||
```python
|
||||
import json
|
||||
|
||||
def upgrade() -> None:
|
||||
conn = op.get_bind()
|
||||
rows = conn.execute(sa.text("SELECT uuid, config FROM pipelines")).fetchall()
|
||||
for row in rows:
|
||||
config = json.loads(row[1]) if isinstance(row[1], str) else row[1]
|
||||
config.setdefault('ai', {})['new_key'] = 'default_value'
|
||||
conn.execute(
|
||||
sa.text("UPDATE pipelines SET config = :cfg WHERE uuid = :uuid"),
|
||||
{"cfg": json.dumps(config), "uuid": row[0]}
|
||||
)
|
||||
```
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
### 動作の仕組み
|
||||
|
||||
マイグレーションはLangBot起動時に自動的に実行されます。手動コマンドは不要です:
|
||||
|
||||
1. 初回起動時、ベースラインバージョンが自動的にスタンプされます(既存データベースのマーキング)
|
||||
2. 以降の起動時、未適用のすべてのマイグレーションが適用されます(`alembic upgrade head`)
|
||||
|
||||
### CIテスト
|
||||
|
||||
リポジトリには`test-migrations.yml`ワークフローが含まれており、`persistence/`関連ファイルが変更された際に、SQLiteとPostgreSQLの両方でマイグレーションスクリプトが自動テストされます。
|
||||
|
||||
Reference in New Issue
Block a user