#外部データベース

#はじめに

既存の外部データベースをデータソースとして利用できます。現在サポートされている外部データベースは、MySQL、MariaDB、PostgreSQL、MSSQL、Oracleです。

#利用方法

#外部データベースの追加

プラグインを有効化すると、データソース管理の「Add new」ドロップダウンメニューから選択して追加できるようになります。

接続したいデータベース情報を入力してください。

#コレクションの同期

外部データベースとの接続が確立されると、データソース内のすべてのコレクションが直接読み込まれます。外部データベースでは、コレクションの直接追加やテーブル構造の変更はサポートされていません。変更が必要な場合は、データベースクライアントを介して操作し、その後インターフェース上の「更新」ボタンをクリックして同期してください。

#フィールドの設定

外部データベースは、既存のコレクションのフィールドを自動的に読み込み、表示します。フィールドのタイトル、データタイプ（Field type）、UIタイプ（Field interface）を素早く確認・設定できます。また、「編集」ボタンをクリックして、さらに多くの設定を変更することも可能です。

外部データベースではテーブル構造の変更がサポートされていないため、新しいフィールドを追加する際に選択できるのは関連フィールドのみです。関連フィールドは実際のフィールドではなく、コレクション間の接続を確立するために使用されます。

詳細については、コレクションフィールド/概要の章をご覧ください。

#フィールドタイプのマッピング

NocoBaseは、外部データベースのフィールドタイプを、対応するデータタイプ（Field type）とUIタイプ（Field Interface）に自動的にマッピングします。

• データタイプ（Field type）：フィールドが格納できるデータの種類、形式、構造を定義します。
• UIタイプ（Field interface）：ユーザーインターフェースでフィールド値を表示および入力するために使用されるコントロールのタイプを指します。

PostgreSQL	MySQL/MariaDB	NocoBase Data Type	NocoBase Interface Type
BOOLEAN	BOOLEAN TINYINT(1)	boolean	checkbox switch
SMALLINT INTEGER SERIAL SMALLSERIAL	TINYINT SMALLINT MEDIUMINT INTEGER	integer boolean sort	integer sort checkbox switch select radioGroup
BIGINT BIGSERIAL	BIGINT	bigInt sort	integer sort checkbox switch select radioGroup unixTimestamp createdAt updatedAt
REAL	FLOAT	float	number percent
DOUBLE PRECISION	DOUBLE PRECISION	double	number percent
DECIMAL NUMERIC	DECIMAL	decimal	number percent currency
VARCHAR CHAR	VARCHAR CHAR	string password uuid nanoid	input email phone password color icon select radioGroup uuid nanoid
TEXT	TEXT TINYTEXT MEDIUMTEXT LONGTEXT	text json	textarea markdown vditor richText url json
UUID	-	uuid	uuid
JSON JSONB	JSON	json	json
TIMESTAMP	DATETIME TIMESTAMP	date	date time createdAt updatedAt
DATE	DATE	dateOnly	datetime
TIME	TIME	time	time
-	YEAR		datetime
CIRCEL		circle	json circle
PATH GEOMETRY(LINESTRING)	LINESTRING	lineString	Json lineString
POINT GEOMETRY(POINT)	POINT	point	json point
POLYGON GEOMETRY(POLYGON)	POLYGON	polygon	json polygon
GEOMETRY	GEOMETRY	-	-
BLOB	BLOB	blob	-
ENUM	ENUM	enum	select radioGroup
ARRAY	-	array	multipleSelect checkboxGroup
BIT	BIT	-	-
SET	SET	set	multipleSelect checkboxGroup
RANGE	-	-	-

#未サポートのフィールドタイプ

未サポートのフィールドタイプは個別に表示されます。これらのフィールドは、開発による対応が完了した後に利用可能になります。

#フィルターターゲットキー

ブロックとして表示されるコレクションには、フィルターターゲットキー（Filter target key）が設定されている必要があります。フィルターターゲットキーとは、特定のフィールドに基づいてデータをフィルタリングするためのもので、そのフィールド値は一意である必要があります。フィルターターゲットキーは、デフォルトでコレクションの主キーフィールドとなります。ビュー、主キーを持たないコレクション、または複合主キーを持つコレクションの場合は、カスタムのフィルターターゲットキーを定義する必要があります。

フィルターターゲットキーが設定されているコレクションのみ、ページに追加できます。