# 機能設計書 70-データストア作成

## 概要

本ドキュメントは、Giselleシステムにおける「データストア作成」機能の設計仕様を定義する。

### 本機能の処理概要

データストア作成機能は、外部データストア（PostgreSQL等）への接続設定を作成する機能である。プロバイダの種類と接続設定をバリデーションした上でストレージに保存する。

**業務上の目的・背景**：AIワークフローでは、外部データベースからデータを取得して処理することがある。本機能により、ユーザーはPostgreSQL等の外部データベースへの接続を設定し、データクエリノードを通じてワークフロー内でデータを参照できるようになる。

**機能の利用シーン**：
- データストア設定画面での新規接続作成
- データクエリノードで使用するデータベース接続の登録

**主要な処理内容**：
1. 入力としてプロバイダ種別と接続設定を受け取る
2. プロバイダに応じた設定スキーマでバリデーション
3. DataStoreIdを生成
4. DataStoreオブジェクトをストレージに保存
5. 作成したDataStoreオブジェクトを返却

**関連システム・外部連携**：
- `@giselles-ai/data-store-registry`パッケージによるプロバイダ定義
- `@giselles-ai/storage`パッケージによるストレージ抽象化レイヤー

**権限による制御**：本機能自体には認証・認可チェックは含まれない。呼び出し元のAPIレイヤーにて適切な認可制御が行われることを前提とする。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 33 | データストア設定画面 | 主機能 | 外部データストア（PostgreSQL等）への接続作成 |

## 機能種別

データ登録（CREATE）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| context | `GiselleContext` | Yes | Giselleコンテキスト | - |
| provider | `DataStoreProvider` | Yes | データストアプロバイダ種別 | `postgres`等の有効なプロバイダ名 |
| configuration | `DataStore["configuration"]` | Yes | プロバイダ固有の接続設定 | プロバイダスキーマに準拠 |

### プロバイダ別設定スキーマ

#### PostgreSQL (`postgres`)

| 項目名 | 型 | 必須 | 説明 |
|--------|-----|-----|------|
| connectionStringSecretId | `string` | Yes | 接続文字列を格納したシークレットのID |

### 入力データソース

- ユーザー入力（画面からのフォーム入力）
- 接続文字列はシークレットとして事前に登録されている必要がある

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| id | `DataStoreId` | 生成されたデータストアID |
| provider | `DataStoreProvider` | データストアプロバイダ種別 |
| configuration | `Record<string, unknown>` | バリデーション済みの接続設定 |

### 出力先

- ストレージにDataStoreを保存
- 呼び出し元への戻り値として返却

## 処理フロー

### 処理シーケンス

