• English

      • MySQL

      Data source managerCommunity Edition+

      Introduction

      MySQL 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>= 8.0.17.
      Commercial editionsCommunity, Standard, Professional, and Enterprise.
      Database typeMySQL.

      MySQL is suitable as the main database for regular business systems.

      Plugin installation

      MySQL is built in and does not require a separate plugin.

      Usage

      1. Select or enter MySQL 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 MySQL column. When you synchronize an existing table, NocoBase maps the MySQL column type to a suitable Field type and Field interface. You can adjust the display interface in field configuration.

      MySQL 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.
      TINYTEXT, TEXT, MEDIUMTEXT, LONGTEXTtextTextarea, Markdown, Vditor, Rich text, URL.
      DATEdateOnlyDate.
      TIMEtimeTime.
      DATETIMEdatetimeNoTz, datetimeTz, dateDate, Time, Created at, Updated at.
      TIMESTAMPdatetimeTz, dateDate, Time, Created at, Updated at.
      YEARstring, integerInput, Integer, Date.
      JSONjson, arrayJSON.
      Note

      Unsupported MySQL 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.