• 日本語

      • KingbaseES

      Data source: KingbaseESProfessional Edition+

      概要

      KingbaseES は NocoBase のメインデータベースとして使用でき、NocoBase のシステムテーブルデータおよびメインデータソースの業務データを保存します。メインデータベースは NocoBase のデプロイ時に設定し、アプリケーションの実行後に削除することはできません。

      既存の KingbaseES データベースを外部データベースとして接続する場合は、外部 KingbaseESを参照してください。

      設定項目説明
      対応バージョン>= V9。
      商用版プロフェッショナル版、エンタープライズ版に対応。
      データベースの種類PostgreSQL 互換モード。
      注意

      現在、PostgreSQL 互換モードで実行される KingbaseES データベースのみ対応しています。

      インストール

      メインデータベースとして使用する

      インストール手順については、NocoBase アプリケーションのインストールを参照してください。主な違いはデータベース環境変数です。

      環境変数

      .env ファイルを変更し、以下のデータベース関連環境変数を追加または変更します。

      # 根据实际情况调整 DB 相关参数
DB_DIALECT=kingbase
DB_HOST=localhost
DB_PORT=54321
DB_DATABASE=kingbase
DB_USER=nocobase
DB_PASSWORD=nocobase

      Docker でインストールする

      networks:
  nocobase:
    driver: bridge

services:
  app:
    image: registry.cn-shanghai.aliyuncs.com/nocobase/nocobase:latest
    restart: always
    networks:
      - nocobase
    depends_on:
      - kingbase
    environment:
      # 用于生成用户 token 等内容的应用密钥。
      # 修改 APP_KEY 会导致旧 token 失效，请使用随机字符串并妥善保存。
      - APP_KEY=your-secret-key
      # 数据库类型
      - DB_DIALECT=kingbase
      # 数据库地址，如果使用已有数据库服务，可以替换为对应 IP。
      - DB_HOST=kingbase
      - DB_PORT=54321
      # 数据库名称
      - DB_DATABASE=kingbase
      # 数据库用户
      - DB_USER=nocobase
      # 数据库密码
      - DB_PASSWORD=nocobase
      # 时区
      - TZ=UTC
    volumes:
      - ./storage:/app/nocobase/storage
    ports:
      - "11000:80"

  # Kingbase 测试服务，仅用于本地体验。
  kingbase:
    image: registry.cn-shanghai.aliyuncs.com/nocobase/kingbase:v009r001c001b0030_single_x86
    platform: linux/amd64
    restart: always
    privileged: true
    networks:
      - nocobase
    volumes:
      - ./storage/db/kingbase:/home/kingbase/userdata
    environment:
      ENABLE_CI: no # Must be set to no
      DB_USER: nocobase
      DB_PASSWORD: nocobase
      DB_MODE: pg  # 仅支持 pg 模式
      NEED_START: yes
    command: ["/usr/sbin/init"]

      create-nocobase-app でインストールする

      yarn create nocobase-app my-nocobase-app -d kingbase \
   -e DB_HOST=localhost \
   -e DB_PORT=54321 \
   -e DB_DATABASE=kingbase \
   -e DB_USER=nocobase \
   -e DB_PASSWORD=nocobase \
   -e TZ=Asia/Shanghai

      外部データベースとして使用する

      KingbaseES を外部データベースとして接続する場合は、設定画面、接続パラメーター、同期ルールについて外部 KingbaseESを参照してください。

      使用方法

      KingbaseES のメインデータソースは PostgreSQL モードと互換性があるため、日常的な管理方法についてはメインデータソース PostgreSQLを参照してください。

      1. NocoBase のデプロイ時に、データベース接続設定で KingbaseES に対応する接続パラメーターを選択または入力します。
      2. NocoBase の起動後、「データソース管理」で「Main」データソースに移動すると、メインデータベース内のデータテーブルとフィールドを管理できます。
      3. データベースにすでに存在するテーブルを接続する場合は、メインデータベースの管理ページで「データベースから同期」を使用できます。
      4. データテーブルのフィールドを設定する際は、データテーブルおよびフィールドディレクトリを参照して、フィールドタイプとフィールドコンポーネントを選択できます。

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

      メインデータベースで NocoBase のページからフィールドを作成すると、NocoBase はフィールド設定に基づいて、対応する KingbaseES フィールドを作成します。「データベースから同期」を使用して既存のテーブルを接続する場合、NocoBase は PostgreSQL 互換ロジックに従って KingbaseES のフィールドタイプを識別し、適切な Field type と Field interface に自動的にマッピングします。フィールド設定で画面上の表示方法を調整できます。

      一般的なマッピングは以下のとおりです。

      KingbaseES フィールドタイプNocoBase Field type選択可能な Field interface
      BOOLEANbooleanCheckbox、Switch。
      SMALLINT、INTEGERinteger、sortInteger、Sort、Select、Radio group。
      BIGINTbigInt、snowflakeId、unixTimestamp、sortInteger、Sort、Unix timestamp、Created at、Updated at。
      REAL、DOUBLE PRECISIONfloatNumber、Percent。
      DECIMAL、NUMERICdecimalNumber、Percent、Currency。
      VARCHAR、CHARstring、uuid、nanoid、encryption、datetimeNoTzInput、Email、Phone、Password、Color、Icon、Select、Radio group、UUID、Nano ID。
      TEXTtextTextarea、Markdown、Vditor、Rich text、URL。
      UUIDuuidUUID。
      JSON、JSONBjson、arrayJSON。
      TIMESTAMP WITHOUT TIME ZONEdatetimeNoTzDate、Time、Created at、Updated at。
      TIMESTAMP WITH TIME ZONEdatetimeTz、dateDate、Time、Created at、Updated at。
      DATEdateOnlyDate。
      TIME WITHOUT TIME ZONEtimeTime。
      POINT、PATH、POLYGON、CIRCLEjsonJSON。
      ARRAYarrayMultiple select、Checkbox group、JSON。
      注意

      対応していない KingbaseES フィールドタイプは、フィールド設定内に個別に表示されます。これらのフィールドを NocoBase で通常のフィールドとして使用するには、対応するアダプターを開発する必要があります。

      その他の共通設定については、メインデータソースの概要を参照してください。