```
1. 設定バリデーション
   └─ parseConfiguration()でプロバイダスキーマに基づきバリデーション

2. DataStoreId生成
   └─ DataStoreId.generate()でIDを生成

3. DataStoreオブジェクト作成
   └─ id, provider, configurationを含むオブジェクトを作成

4. ストレージに保存
   └─ storage.setJson()でdata-stores/{dataStoreId}/data-store.jsonに保存

5. 結果返却
   └─ 作成したDataStoreオブジェクトを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[parseConfigurationでバリデーション]
    B --> C{バリデーション成功?}
    C -->|No| D[ZodError発生]
    C -->|Yes| E[DataStoreId生成]
    E --> F[DataStoreオブジェクト作成]
    F --> G[storage.setJsonで保存]
    G --> H[DataStore返却]
    D --> I[終了（異常）]
    H --> J[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-70-01 | プロバイダバリデーション | プロバイダは登録されているプロバイダのみ使用可能 | 常時 |
| BR-70-02 | 設定バリデーション | 設定はプロバイダ固有のスキーマでバリデーションされる | 常時 |
| BR-70-03 | ID生成 | DataStoreIdは`ds_`プレフィックスで自動生成される | 常時 |
| BR-70-04 | 接続文字列保護 | 接続文字列はシークレットIDで参照（平文では保存しない） | 常時 |

### 計算ロジック

本機能に特別な計算ロジックは存在しない。

## データベース操作仕様

### 操作別データベース影響一覧

本機能はBlobストレージのみを使用し、リレーショナルデータベースへの直接アクセスは行わない。

| 操作 | 対象ストレージ | 操作種別 | 概要 |
|-----|-------------|---------|------|
| データストア保存 | Blob Storage | SET | DataStoreをJSONとして保存 |

### ストレージ操作詳細

#### Blobストレージ

| 操作 | パス | データ形式 | 備考 |
|-----|------|----------|------|
| SET | data-stores/{dataStoreId}/data-store.json | JSON | DataStore構造体 |

#### DataStore構造体

```typescript
{
  id: DataStoreId;                    // データストアID（ds_xxx）
  provider: DataStoreProvider;        // プロバイダ種別（"postgres"等）
  configuration: Record<string, unknown>;  // プロバイダ固有の設定
}
```

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Error | 無効なプロバイダ指定 | 有効なプロバイダを指定 |
| - | ZodError | 設定のバリデーション失敗 | プロバイダスキーマに準拠した設定を指定 |
| - | StorageError | ストレージへの書き込み失敗 | ストレージ接続を確認 |

### リトライ仕様

ストレージアクセス失敗時のリトライは、ストレージドライバ層で実装される。アプリケーション層でのリトライは行わない。

## トランザクション仕様

単一の保存操作のため、トランザクション管理は不要。

## パフォーマンス要件

- レスポンス時間: 100ms以内（ストレージレイテンシを含む）
- 同時リクエスト: ストレージの制限に依存

## セキュリティ考慮事項

- 認証・認可: API呼び出し元で実装（本機能では未実装）
- データ保護: 接続文字列はシークレットIDとして保存（平文では保存しない）
- 監査ログ: データストア作成のログ記録を推奨

## 備考

- 接続文字列は直接保存せず、シークレットIDを保存する設計
- 対応プロバイダは`@giselles-ai/data-store-registry`で定義

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、データストア関連の型定義を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | data-store/index.ts | `packages/protocol/src/data-store/index.ts` | DataStore, DataStoreIdの型定義 |
| 1-2 | data-store-registry/index.ts | `packages/data-store-registry/src/index.ts` | プロバイダ定義とスキーマ |

**読解のコツ**:
- **8行目（protocol）**: `DataStoreId = createIdGenerator("ds")`で`ds_`プレフィックス
- **11-16行目（protocol）**: DataStoreスキーマ定義（id, provider, configuration）
- **3-11行目（registry）**: dataStoreRegistryでプロバイダとスキーマを定義
- **7-9行目（registry）**: PostgreSQL設定スキーマ（connectionStringSecretIdが必須）

#### Step 2: エントリーポイントを理解する

処理の起点となるファイル・関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | create-data-store.ts | `packages/giselle/src/data-stores/create-data-store.ts` | createDataStore関数の実装 |

**主要処理フロー**:
1. **9-17行目**: 関数シグネチャと引数定義
2. **18行目**: `parseConfiguration()`でプロバイダスキーマに基づきバリデーション
3. **19行目**: `DataStoreId.generate()`でID生成
4. **20-24行目**: DataStoreオブジェクト作成
5. **26-30行目**: `storage.setJson()`でストレージに保存
6. **32行目**: 作成したDataStoreを返却

#### Step 3: ユーティリティ関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | paths.ts | `packages/giselle/src/data-stores/paths.ts` | dataStorePathの定義 |
| 3-2 | data-store-registry/index.ts | `packages/data-store-registry/src/index.ts` | parseConfiguration関数 |

**主要処理フロー**:
- **3-5行目（paths.ts）**: `data-stores/{dataStoreId}/data-store.json`パスを生成
- **27-35行目（registry）**: parseConfigurationでプロバイダ定義を取得し、スキーマでパース

### プログラム呼び出し階層図

```
Giselle.createDataStore (giselle.ts:436-440)
    │
    └─ createDataStore (create-data-store.ts:9-33)
           │
           ├─ parseConfiguration(provider, configuration)
           │      │       (data-store-registry/index.ts:27-35)
           │      │
           │      ├─ getProviderDefinition(provider)
           │      │
           │      └─ def.configurationSchema.safeParse(config)
           │
           ├─ DataStoreId.generate()
           │
           ├─ dataStorePath(dataStoreId) (paths.ts:3-5)
           │
           └─ context.storage.setJson({path, data, schema})
```

### データフロー図

```
[入力]                          [処理]                              [出力]

provider ───────┐
                ├──▶ parseConfiguration() ───▶ validatedConfiguration
configuration ──┘         │
                          ▼
                   DataStoreId.generate() ───▶ dataStoreId
                          │
                          ▼
                   Create DataStore Object
                   {id, provider, configuration}
                          │
                          ▼
                   dataStorePath() ───▶ Storage Path
                          │        "data-stores/{dsId}/data-store.json"
                          ▼
                   storage.setJson()
                          │
                          ▼
                   Return DataStore
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| create-data-store.ts | `packages/giselle/src/data-stores/create-data-store.ts` | ソース | メイン処理の実装 |
| index.ts | `packages/protocol/src/data-store/index.ts` | ソース | DataStore型定義 |
| index.ts | `packages/data-store-registry/src/index.ts` | ソース | プロバイダ定義とバリデーション |
| paths.ts | `packages/giselle/src/data-stores/paths.ts` | ソース | パス生成ユーティリティ |
| types.ts | `packages/storage/src/types.ts` | ソース | ストレージインターフェース定義 |
| giselle.ts | `packages/giselle/src/giselle.ts` | ソース | Giselleクラスのエントリーポイント |
