• English

      • OceanBase

      Introduction

      OceanBase can be used as the NocoBase main database. It stores NocoBase system-table data and business data in the main data source. Configure it when deploying NocoBase; it cannot be deleted after the application is running.

      SettingDescription
      Supported version>= 4.3.
      Commercial editionsEnterprise.
      Database typeMySQL compatibility mode.
      Note

      OceanBase is supported as the main database only in MySQL compatibility mode.

      Plugin installation

      OceanBase is provided by @nocobase/plugin-data-source-oceanbase and requires a commercial license.

      Usage

      1. Select or enter OceanBase connection settings when deploying NocoBase.
      2. After NocoBase starts, open Data source management, select Main, and manage collections and fields in the main database.
      3. To connect tables that already exist in the database, use Sync from database on the main-database management page.
      4. When configuring fields, use Collections and Collection fields to choose Field types and Field interfaces.

      Field type mapping

      When you create a field in NocoBase, NocoBase creates the corresponding OceanBase column. When you synchronize an existing table, NocoBase uses MySQL-compatible mapping to select a suitable Field type and Field interface. You can adjust the display interface in field configuration.

      OceanBase typeNocoBase Field typeAvailable Field interfaces
      TINYINT, SMALLINT, MEDIUMINTinteger, boolean, sortInteger, Sort, Checkbox, Switch, Select, Radio group.
      INT, INTEGERinteger, unixTimestamp, sortInteger, Sort, Unix timestamp, Select, Radio group.
      BIGINTbigInt, snowflakeId, unixTimestamp, sortInteger, Sort, Unix timestamp, Created at, Updated at.
      FLOAT, DOUBLEfloatNumber, Percent.
      DECIMALdecimalNumber, Percent, Currency.
      CHAR, VARCHARstring, uuid, nanoid, encryptionInput, Email, Phone, Password, Color, Icon, Select, Radio group, UUID, Nano ID.
      TEXTtextTextarea, Markdown, Vditor, Rich text, URL.
      DATEdateOnlyDate.
      TIMEtimeTime.
      DATETIMEdatetimeNoTz, datetimeTz, dateDate, Time, Created at, Updated at.
      TIMESTAMPdatetimeTz, dateDate, Time, Created at, Updated at.
      JSONjson, arrayJSON.
      Note

      Unsupported OceanBase types are shown separately in field configuration. They require development support before they can be used as normal NocoBase fields.

      For common configuration, see Main database.