> For the complete documentation index, see [llms.txt](https://docs.maiagent.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.maiagent.ai/maiagent-user-guide/maiagent-user-guide-ja/database/create-database.md).

# データベースの作成と設定

MaiAgent の**データベース管理**機能を使用すると、AI アシスタントが利用するデータベース接続をプラットフォーム上で一元管理できます。Text to SQL 機能と組み合わせることで、AI アシスタントは自然言語で直接データベース内のデータをクエリできるようになります。

{% hint style="info" %}
Text to SQL のコンセプトについては、こちらをご参照ください：[Text to SQL 機能](/maiagent-user-guide/maiagent-user-guide-ja/database/text2sql.md)
{% endhint %}

MaiAgent は 2 種類のデータベースに対応しています：

* **MaiAgent データベース**：Excel / CSV / JSON ファイルをアップロードすると、システムが自動的にデータテーブルを作成します。自前のデータベースをお持ちでない方に適しています
* **外部データベース**：既存の PostgreSQL、MySQL、MSSQL、Oracle データベースに接続します

## データベースの作成 <a href="#create-database" id="create-database"></a>

### 1. データベース管理ページを開く <a href="#enter-database-management-page" id="enter-database-management-page"></a>

左側のナビゲーションバーから「<mark style="color:blue;">AI 機能</mark>」セクションに入り、「<mark style="color:blue;">データベース</mark>」をクリックします。ページは **MaiAgent データベース**と**外部データベース**の 2 つのタブに分かれています。

右上の「<mark style="color:blue;">データベースを追加</mark>」ボタンをクリックして作成を開始します。

<figure><img src="/files/ytM6pTD7UuNCQhrYZC92" alt="データベース管理ページ"><figcaption><p>データベース管理ページ。MaiAgent データベースの一覧を表示しています</p></figcaption></figure>

{% hint style="info" %}
ボタンがグレーアウトしてクリックできない場合は、お使いのロールにデータベースを作成する権限がまだ付与されていないことを意味します。組織管理者に連絡して権限を設定してもらってください。
{% endhint %}

### 2. データベースの種類を選択する <a href="#select-database-type" id="select-database-type"></a>

作成するデータベースの種類を選び、対応するカードをクリックします：

* **MaiAgent**：スプレッドシートファイルのアップロードに適しており、接続文字列は不要です
* **PostgreSQL / MySQL / MSSQL / Oracle**：企業の既存の外部データベースに接続します

<figure><img src="/files/7HcOk5gcLP2OrKfSzDE2" alt="データベースの種類を選択"><figcaption><p>ステップ 1：データベースの種類を選択</p></figcaption></figure>

### 3. 基本情報を入力する <a href="#fill-in-basic-info" id="fill-in-basic-info"></a>

#### MaiAgent データベース <a href="#maiagent-database-info" id="maiagent-database-info"></a>

| 項目      | 必須  | 説明                   |
| ------- | --- | -------------------- |
| データベース名 | はい  | 例：「2024 年度売上データ」     |
| 説明      | いいえ | データベースの用途や内容を補足説明します |

{% hint style="info" %}
MaiAgent データベースでは接続文字列を入力する必要はなく、システムが自動的にデータの保存を処理します。作成完了後にスプレッドシートファイルをアップロードするだけです。
{% endhint %}

<figure><img src="/files/dJTrbWCADIAbx9pyqnmM" alt="MaiAgent データベースの設定"><figcaption><p>ステップ 2：MaiAgent データベースの設定画面</p></figcaption></figure>

#### 外部データベース <a href="#external-database-info" id="external-database-info"></a>

| 項目        | 必須  | 説明                                      |
| --------- | --- | --------------------------------------- |
| データベース名   | はい  | 例：「企業 ERP データベース」                       |
| 説明        | いいえ | データベースの用途や内容を補足説明します                    |
| 接続文字列     | はい  | データベースの接続 URL                           |
| 対象テーブルの指定 | いいえ | AI アシスタントがクエリできるテーブルを制限します。カンマ区切りで入力します |

接続文字列の形式は以下のとおりです：

```
PostgreSQL:   postgresql://ユーザー名:パスワード@ホストアドレス:ポート/データベース名
MySQL:        mysql://ユーザー名:パスワード@ホストアドレス:ポート/データベース名
MSSQL:        mssql+pymssql://ユーザー名:パスワード@ホストアドレス:ポート/データベース名
Oracle:       oracle+cx_oracle://ユーザー名:パスワード@ホストアドレス:ポート/データベース名
```

{% hint style="danger" %}
接続文字列の形式が正しいこと、および必要な接続情報が含まれていることを必ず確認してください。データベース URL が MaiAgent サービスからアクセス可能であることを確認する必要があります。
{% endhint %}

<figure><img src="/files/rx344oWFEBelrTysMdqY" alt="外部データベースの設定"><figcaption><p>ステップ 2：外部データベース（PostgreSQL）の設定画面</p></figcaption></figure>

接続文字列を入力したら、「<mark style="color:blue;">接続テスト</mark>」ボタンをクリックして接続が正常かどうかを確認することをおすすめします：

* **接続成功**：MaiAgent がお使いのデータベースに正常にアクセスできることを意味します
* **接続失敗**：接続文字列の形式、ネットワークの疎通性、およびデータベースが外部接続を許可しているかどうかを確認してください

データベースに大量のテーブルが含まれている場合は、「<mark style="color:blue;">対象テーブルの指定</mark>」欄に公開したいテーブル名（例：`customers, orders, products`）を入力することで、クエリの効率とセキュリティを高めることができます。

### 4. グループ権限を設定する <a href="#configure-group-permission" id="configure-group-permission"></a>

最後のステップは、どのグループがこのデータベースにアクセスできるかを設定することです。左右の振り分けコンポーネントを使用して、権限を付与したいグループを左側から右側へ移動するだけです。

{% hint style="info" %}
当面グループ権限を設定する必要がない場合は、このステップをそのままスキップして、後からデータベース設定ページで調整することもできます。
{% endhint %}

### 5. 作成を完了する <a href="#complete-creation" id="complete-creation"></a>

すべての設定を確認したら、「<mark style="color:blue;">作成</mark>」ボタンをクリックします。作成に成功するとデータベース設定ページに移動し、その後の操作を行えます。

{% hint style="info" %}
作成完了後は、データベースを **AI アシスタントに関連付ける**ことを忘れないでください。これにより、AI アシスタントがこのデータベースを使ってクエリを実行できるようになります。こちらをご参照ください：[AI アシスタントとグループ権限の関連付け](/maiagent-user-guide/maiagent-user-guide-ja/database/link-chatbots-groups.md)
{% endhint %}

## ファイルをアップロードしてデータテーブルを作成する（MaiAgent データベース） <a href="#upload-file-to-create-table" id="upload-file-to-create-table"></a>

MaiAgent データベースを作成したら、設定ページに入り「<mark style="color:blue;">テーブル管理</mark>」タブに切り替えて、「<mark style="color:blue;">テーブルファイルをアップロード</mark>」ボタンをクリックします。

<figure><img src="/files/f5TKrDAnMBchEqOnkDjE" alt="テーブル管理タブ"><figcaption><p>テーブル管理タブ。ファイルをアップロードしてデータテーブルを作成できます</p></figcaption></figure>

### 対応するファイル形式 <a href="#supported-file-formats" id="supported-file-formats"></a>

| 形式    | 拡張子              | 説明                                   |
| ----- | ---------------- | ------------------------------------ |
| Excel | `.xlsx`、`.xls`   | 各ワークシート（Sheet）ごとに 1 つのデータテーブルが作成されます |
| CSV   | `.csv`           | カンマ区切り値ファイル                          |
| JSON  | `.json`、`.jsonl` | JSON 形式のデータファイル                      |

アップロード後、システムがバックグラウンドで自動的にファイル構造を解析してデータテーブルを作成します。各データテーブルには処理ステータスが表示されます：

| ステータス | 説明                                         |
| ----- | ------------------------------------------ |
| 待機中   | ファイルがアップロードされ、システムの処理を待っています               |
| 処理中   | システムがファイルを解析してデータテーブルを作成しています              |
| 成功    | データテーブルの作成が完了し、AI アシスタントがクエリできます           |
| 失敗    | 作成過程でエラーが発生しました。エラーアイコンにマウスを合わせると原因を確認できます |

### ファイル形式に関する注意事項 <a href="#file-format-notes" id="file-format-notes"></a>

* [x] 最初の行（Row）は**列名**でなければなりません
* [x] 各列の**データ型**は一貫している必要があります（例：価格の列はすべて数値）
* [x] **セルの結合**は避けてください
* [x] **重複する列名**は避けてください
* [x] Excel ファイルでは、各ワークシート（Sheet）に含められるテーブルは**1 つのみ**です
* [x] 列名の後ろにデータ形式を記載することをおすすめします。例：`価格(int)`、`日付(datetime)`

{% hint style="warning" %}
データテーブルの作成に失敗した場合、よくある原因としては、ファイル形式が正しくないか破損している、列名に特殊文字が含まれている、列名が重複している、同一列内でデータ型が一致していない、などが挙げられます。
{% endhint %}

## 列の説明を編集する <a href="#edit-column-description" id="edit-column-description"></a>

列の説明は、Text to SQL のクエリ精度を高めるための**重要な設定**です。AI アシスタントは列の説明を参照してデータの意味を理解し、より正確な SQL クエリを生成します。

たとえば、データテーブルに `status` という列がある場合、AI アシスタントはそれが何を表すのか分からないかもしれません。しかし「注文ステータス。取り得る値：pending（処理待ち）、completed（完了）、cancelled（キャンセル済み）」という説明を加えれば、AI アシスタントはこの列の意味を正しく理解できます。

### 編集方法 <a href="#how-to-edit" id="how-to-edit"></a>

**MaiAgent データベース**：「<mark style="color:blue;">テーブル管理</mark>」タブでデータテーブルの「<mark style="color:blue;">編集</mark>」をクリックすると、テーブルの説明と列の説明を編集できます。ウィンドウには入力の進捗が表示されます（例：「10 個中 3 個の列に説明が設定済み」）。

**外部データベース**：「<mark style="color:blue;">基本情報</mark>」タブ下部のテーブル一覧でテーブルをクリックして展開し、列の説明欄に直接説明を入力します。

### 記述のヒント <a href="#writing-suggestions" id="writing-suggestions"></a>

{% hint style="info" %}
適切な列の説明は、AI クエリの精度を大幅に向上させます：
{% endhint %}

| 列名         | あまり良くない説明 | より良い説明                                                             |
| ---------- | --------- | ------------------------------------------------------------------ |
| `amt`      | 金額        | 注文の合計金額（日本円）。税金と送料を含む                                              |
| `cust_lvl` | ランク       | 顧客ランク。A ランクは年間消費額が 100 万を超える VIP 顧客、B ランクは年間消費額 10〜100 万、C ランクはその他 |
| `reg`      | 地域        | 顧客が所在する地理的地域。取り得る値：北部、中部、南部、東部、離島                                  |

## 既存のデータベースを管理する <a href="#manage-existing-databases" id="manage-existing-databases"></a>

### データベースを編集する <a href="#edit-database" id="edit-database"></a>

データベース一覧で操作メニューの「<mark style="color:blue;">編集</mark>」をクリックすると、設定ページに入れます。

<figure><img src="/files/m4DY5rzourrvvPz25HMn" alt="データベース設定ページ"><figcaption><p>データベース設定ページ：基本情報タブ</p></figcaption></figure>

設定ページには以下のタブが含まれます：

| タブ             | 説明                          | 対応する種類      |
| -------------- | --------------------------- | ----------- |
| 基本情報           | 名前、説明、有効/無効ステータス、接続文字列を編集   | すべて         |
| テーブル管理         | ファイルのアップロード、データテーブルと列の説明の管理 | MaiAgent のみ |
| AI アシスタントの関連付け | このデータベースを使用できる AI アシスタントを指定 | すべて         |
| ロール権限          | グループのアクセス権限を設定              | すべて         |

### 有効化 / 無効化 <a href="#enable-disable" id="enable-disable"></a>

データベース一覧で、「有効」スイッチからステータスをすばやく切り替えられます。無効化すると AI アシスタントは一時的にこのデータベースをクエリできなくなりますが、設定とデータは保持されます。

### データベースを削除する <a href="#delete-database" id="delete-database"></a>

{% hint style="danger" %}
データベースの削除は元に戻せない操作です。

* **MaiAgent データベース**：削除すると、ファイルのアップロードによって作成されたすべてのデータテーブルも一緒に削除されます
* **外部データベース**：MaiAgent 内の接続設定が削除されるだけで、元のデータベース内のデータには影響しません
  {% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.maiagent.ai/maiagent-user-guide/maiagent-user-guide-ja/database/create-database.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.